Skip to content

Commit b461cb2

Browse files
feat(api): api update
1 parent 885f15e commit b461cb2

File tree

7 files changed

+2136
-58
lines changed

7 files changed

+2136
-58
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 118
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-ee9adb19e1aafbee7edb5b95348a1629c1de6ca9625f3b49f6064ae10d863bfc.yml
3-
openapi_spec_hash: 42006f5fb95364855be09dc4432073c0
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-d0eaf664d43e26c42ebf8740ff1b6ee34c4d424c7048a7f04df994cb65627f89.yml
3+
openapi_spec_hash: 4d7622040380d5c7bd2e5a5ec9b86783
44
config_hash: 1f73a949b649ecfe6ec68ba1bb459dc2

src/resources/beta/beta.ts

Lines changed: 302 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,7 @@ export namespace BetaCreatePlanVersionParams {
184184
| Shared.NewPlanUnitPrice
185185
| Shared.NewPlanTieredPrice
186186
| Shared.NewPlanBulkPrice
187+
| AddPrice.NewPlanBulkWithFiltersPrice
187188
| Shared.NewPlanPackagePrice
188189
| Shared.NewPlanMatrixPrice
189190
| Shared.NewPlanThresholdTotalAmountPrice
@@ -214,6 +215,156 @@ export namespace BetaCreatePlanVersionParams {
214215
}
215216

216217
export namespace AddPrice {
218+
export interface NewPlanBulkWithFiltersPrice {
219+
/**
220+
* Configuration for bulk_with_filters pricing
221+
*/
222+
bulk_with_filters_config: NewPlanBulkWithFiltersPrice.BulkWithFiltersConfig;
223+
224+
/**
225+
* The cadence to bill for this price on.
226+
*/
227+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
228+
229+
/**
230+
* The id of the item the price will be associated with.
231+
*/
232+
item_id: string;
233+
234+
/**
235+
* The pricing model type
236+
*/
237+
model_type: 'bulk_with_filters';
238+
239+
/**
240+
* The name of the price.
241+
*/
242+
name: string;
243+
244+
/**
245+
* The id of the billable metric for the price. Only needed if the price is
246+
* usage-based.
247+
*/
248+
billable_metric_id?: string | null;
249+
250+
/**
251+
* If the Price represents a fixed cost, the price will be billed in-advance if
252+
* this is true, and in-arrears if this is false.
253+
*/
254+
billed_in_advance?: boolean | null;
255+
256+
/**
257+
* For custom cadence: specifies the duration of the billing period in days or
258+
* months.
259+
*/
260+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
261+
262+
/**
263+
* The per unit conversion rate of the price currency to the invoicing currency.
264+
*/
265+
conversion_rate?: number | null;
266+
267+
/**
268+
* The configuration for the rate of the price currency to the invoicing currency.
269+
*/
270+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
271+
272+
/**
273+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
274+
* price is billed.
275+
*/
276+
currency?: string | null;
277+
278+
/**
279+
* For dimensional price: specifies a price group and dimension values
280+
*/
281+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
282+
283+
/**
284+
* An alias for the price.
285+
*/
286+
external_price_id?: string | null;
287+
288+
/**
289+
* If the Price represents a fixed cost, this represents the quantity of units
290+
* applied.
291+
*/
292+
fixed_price_quantity?: number | null;
293+
294+
/**
295+
* The property used to group this price on an invoice
296+
*/
297+
invoice_grouping_key?: string | null;
298+
299+
/**
300+
* Within each billing cycle, specifies the cadence at which invoices are produced.
301+
* If unspecified, a single invoice is produced per billing cycle.
302+
*/
303+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
304+
305+
/**
306+
* User-specified key/value pairs for the resource. Individual keys can be removed
307+
* by setting the value to `null`, and the entire metadata mapping can be cleared
308+
* by setting `metadata` to `null`.
309+
*/
310+
metadata?: { [key: string]: string | null } | null;
311+
312+
/**
313+
* A transient ID that can be used to reference this price when adding adjustments
314+
* in the same API call.
315+
*/
316+
reference_id?: string | null;
317+
}
318+
319+
export namespace NewPlanBulkWithFiltersPrice {
320+
/**
321+
* Configuration for bulk_with_filters pricing
322+
*/
323+
export interface BulkWithFiltersConfig {
324+
/**
325+
* Property filters to apply (all must match)
326+
*/
327+
filters: Array<BulkWithFiltersConfig.Filter>;
328+
329+
/**
330+
* Bulk tiers for rating based on total usage volume
331+
*/
332+
tiers: Array<BulkWithFiltersConfig.Tier>;
333+
}
334+
335+
export namespace BulkWithFiltersConfig {
336+
/**
337+
* Configuration for a single property filter
338+
*/
339+
export interface Filter {
340+
/**
341+
* Event property key to filter on
342+
*/
343+
property_key: string;
344+
345+
/**
346+
* Event property value to match
347+
*/
348+
property_value: string;
349+
}
350+
351+
/**
352+
* Configuration for a single bulk pricing tier
353+
*/
354+
export interface Tier {
355+
/**
356+
* Amount per unit
357+
*/
358+
unit_amount: string;
359+
360+
/**
361+
* The lower bound for this tier
362+
*/
363+
tier_lower_bound?: string | null;
364+
}
365+
}
366+
}
367+
217368
export interface NewPlanTieredWithProrationPrice {
218369
/**
219370
* The cadence to bill for this price on.
@@ -775,6 +926,7 @@ export namespace BetaCreatePlanVersionParams {
775926
| Shared.NewPlanUnitPrice
776927
| Shared.NewPlanTieredPrice
777928
| Shared.NewPlanBulkPrice
929+
| ReplacePrice.NewPlanBulkWithFiltersPrice
778930
| Shared.NewPlanPackagePrice
779931
| Shared.NewPlanMatrixPrice
780932
| Shared.NewPlanThresholdTotalAmountPrice
@@ -805,6 +957,156 @@ export namespace BetaCreatePlanVersionParams {
805957
}
806958

807959
export namespace ReplacePrice {
960+
export interface NewPlanBulkWithFiltersPrice {
961+
/**
962+
* Configuration for bulk_with_filters pricing
963+
*/
964+
bulk_with_filters_config: NewPlanBulkWithFiltersPrice.BulkWithFiltersConfig;
965+
966+
/**
967+
* The cadence to bill for this price on.
968+
*/
969+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
970+
971+
/**
972+
* The id of the item the price will be associated with.
973+
*/
974+
item_id: string;
975+
976+
/**
977+
* The pricing model type
978+
*/
979+
model_type: 'bulk_with_filters';
980+
981+
/**
982+
* The name of the price.
983+
*/
984+
name: string;
985+
986+
/**
987+
* The id of the billable metric for the price. Only needed if the price is
988+
* usage-based.
989+
*/
990+
billable_metric_id?: string | null;
991+
992+
/**
993+
* If the Price represents a fixed cost, the price will be billed in-advance if
994+
* this is true, and in-arrears if this is false.
995+
*/
996+
billed_in_advance?: boolean | null;
997+
998+
/**
999+
* For custom cadence: specifies the duration of the billing period in days or
1000+
* months.
1001+
*/
1002+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1003+
1004+
/**
1005+
* The per unit conversion rate of the price currency to the invoicing currency.
1006+
*/
1007+
conversion_rate?: number | null;
1008+
1009+
/**
1010+
* The configuration for the rate of the price currency to the invoicing currency.
1011+
*/
1012+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
1013+
1014+
/**
1015+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
1016+
* price is billed.
1017+
*/
1018+
currency?: string | null;
1019+
1020+
/**
1021+
* For dimensional price: specifies a price group and dimension values
1022+
*/
1023+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
1024+
1025+
/**
1026+
* An alias for the price.
1027+
*/
1028+
external_price_id?: string | null;
1029+
1030+
/**
1031+
* If the Price represents a fixed cost, this represents the quantity of units
1032+
* applied.
1033+
*/
1034+
fixed_price_quantity?: number | null;
1035+
1036+
/**
1037+
* The property used to group this price on an invoice
1038+
*/
1039+
invoice_grouping_key?: string | null;
1040+
1041+
/**
1042+
* Within each billing cycle, specifies the cadence at which invoices are produced.
1043+
* If unspecified, a single invoice is produced per billing cycle.
1044+
*/
1045+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1046+
1047+
/**
1048+
* User-specified key/value pairs for the resource. Individual keys can be removed
1049+
* by setting the value to `null`, and the entire metadata mapping can be cleared
1050+
* by setting `metadata` to `null`.
1051+
*/
1052+
metadata?: { [key: string]: string | null } | null;
1053+
1054+
/**
1055+
* A transient ID that can be used to reference this price when adding adjustments
1056+
* in the same API call.
1057+
*/
1058+
reference_id?: string | null;
1059+
}
1060+
1061+
export namespace NewPlanBulkWithFiltersPrice {
1062+
/**
1063+
* Configuration for bulk_with_filters pricing
1064+
*/
1065+
export interface BulkWithFiltersConfig {
1066+
/**
1067+
* Property filters to apply (all must match)
1068+
*/
1069+
filters: Array<BulkWithFiltersConfig.Filter>;
1070+
1071+
/**
1072+
* Bulk tiers for rating based on total usage volume
1073+
*/
1074+
tiers: Array<BulkWithFiltersConfig.Tier>;
1075+
}
1076+
1077+
export namespace BulkWithFiltersConfig {
1078+
/**
1079+
* Configuration for a single property filter
1080+
*/
1081+
export interface Filter {
1082+
/**
1083+
* Event property key to filter on
1084+
*/
1085+
property_key: string;
1086+
1087+
/**
1088+
* Event property value to match
1089+
*/
1090+
property_value: string;
1091+
}
1092+
1093+
/**
1094+
* Configuration for a single bulk pricing tier
1095+
*/
1096+
export interface Tier {
1097+
/**
1098+
* Amount per unit
1099+
*/
1100+
unit_amount: string;
1101+
1102+
/**
1103+
* The lower bound for this tier
1104+
*/
1105+
tier_lower_bound?: string | null;
1106+
}
1107+
}
1108+
}
1109+
8081110
export interface NewPlanTieredWithProrationPrice {
8091111
/**
8101112
* The cadence to bill for this price on.

0 commit comments

Comments
 (0)