Skip to content

Commit d431aae

Browse files
feat(api): api update
1 parent 5f2cdc6 commit d431aae

File tree

7 files changed

+1827
-40
lines changed

7 files changed

+1827
-40
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-9e751a2aefff382af949380b5979a80cb02743eca1583cf5146325fb400ba87f.yml
3-
openapi_spec_hash: 219a1008f47d3293f64f1baebe2d6eb5
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-947253d9be505473c1c2cb0193d2602fa6b017e221f482be3f4f374c6156b350.yml
3+
openapi_spec_hash: 1b40d1a85b4b846a1c14634fbbc65da3
44
config_hash: e6db17547fe854b1c240407cf4c6dc9e

src/resources/beta/beta.ts

Lines changed: 258 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@ export namespace BetaCreatePlanVersionParams {
202202
| Shared.NewPlanScalableMatrixWithUnitPricingPrice
203203
| Shared.NewPlanScalableMatrixWithTieredPricingPrice
204204
| Shared.NewPlanCumulativeGroupedBulkPrice
205+
| AddPrice.NewPlanCumulativeGroupedAllocationPrice
205206
| Shared.NewPlanMinimumCompositePrice
206207
| AddPrice.NewPlanPercentCompositePrice
207208
| AddPrice.NewPlanEventOutputPrice
@@ -618,6 +619,134 @@ export namespace BetaCreatePlanVersionParams {
618619
}
619620
}
620621

