Skip to content

Commit 415a105

Browse files
feat(api): api update (#513)
1 parent 472bf14 commit 415a105

9 files changed

+95
-95
lines changed

.stats.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 103
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-326205df28a52e9ad57c34d7ed1ec85fadd67f9a041df2882ebaa65f6de09930.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-8663e8fc543041d9694eddcd2f7e9784611369606700f99340e6dc80607b2dfa.yml

src/orb/resources/invoices.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ def issue(
392392
Args:
393393
synchronous: If true, the invoice will be issued synchronously. If false, the invoice will be
394394
issued asynchronously. The synchronous option is only available for invoices
395-
containin no usage fees. If the invoice is configured to sync to an external
395+
that have no usage fees. If the invoice is configured to sync to an external
396396
provider, a successful response from this endpoint guarantees the invoice is
397397
present in the provider.
398398
@@ -927,7 +927,7 @@ async def issue(
927927
Args:
928928
synchronous: If true, the invoice will be issued synchronously. If false, the invoice will be
929929
issued asynchronously. The synchronous option is only available for invoices
930-
containin no usage fees. If the invoice is configured to sync to an external
930+
that have no usage fees. If the invoice is configured to sync to an external
931931
provider, a successful response from this endpoint guarantees the invoice is
932932
present in the provider.
933933

src/orb/resources/prices/prices.py

+16-16
Original file line numberDiff line numberDiff line change
@@ -1128,21 +1128,21 @@ def create(
11281128
cadence: Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"],
11291129
currency: str,
11301130
item_id: str,
1131-
max_group_tiered_config: Dict[str, object],
1132-
model_type: Literal["max_group_tiered"],
1131+
max_group_tiered_package_config: Dict[str, object],
1132+
model_type: Literal["max_group_tiered_package"],
11331133
name: str,
11341134
billable_metric_id: Optional[str] | NotGiven = NOT_GIVEN,
11351135
billed_in_advance: Optional[bool] | NotGiven = NOT_GIVEN,
11361136
billing_cycle_configuration: Optional[
1137-
price_create_params.NewFloatingMaxGroupTieredPriceBillingCycleConfiguration
1137+
price_create_params.NewFloatingMaxGroupTieredPackagePriceBillingCycleConfiguration
11381138
]
11391139
| NotGiven = NOT_GIVEN,
11401140
conversion_rate: Optional[float] | NotGiven = NOT_GIVEN,
11411141
external_price_id: Optional[str] | NotGiven = NOT_GIVEN,
11421142
fixed_price_quantity: Optional[float] | NotGiven = NOT_GIVEN,
11431143
invoice_grouping_key: Optional[str] | NotGiven = NOT_GIVEN,
11441144
invoicing_cycle_configuration: Optional[
1145-
price_create_params.NewFloatingMaxGroupTieredPriceInvoicingCycleConfiguration
1145+
price_create_params.NewFloatingMaxGroupTieredPackagePriceInvoicingCycleConfiguration
11461146
]
11471147
| NotGiven = NOT_GIVEN,
11481148
metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
@@ -2317,7 +2317,7 @@ def create(
23172317
["cadence", "currency", "item_id", "model_type", "name", "threshold_total_amount_config"],
23182318
["cadence", "currency", "item_id", "model_type", "name", "tiered_package_config"],
23192319
["cadence", "currency", "grouped_tiered_config", "item_id", "model_type", "name"],
2320-
["cadence", "currency", "item_id", "max_group_tiered_config", "model_type", "name"],
2320+
["cadence", "currency", "item_id", "max_group_tiered_package_config", "model_type", "name"],
23212321
["cadence", "currency", "item_id", "model_type", "name", "tiered_with_minimum_config"],
23222322
["cadence", "currency", "item_id", "model_type", "name", "package_with_allocation_config"],
23232323
["cadence", "currency", "item_id", "model_type", "name", "tiered_package_with_minimum_config"],
@@ -2349,7 +2349,7 @@ def create(
23492349
| Literal["threshold_total_amount"]
23502350
| Literal["tiered_package"]
23512351
| Literal["grouped_tiered"]
2352-
| Literal["max_group_tiered"]
2352+
| Literal["max_group_tiered_package"]
23532353
| Literal["tiered_with_minimum"]
23542354
| Literal["package_with_allocation"]
23552355
| Literal["tiered_package_with_minimum"]
@@ -2387,7 +2387,7 @@ def create(
23872387
threshold_total_amount_config: Dict[str, object] | NotGiven = NOT_GIVEN,
23882388
tiered_package_config: Dict[str, object] | NotGiven = NOT_GIVEN,
23892389
grouped_tiered_config: Dict[str, object] | NotGiven = NOT_GIVEN,
2390-
max_group_tiered_config: Dict[str, object] | NotGiven = NOT_GIVEN,
2390+
max_group_tiered_package_config: Dict[str, object] | NotGiven = NOT_GIVEN,
23912391
tiered_with_minimum_config: Dict[str, object] | NotGiven = NOT_GIVEN,
23922392
package_with_allocation_config: Dict[str, object] | NotGiven = NOT_GIVEN,
23932393
tiered_package_with_minimum_config: Dict[str, object] | NotGiven = NOT_GIVEN,
@@ -2440,7 +2440,7 @@ def create(
24402440
"threshold_total_amount_config": threshold_total_amount_config,
24412441
"tiered_package_config": tiered_package_config,
24422442
"grouped_tiered_config": grouped_tiered_config,
2443-
"max_group_tiered_config": max_group_tiered_config,
2443+
"max_group_tiered_package_config": max_group_tiered_package_config,
24442444
"tiered_with_minimum_config": tiered_with_minimum_config,
24452445
"package_with_allocation_config": package_with_allocation_config,
24462446
"tiered_package_with_minimum_config": tiered_package_with_minimum_config,
@@ -3791,21 +3791,21 @@ async def create(
37913791
cadence: Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"],
37923792
currency: str,
37933793
item_id: str,
3794-
max_group_tiered_config: Dict[str, object],
3795-
model_type: Literal["max_group_tiered"],
3794+
max_group_tiered_package_config: Dict[str, object],
3795+
model_type: Literal["max_group_tiered_package"],
37963796
name: str,
37973797
billable_metric_id: Optional[str] | NotGiven = NOT_GIVEN,
37983798
billed_in_advance: Optional[bool] | NotGiven = NOT_GIVEN,
37993799
billing_cycle_configuration: Optional[
3800-
price_create_params.NewFloatingMaxGroupTieredPriceBillingCycleConfiguration
3800+
price_create_params.NewFloatingMaxGroupTieredPackagePriceBillingCycleConfiguration
38013801
]
38023802
| NotGiven = NOT_GIVEN,
38033803
conversion_rate: Optional[float] | NotGiven = NOT_GIVEN,
38043804
external_price_id: Optional[str] | NotGiven = NOT_GIVEN,
38053805
fixed_price_quantity: Optional[float] | NotGiven = NOT_GIVEN,
38063806
invoice_grouping_key: Optional[str] | NotGiven = NOT_GIVEN,
38073807
invoicing_cycle_configuration: Optional[
3808-
price_create_params.NewFloatingMaxGroupTieredPriceInvoicingCycleConfiguration
3808+
price_create_params.NewFloatingMaxGroupTieredPackagePriceInvoicingCycleConfiguration
38093809
]
38103810
| NotGiven = NOT_GIVEN,
38113811
metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
@@ -4980,7 +4980,7 @@ async def create(
49804980
["cadence", "currency", "item_id", "model_type", "name", "threshold_total_amount_config"],
49814981
["cadence", "currency", "item_id", "model_type", "name", "tiered_package_config"],
49824982
["cadence", "currency", "grouped_tiered_config", "item_id", "model_type", "name"],
4983-
["cadence", "currency", "item_id", "max_group_tiered_config", "model_type", "name"],
4983+
["cadence", "currency", "item_id", "max_group_tiered_package_config", "model_type", "name"],
49844984
["cadence", "currency", "item_id", "model_type", "name", "tiered_with_minimum_config"],
49854985
["cadence", "currency", "item_id", "model_type", "name", "package_with_allocation_config"],
49864986
["cadence", "currency", "item_id", "model_type", "name", "tiered_package_with_minimum_config"],
@@ -5012,7 +5012,7 @@ async def create(
50125012
| Literal["threshold_total_amount"]
50135013
| Literal["tiered_package"]
50145014
| Literal["grouped_tiered"]
5015-
| Literal["max_group_tiered"]
5015+
| Literal["max_group_tiered_package"]
50165016
| Literal["tiered_with_minimum"]
50175017
| Literal["package_with_allocation"]
50185018
| Literal["tiered_package_with_minimum"]
@@ -5050,7 +5050,7 @@ async def create(
50505050
threshold_total_amount_config: Dict[str, object] | NotGiven = NOT_GIVEN,
50515051
tiered_package_config: Dict[str, object] | NotGiven = NOT_GIVEN,
50525052
grouped_tiered_config: Dict[str, object] | NotGiven = NOT_GIVEN,
5053-
max_group_tiered_config: Dict[str, object] | NotGiven = NOT_GIVEN,
5053+
max_group_tiered_package_config: Dict[str, object] | NotGiven = NOT_GIVEN,
50545054
tiered_with_minimum_config: Dict[str, object] | NotGiven = NOT_GIVEN,
50555055
package_with_allocation_config: Dict[str, object] | NotGiven = NOT_GIVEN,
50565056
tiered_package_with_minimum_config: Dict[str, object] | NotGiven = NOT_GIVEN,
@@ -5103,7 +5103,7 @@ async def create(
51035103
"threshold_total_amount_config": threshold_total_amount_config,
51045104
"tiered_package_config": tiered_package_config,
51055105
"grouped_tiered_config": grouped_tiered_config,
5106-
"max_group_tiered_config": max_group_tiered_config,
5106+
"max_group_tiered_package_config": max_group_tiered_package_config,
51075107
"tiered_with_minimum_config": tiered_with_minimum_config,
51085108
"package_with_allocation_config": package_with_allocation_config,
51095109
"tiered_package_with_minimum_config": tiered_package_with_minimum_config,

src/orb/types/invoice_issue_params.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class InvoiceIssueParams(TypedDict, total=False):
1212
"""If true, the invoice will be issued synchronously.
1313
1414
If false, the invoice will be issued asynchronously. The synchronous option is
15-
only available for invoices containin no usage fees. If the invoice is
15+
only available for invoices that have no usage fees. If the invoice is
1616
configured to sync to an external provider, a successful response from this
1717
endpoint guarantees the invoice is present in the provider.
1818
"""

src/orb/types/plan_create_params.py

+11-11
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@
8484
"PriceNewPlanGroupedTieredPackagePrice",
8585
"PriceNewPlanGroupedTieredPackagePriceBillingCycleConfiguration",
8686
"PriceNewPlanGroupedTieredPackagePriceInvoicingCycleConfiguration",
87-
"PriceNewPlanMaxGroupTieredPrice",
88-
"PriceNewPlanMaxGroupTieredPriceBillingCycleConfiguration",
89-
"PriceNewPlanMaxGroupTieredPriceInvoicingCycleConfiguration",
87+
"PriceNewPlanMaxGroupTieredPackagePrice",
88+
"PriceNewPlanMaxGroupTieredPackagePriceBillingCycleConfiguration",
89+
"PriceNewPlanMaxGroupTieredPackagePriceInvoicingCycleConfiguration",
9090
]
9191

9292

@@ -1994,32 +1994,32 @@ class PriceNewPlanGroupedTieredPackagePrice(TypedDict, total=False):
19941994
"""
19951995

19961996

1997-
class PriceNewPlanMaxGroupTieredPriceBillingCycleConfiguration(TypedDict, total=False):
1997+
class PriceNewPlanMaxGroupTieredPackagePriceBillingCycleConfiguration(TypedDict, total=False):
19981998
duration: Required[int]
19991999
"""The duration of the billing period."""
20002000

20012001
duration_unit: Required[Literal["day", "month"]]
20022002
"""The unit of billing period duration."""
20032003

20042004

2005-
class PriceNewPlanMaxGroupTieredPriceInvoicingCycleConfiguration(TypedDict, total=False):
2005+
class PriceNewPlanMaxGroupTieredPackagePriceInvoicingCycleConfiguration(TypedDict, total=False):
20062006
duration: Required[int]
20072007
"""The duration of the billing period."""
20082008

20092009
duration_unit: Required[Literal["day", "month"]]
20102010
"""The unit of billing period duration."""
20112011

20122012

2013-
class PriceNewPlanMaxGroupTieredPrice(TypedDict, total=False):
2013+
class PriceNewPlanMaxGroupTieredPackagePrice(TypedDict, total=False):
20142014
cadence: Required[Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"]]
20152015
"""The cadence to bill for this price on."""
20162016

20172017
item_id: Required[str]
20182018
"""The id of the item the plan will be associated with."""
20192019

2020-
max_group_tiered_config: Required[Dict[str, object]]
2020+
max_group_tiered_package_config: Required[Dict[str, object]]
20212021

2022-
model_type: Required[Literal["max_group_tiered"]]
2022+
model_type: Required[Literal["max_group_tiered_package"]]
20232023

20242024
name: Required[str]
20252025
"""The name of the price."""
@@ -2036,7 +2036,7 @@ class PriceNewPlanMaxGroupTieredPrice(TypedDict, total=False):
20362036
this is true, and in-arrears if this is false.
20372037
"""
20382038

2039-
billing_cycle_configuration: Optional[PriceNewPlanMaxGroupTieredPriceBillingCycleConfiguration]
2039+
billing_cycle_configuration: Optional[PriceNewPlanMaxGroupTieredPackagePriceBillingCycleConfiguration]
20402040
"""
20412041
For custom cadence: specifies the duration of the billing period in days or
20422042
months.
@@ -2063,7 +2063,7 @@ class PriceNewPlanMaxGroupTieredPrice(TypedDict, total=False):
20632063
invoice_grouping_key: Optional[str]
20642064
"""The property used to group this price on an invoice"""
20652065

2066-
invoicing_cycle_configuration: Optional[PriceNewPlanMaxGroupTieredPriceInvoicingCycleConfiguration]
2066+
invoicing_cycle_configuration: Optional[PriceNewPlanMaxGroupTieredPackagePriceInvoicingCycleConfiguration]
20672067
"""Within each billing cycle, specifies the cadence at which invoices are produced.
20682068
20692069
If unspecified, a single invoice is produced per billing cycle.
@@ -2099,5 +2099,5 @@ class PriceNewPlanMaxGroupTieredPrice(TypedDict, total=False):
20992099
PriceNewPlanMatrixWithDisplayNamePrice,
21002100
PriceNewPlanBulkWithProrationPrice,
21012101
PriceNewPlanGroupedTieredPackagePrice,
2102-
PriceNewPlanMaxGroupTieredPrice,
2102+
PriceNewPlanMaxGroupTieredPackagePrice,
21032103
]

src/orb/types/price.py

+26-26
Original file line numberDiff line numberDiff line change
@@ -219,14 +219,14 @@
219219
"GroupedTieredPackagePriceItem",
220220
"GroupedTieredPackagePriceMaximum",
221221
"GroupedTieredPackagePriceMinimum",
222-
"MaxGroupTieredPrice",
223-
"MaxGroupTieredPriceBillableMetric",
224-
"MaxGroupTieredPriceBillingCycleConfiguration",
225-
"MaxGroupTieredPriceCreditAllocation",
226-
"MaxGroupTieredPriceInvoicingCycleConfiguration",
227-
"MaxGroupTieredPriceItem",
228-
"MaxGroupTieredPriceMaximum",
229-
"MaxGroupTieredPriceMinimum",
222+
"MaxGroupTieredPackagePrice",
223+
"MaxGroupTieredPackagePriceBillableMetric",
224+
"MaxGroupTieredPackagePriceBillingCycleConfiguration",
225+
"MaxGroupTieredPackagePriceCreditAllocation",
226+
"MaxGroupTieredPackagePriceInvoicingCycleConfiguration",
227+
"MaxGroupTieredPackagePriceItem",
228+
"MaxGroupTieredPackagePriceMaximum",
229+
"MaxGroupTieredPackagePriceMinimum",
230230
]
231231

232232

@@ -2870,35 +2870,35 @@ class GroupedTieredPackagePrice(BaseModel):
28702870
price_type: Literal["usage_price", "fixed_price"]
28712871

28722872

2873-
class MaxGroupTieredPriceBillableMetric(BaseModel):
2873+
class MaxGroupTieredPackagePriceBillableMetric(BaseModel):
28742874
id: str
28752875

28762876

2877-
class MaxGroupTieredPriceBillingCycleConfiguration(BaseModel):
2877+
class MaxGroupTieredPackagePriceBillingCycleConfiguration(BaseModel):
28782878
duration: int
28792879

28802880
duration_unit: Literal["day", "month"]
28812881

28822882

2883-
class MaxGroupTieredPriceCreditAllocation(BaseModel):
2883+
class MaxGroupTieredPackagePriceCreditAllocation(BaseModel):
28842884
allows_rollover: bool
28852885

28862886
currency: str
28872887

28882888

2889-
class MaxGroupTieredPriceInvoicingCycleConfiguration(BaseModel):
2889+
class MaxGroupTieredPackagePriceInvoicingCycleConfiguration(BaseModel):
28902890
duration: int
28912891

28922892
duration_unit: Literal["day", "month"]
28932893

28942894

2895-
class MaxGroupTieredPriceItem(BaseModel):
2895+
class MaxGroupTieredPackagePriceItem(BaseModel):
28962896
id: str
28972897

28982898
name: str
28992899

29002900

2901-
class MaxGroupTieredPriceMaximum(BaseModel):
2901+
class MaxGroupTieredPackagePriceMaximum(BaseModel):
29022902
applies_to_price_ids: List[str]
29032903
"""List of price_ids that this maximum amount applies to.
29042904
@@ -2909,7 +2909,7 @@ class MaxGroupTieredPriceMaximum(BaseModel):
29092909
"""Maximum amount applied"""
29102910

29112911

2912-
class MaxGroupTieredPriceMinimum(BaseModel):
2912+
class MaxGroupTieredPackagePriceMinimum(BaseModel):
29132913
applies_to_price_ids: List[str]
29142914
"""List of price_ids that this minimum amount applies to.
29152915
@@ -2920,20 +2920,20 @@ class MaxGroupTieredPriceMinimum(BaseModel):
29202920
"""Minimum amount applied"""
29212921

29222922

2923-
class MaxGroupTieredPrice(BaseModel):
2923+
class MaxGroupTieredPackagePrice(BaseModel):
29242924
id: str
29252925

2926-
billable_metric: Optional[MaxGroupTieredPriceBillableMetric] = None
2926+
billable_metric: Optional[MaxGroupTieredPackagePriceBillableMetric] = None
29272927

2928-
billing_cycle_configuration: MaxGroupTieredPriceBillingCycleConfiguration
2928+
billing_cycle_configuration: MaxGroupTieredPackagePriceBillingCycleConfiguration
29292929

29302930
cadence: Literal["one_time", "monthly", "quarterly", "semi_annual", "annual", "custom"]
29312931

29322932
conversion_rate: Optional[float] = None
29332933

29342934
created_at: datetime
29352935

2936-
credit_allocation: Optional[MaxGroupTieredPriceCreditAllocation] = None
2936+
credit_allocation: Optional[MaxGroupTieredPackagePriceCreditAllocation] = None
29372937

29382938
currency: str
29392939

@@ -2943,13 +2943,13 @@ class MaxGroupTieredPrice(BaseModel):
29432943

29442944
fixed_price_quantity: Optional[float] = None
29452945

2946-
invoicing_cycle_configuration: Optional[MaxGroupTieredPriceInvoicingCycleConfiguration] = None
2946+
invoicing_cycle_configuration: Optional[MaxGroupTieredPackagePriceInvoicingCycleConfiguration] = None
29472947

2948-
item: MaxGroupTieredPriceItem
2948+
item: MaxGroupTieredPackagePriceItem
29492949

2950-
max_group_tiered_config: Dict[str, object]
2950+
max_group_tiered_package_config: Dict[str, object]
29512951

2952-
maximum: Optional[MaxGroupTieredPriceMaximum] = None
2952+
maximum: Optional[MaxGroupTieredPackagePriceMaximum] = None
29532953

29542954
maximum_amount: Optional[str] = None
29552955

@@ -2961,11 +2961,11 @@ class MaxGroupTieredPrice(BaseModel):
29612961
cleared by setting `metadata` to `null`.
29622962
"""
29632963

2964-
minimum: Optional[MaxGroupTieredPriceMinimum] = None
2964+
minimum: Optional[MaxGroupTieredPackagePriceMinimum] = None
29652965

29662966
minimum_amount: Optional[str] = None
29672967

2968-
price_model_type: Literal["max_group_tiered"] = FieldInfo(alias="model_type")
2968+
price_model_type: Literal["max_group_tiered_package"] = FieldInfo(alias="model_type")
29692969

29702970
name: str
29712971

@@ -3000,7 +3000,7 @@ class MaxGroupTieredPrice(BaseModel):
30003000
MatrixWithDisplayNamePrice,
30013001
BulkWithProrationPrice,
30023002
GroupedTieredPackagePrice,
3003-
MaxGroupTieredPrice,
3003+
MaxGroupTieredPackagePrice,
30043004
],
30053005
PropertyInfo(discriminator="price_model_type"),
30063006
]

0 commit comments

Comments
 (0)