622+
export interface NewPlanCumulativeGroupedAllocationPrice {
623+
/**
624+
* The cadence to bill for this price on.
625+
*/
626+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
627+
628+
/**
629+
* Configuration for cumulative_grouped_allocation pricing
630+
*/
631+
cumulative_grouped_allocation_config: NewPlanCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
632+
633+
/**
634+
* The id of the item the price will be associated with.
635+
*/
636+
item_id: string;
637+
638+
/**
639+
* The pricing model type
640+
*/
641+
model_type: 'cumulative_grouped_allocation';
642+
643+
/**
644+
* The name of the price.
645+
*/
646+
name: string;
647+
648+
/**
649+
* The id of the billable metric for the price. Only needed if the price is
650+
* usage-based.
651+
*/
652+
billable_metric_id?: string | null;
653+
654+
/**
655+
* If the Price represents a fixed cost, the price will be billed in-advance if
656+
* this is true, and in-arrears if this is false.
657+
*/
658+
billed_in_advance?: boolean | null;
659+
660+
/**
661+
* For custom cadence: specifies the duration of the billing period in days or
662+
* months.
663+
*/
664+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
665+
666+
/**
667+
* The per unit conversion rate of the price currency to the invoicing currency.
668+
*/
669+
conversion_rate?: number | null;
670+
671+
/**
672+
* The configuration for the rate of the price currency to the invoicing currency.
673+
*/
674+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
675+
676+
/**
677+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
678+
* price is billed.
679+
*/
680+
currency?: string | null;
681+
682+
/**
683+
* For dimensional price: specifies a price group and dimension values
684+
*/
685+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
686+
687+
/**
688+
* An alias for the price.
689+
*/
690+
external_price_id?: string | null;
691+
692+
/**
693+
* If the Price represents a fixed cost, this represents the quantity of units
694+
* applied.
695+
*/
696+
fixed_price_quantity?: number | null;
697+
698+
/**
699+
* The property used to group this price on an invoice
700+
*/
701+
invoice_grouping_key?: string | null;
702+
703+
/**
704+
* Within each billing cycle, specifies the cadence at which invoices are produced.
705+
* If unspecified, a single invoice is produced per billing cycle.
706+
*/
707+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
708+
709+
/**
710+
* User-specified key/value pairs for the resource. Individual keys can be removed
711+
* by setting the value to `null`, and the entire metadata mapping can be cleared
712+
* by setting `metadata` to `null`.
713+
*/
714+
metadata?: { [key: string]: string | null } | null;
715+
716+
/**
717+
* A transient ID that can be used to reference this price when adding adjustments
718+
* in the same API call.
719+
*/
720+
reference_id?: string | null;
721+
}
722+
723+
export namespace NewPlanCumulativeGroupedAllocationPrice {
724+
/**
725+
* Configuration for cumulative_grouped_allocation pricing
726+
*/
727+
export interface CumulativeGroupedAllocationConfig {
728+
/**
729+
* The overall allocation across all groups
730+
*/
731+
cumulative_allocation: string;
732+
733+
/**
734+
* The allocation per individual group
735+
*/
736+
group_allocation: string;
737+
738+
/**
739+
* The event property used to group usage before applying allocations
740+
*/
741+
grouping_key: string;
742+
743+
/**
744+
* The amount to charge for each unit outside of the allocation
745+
*/
746+
unit_amount: string;
747+
}
748+
}
749+
621750
export interface NewPlanPercentCompositePrice {
622751
/**
623752
* The cadence to bill for this price on.
@@ -951,6 +1080,7 @@ export namespace BetaCreatePlanVersionParams {
9511080
| Shared.NewPlanScalableMatrixWithUnitPricingPrice
9521081
| Shared.NewPlanScalableMatrixWithTieredPricingPrice
9531082
| Shared.NewPlanCumulativeGroupedBulkPrice
1083+
| ReplacePrice.NewPlanCumulativeGroupedAllocationPrice
9541084
| Shared.NewPlanMinimumCompositePrice
9551085
| ReplacePrice.NewPlanPercentCompositePrice
9561086
| ReplacePrice.NewPlanEventOutputPrice
@@ -1367,6 +1497,134 @@ export namespace BetaCreatePlanVersionParams {
13671497
}
13681498
}
13691499

1500+
export interface NewPlanCumulativeGroupedAllocationPrice {
1501+
/**
1502+
* The cadence to bill for this price on.
1503+
*/
1504+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1505+
1506+
/**
1507+
* Configuration for cumulative_grouped_allocation pricing
1508+
*/
1509+
cumulative_grouped_allocation_config: NewPlanCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
1510+
1511+
/**
1512+
* The id of the item the price will be associated with.
1513+
*/
1514+
item_id: string;
1515+
1516+
/**
1517+
* The pricing model type
1518+
*/
1519+
model_type: 'cumulative_grouped_allocation';
1520+
1521+
/**
1522+
* The name of the price.
1523+
*/
1524+
name: string;
1525+
1526+
/**
1527+
* The id of the billable metric for the price. Only needed if the price is
1528+
* usage-based.
1529+
*/
1530+
billable_metric_id?: string | null;
1531+
1532+
/**
1533+
* If the Price represents a fixed cost, the price will be billed in-advance if
1534+
* this is true, and in-arrears if this is false.
1535+
*/
1536+
billed_in_advance?: boolean | null;
1537+
1538+
/**
1539+
* For custom cadence: specifies the duration of the billing period in days or
1540+
* months.
1541+
*/
1542+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1543+
1544+
/**
1545+
* The per unit conversion rate of the price currency to the invoicing currency.
1546+
*/
1547+
conversion_rate?: number | null;
1548+
1549+
/**
1550+
* The configuration for the rate of the price currency to the invoicing currency.
1551+
*/
1552+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
1553+
1554+
/**
1555+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
1556+
* price is billed.
1557+
*/
1558+
currency?: string | null;
1559+
1560+
/**
1561+
* For dimensional price: specifies a price group and dimension values
1562+
*/
1563+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
1564+
1565+
/**
1566+
* An alias for the price.
1567+
*/
1568+
external_price_id?: string | null;
1569+
1570+
/**
1571+
* If the Price represents a fixed cost, this represents the quantity of units
1572+
* applied.
1573+
*/
1574+
fixed_price_quantity?: number | null;
1575+
1576+
/**
1577+
* The property used to group this price on an invoice
1578+
*/
1579+
invoice_grouping_key?: string | null;
1580+
1581+
/**
1582+
* Within each billing cycle, specifies the cadence at which invoices are produced.
1583+
* If unspecified, a single invoice is produced per billing cycle.
1584+
*/
1585+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1586+
1587+
/**
1588+
* User-specified key/value pairs for the resource. Individual keys can be removed
1589+
* by setting the value to `null`, and the entire metadata mapping can be cleared
1590+
* by setting `metadata` to `null`.
1591+
*/
1592+
metadata?: { [key: string]: string | null } | null;
1593+
1594+
/**
1595+
* A transient ID that can be used to reference this price when adding adjustments
1596+
* in the same API call.
1597+
*/
1598+
reference_id?: string | null;
1599+
}
1600+
1601+
export namespace NewPlanCumulativeGroupedAllocationPrice {
1602+
/**
1603+
* Configuration for cumulative_grouped_allocation pricing
1604+
*/
1605+
export interface CumulativeGroupedAllocationConfig {
1606+
/**
1607+
* The overall allocation across all groups
1608+
*/
1609+
cumulative_allocation: string;
1610+
1611+
/**
1612+
* The allocation per individual group
1613+
*/
1614+
group_allocation: string;
1615+
1616+
/**
1617+
* The event property used to group usage before applying allocations
1618+
*/
1619+
grouping_key: string;
1620+
1621+
/**
1622+
* The amount to charge for each unit outside of the allocation
1623+
*/
1624+
unit_amount: string;
1625+
}
1626+
}
1627+
13701628
export interface NewPlanPercentCompositePrice {
13711629
/**
13721630
* The cadence to bill for this price on.

0 commit comments

Comments
 (0)