Skip to content

Commit 5b5c348

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent 9f74fa5 commit 5b5c348

File tree

11 files changed

+88
-94
lines changed

11 files changed

+88
-94
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: 126
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-a5a28a58483355d3cc3da7ac5c452d548ee17183324318198052968121ca7dba.yml
3-
openapi_spec_hash: a317931a99e6d4a122919135a0363e40
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-6017828d1287c194d4d7759dc5b5410225ab58af66ff8605315f70f5e623b82d.yml
3+
openapi_spec_hash: 4390eaf377258fcd7db1dbc073a2c23f
44
config_hash: bcf82bddb691f6be773ac6cae8c03b9a

‎src/orb/resources/customers/credits/ledger.py‎

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,9 @@ def list(
110110
111111
As usage for a customer is reported into Orb, credits may be deducted according
112112
to the customer's plan configuration. An automated deduction of this type will
113-
result in a ledger entry, also with a starting and ending balance. In order to
114-
provide better tracing capabilities for automatic deductions, Orb always
115-
associates each automatic deduction with the `event_id` at the time of
116-
ingestion, used to pinpoint _why_ credit deduction took place and to ensure that
117-
credits are never deducted without an associated usage event.
113+
result in a ledger entry, also with a starting and ending balance. Each day's
114+
usage for a particular price, invoice, and block will be grouped into a single
115+
entry.
118116
119117
By default, Orb uses an algorithm that automatically deducts from the _soonest
120118
expiring credit block_ first in order to ensure that all credits are utilized
@@ -2076,11 +2074,9 @@ def list_by_external_id(
20762074
20772075
As usage for a customer is reported into Orb, credits may be deducted according
20782076
to the customer's plan configuration. An automated deduction of this type will
2079-
result in a ledger entry, also with a starting and ending balance. In order to
2080-
provide better tracing capabilities for automatic deductions, Orb always
2081-
associates each automatic deduction with the `event_id` at the time of
2082-
ingestion, used to pinpoint _why_ credit deduction took place and to ensure that
2083-
credits are never deducted without an associated usage event.
2077+
result in a ledger entry, also with a starting and ending balance. Each day's
2078+
usage for a particular price, invoice, and block will be grouped into a single
2079+
entry.
20842080
20852081
By default, Orb uses an algorithm that automatically deducts from the _soonest
20862082
expiring credit block_ first in order to ensure that all credits are utilized
@@ -2261,11 +2257,9 @@ def list(
22612257
22622258
As usage for a customer is reported into Orb, credits may be deducted according
22632259
to the customer's plan configuration. An automated deduction of this type will
2264-
result in a ledger entry, also with a starting and ending balance. In order to
2265-
provide better tracing capabilities for automatic deductions, Orb always
2266-
associates each automatic deduction with the `event_id` at the time of
2267-
ingestion, used to pinpoint _why_ credit deduction took place and to ensure that
2268-
credits are never deducted without an associated usage event.
2260+
result in a ledger entry, also with a starting and ending balance. Each day's
2261+
usage for a particular price, invoice, and block will be grouped into a single
2262+
entry.
22692263
22702264
By default, Orb uses an algorithm that automatically deducts from the _soonest
22712265
expiring credit block_ first in order to ensure that all credits are utilized
@@ -4227,11 +4221,9 @@ def list_by_external_id(
42274221
42284222
As usage for a customer is reported into Orb, credits may be deducted according
42294223
to the customer's plan configuration. An automated deduction of this type will
4230-
result in a ledger entry, also with a starting and ending balance. In order to
4231-
provide better tracing capabilities for automatic deductions, Orb always
4232-
associates each automatic deduction with the `event_id` at the time of
4233-
ingestion, used to pinpoint _why_ credit deduction took place and to ensure that
4234-
credits are never deducted without an associated usage event.
4224+
result in a ledger entry, also with a starting and ending balance. Each day's
4225+
usage for a particular price, invoice, and block will be grouped into a single
4226+
entry.
42354227
42364228
By default, Orb uses an algorithm that automatically deducts from the _soonest
42374229
expiring credit block_ first in order to ensure that all credits are utilized

‎src/orb/resources/prices/prices.py‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2776,8 +2776,8 @@ def create(
27762776
cadence: Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"],
27772777
currency: str,
27782778
item_id: str,
2779-
minimum_config: price_create_params.NewFloatingMinimumCompositePriceMinimumConfig,
2780-
model_type: Literal["minimum"],
2779+
minimum_composite_config: price_create_params.NewFloatingMinimumCompositePriceMinimumCompositeConfig,
2780+
model_type: Literal["minimum_composite"],
27812781
name: str,
27822782
billable_metric_id: Optional[str] | Omit = omit,
27832783
billed_in_advance: Optional[bool] | Omit = omit,
@@ -2818,7 +2818,7 @@ def create(
28182818
28192819
item_id: The id of the item the price will be associated with.
28202820
2821-
minimum_config: Configuration for minimum pricing
2821+
minimum_composite_config: Configuration for minimum_composite pricing
28222822
28232823
model_type: The pricing model type
28242824
@@ -3086,7 +3086,7 @@ def create(
30863086
["cadence", "currency", "item_id", "model_type", "name", "scalable_matrix_with_tiered_pricing_config"],
30873087
["cadence", "cumulative_grouped_bulk_config", "currency", "item_id", "model_type", "name"],
30883088
["cadence", "cumulative_grouped_allocation_config", "currency", "item_id", "model_type", "name"],
3089-
["cadence", "currency", "item_id", "minimum_config", "model_type", "name"],
3089+
["cadence", "currency", "item_id", "minimum_composite_config", "model_type", "name"],
30903090
["cadence", "currency", "item_id", "model_type", "name", "percent_config"],
30913091
["cadence", "currency", "event_output_config", "item_id", "model_type", "name"],
30923092
)
@@ -3124,7 +3124,7 @@ def create(
31243124
| Literal["scalable_matrix_with_tiered_pricing"]
31253125
| Literal["cumulative_grouped_bulk"]
31263126
| Literal["cumulative_grouped_allocation"]
3127-
| Literal["minimum"]
3127+
| Literal["minimum_composite"]
31283128
| Literal["percent"]
31293129
| Literal["event_output"],
31303130
name: str,
@@ -3218,7 +3218,8 @@ def create(
32183218
| Omit = omit,
32193219
cumulative_grouped_allocation_config: price_create_params.NewFloatingCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig
32203220
| Omit = omit,
3221-
minimum_config: price_create_params.NewFloatingMinimumCompositePriceMinimumConfig | Omit = omit,
3221+
minimum_composite_config: price_create_params.NewFloatingMinimumCompositePriceMinimumCompositeConfig
3222+
| Omit = omit,
32223223
percent_config: price_create_params.NewFloatingPercentCompositePricePercentConfig | Omit = omit,
32233224
event_output_config: price_create_params.NewFloatingEventOutputPriceEventOutputConfig | Omit = omit,
32243225
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -3279,7 +3280,7 @@ def create(
32793280
"scalable_matrix_with_tiered_pricing_config": scalable_matrix_with_tiered_pricing_config,
32803281
"cumulative_grouped_bulk_config": cumulative_grouped_bulk_config,
32813282
"cumulative_grouped_allocation_config": cumulative_grouped_allocation_config,
3282-
"minimum_config": minimum_config,
3283+
"minimum_composite_config": minimum_composite_config,
32833284
"percent_config": percent_config,
32843285
"event_output_config": event_output_config,
32853286
},
@@ -6432,8 +6433,8 @@ async def create(
64326433
cadence: Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"],
64336434
currency: str,
64346435
item_id: str,
6435-
minimum_config: price_create_params.NewFloatingMinimumCompositePriceMinimumConfig,
6436-
model_type: Literal["minimum"],
6436+
minimum_composite_config: price_create_params.NewFloatingMinimumCompositePriceMinimumCompositeConfig,
6437+
model_type: Literal["minimum_composite"],
64376438
name: str,
64386439
billable_metric_id: Optional[str] | Omit = omit,
64396440
billed_in_advance: Optional[bool] | Omit = omit,
@@ -6474,7 +6475,7 @@ async def create(
64746475
64756476
item_id: The id of the item the price will be associated with.
64766477
6477-
minimum_config: Configuration for minimum pricing
6478+
minimum_composite_config: Configuration for minimum_composite pricing
64786479
64796480
model_type: The pricing model type
64806481
@@ -6742,7 +6743,7 @@ async def create(
67426743
["cadence", "currency", "item_id", "model_type", "name", "scalable_matrix_with_tiered_pricing_config"],
67436744
["cadence", "cumulative_grouped_bulk_config", "currency", "item_id", "model_type", "name"],
67446745
["cadence", "cumulative_grouped_allocation_config", "currency", "item_id", "model_type", "name"],
6745-
["cadence", "currency", "item_id", "minimum_config", "model_type", "name"],
6746+
["cadence", "currency", "item_id", "minimum_composite_config", "model_type", "name"],
67466747
["cadence", "currency", "item_id", "model_type", "name", "percent_config"],
67476748
["cadence", "currency", "event_output_config", "item_id", "model_type", "name"],
67486749
)
@@ -6780,7 +6781,7 @@ async def create(
67806781
| Literal["scalable_matrix_with_tiered_pricing"]
67816782
| Literal["cumulative_grouped_bulk"]
67826783
| Literal["cumulative_grouped_allocation"]
6783-
| Literal["minimum"]
6784+
| Literal["minimum_composite"]
67846785
| Literal["percent"]
67856786
| Literal["event_output"],
67866787
name: str,
@@ -6874,7 +6875,8 @@ async def create(
68746875
| Omit = omit,
68756876
cumulative_grouped_allocation_config: price_create_params.NewFloatingCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig
68766877
| Omit = omit,
6877-
minimum_config: price_create_params.NewFloatingMinimumCompositePriceMinimumConfig | Omit = omit,
6878+
minimum_composite_config: price_create_params.NewFloatingMinimumCompositePriceMinimumCompositeConfig
6879+
| Omit = omit,
68786880
percent_config: price_create_params.NewFloatingPercentCompositePricePercentConfig | Omit = omit,
68796881
event_output_config: price_create_params.NewFloatingEventOutputPriceEventOutputConfig | Omit = omit,
68806882
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -6935,7 +6937,7 @@ async def create(
69356937
"scalable_matrix_with_tiered_pricing_config": scalable_matrix_with_tiered_pricing_config,
69366938
"cumulative_grouped_bulk_config": cumulative_grouped_bulk_config,
69376939
"cumulative_grouped_allocation_config": cumulative_grouped_allocation_config,
6938-
"minimum_config": minimum_config,
6940+
"minimum_composite_config": minimum_composite_config,
69396941
"percent_config": percent_config,
69406942
"event_output_config": event_output_config,
69416943
},

‎src/orb/types/new_subscription_minimum_composite_price_param.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
1111
from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1212

13-
__all__ = ["NewSubscriptionMinimumCompositePriceParam", "MinimumConfig", "ConversionRateConfig"]
13+
__all__ = ["NewSubscriptionMinimumCompositePriceParam", "MinimumCompositeConfig", "ConversionRateConfig"]
1414

1515

16-
class MinimumConfig(TypedDict, total=False):
17-
"""Configuration for minimum pricing"""
16+
class MinimumCompositeConfig(TypedDict, total=False):
17+
"""Configuration for minimum_composite pricing"""
1818

1919
minimum_amount: Required[str]
2020
"""The minimum amount to apply"""
@@ -33,10 +33,10 @@ class NewSubscriptionMinimumCompositePriceParam(TypedDict, total=False):
3333
item_id: Required[str]
3434
"""The id of the item the price will be associated with."""
3535

36-
minimum_config: Required[MinimumConfig]
37-
"""Configuration for minimum pricing"""
36+
minimum_composite_config: Required[MinimumCompositeConfig]
37+
"""Configuration for minimum_composite pricing"""
3838

39-
model_type: Required[Literal["minimum"]]
39+
model_type: Required[Literal["minimum_composite"]]
4040
"""The pricing model type"""
4141

4242
name: Required[str]

‎src/orb/types/price_create_params.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
"NewFloatingCumulativeGroupedAllocationPriceCumulativeGroupedAllocationConfig",
116116
"NewFloatingCumulativeGroupedAllocationPriceConversionRateConfig",
117117
"NewFloatingMinimumCompositePrice",
118-
"NewFloatingMinimumCompositePriceMinimumConfig",
118+
"NewFloatingMinimumCompositePriceMinimumCompositeConfig",
119119
"NewFloatingMinimumCompositePriceConversionRateConfig",
120120
"NewFloatingPercentCompositePrice",
121121
"NewFloatingPercentCompositePricePercentConfig",
@@ -2775,10 +2775,10 @@ class NewFloatingMinimumCompositePrice(TypedDict, total=False):
27752775
item_id: Required[str]
27762776
"""The id of the item the price will be associated with."""
27772777

2778-
minimum_config: Required[NewFloatingMinimumCompositePriceMinimumConfig]
2779-
"""Configuration for minimum pricing"""
2778+
minimum_composite_config: Required[NewFloatingMinimumCompositePriceMinimumCompositeConfig]
2779+
"""Configuration for minimum_composite pricing"""
27802780

2781-
model_type: Required[Literal["minimum"]]
2781+
model_type: Required[Literal["minimum_composite"]]
27822782
"""The pricing model type"""
27832783

27842784
name: Required[str]
@@ -2837,8 +2837,8 @@ class NewFloatingMinimumCompositePrice(TypedDict, total=False):
28372837
"""
28382838

28392839

2840-
class NewFloatingMinimumCompositePriceMinimumConfig(TypedDict, total=False):
2841-
"""Configuration for minimum pricing"""
2840+
class NewFloatingMinimumCompositePriceMinimumCompositeConfig(TypedDict, total=False):
2841+
"""Configuration for minimum_composite pricing"""
28422842

28432843
minimum_amount: Required[str]
28442844
"""The minimum amount to apply"""

‎src/orb/types/shared/new_floating_minimum_composite_price.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
from .new_billing_cycle_configuration import NewBillingCycleConfiguration
1313
from .new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1414

15-
__all__ = ["NewFloatingMinimumCompositePrice", "MinimumConfig", "ConversionRateConfig"]
15+
__all__ = ["NewFloatingMinimumCompositePrice", "MinimumCompositeConfig", "ConversionRateConfig"]
1616

1717

18-
class MinimumConfig(BaseModel):
19-
"""Configuration for minimum pricing"""
18+
class MinimumCompositeConfig(BaseModel):
19+
"""Configuration for minimum_composite pricing"""
2020

2121
minimum_amount: str
2222
"""The minimum amount to apply"""
@@ -40,10 +40,10 @@ class NewFloatingMinimumCompositePrice(BaseModel):
4040
item_id: str
4141
"""The id of the item the price will be associated with."""
4242

43-
minimum_config: MinimumConfig
44-
"""Configuration for minimum pricing"""
43+
minimum_composite_config: MinimumCompositeConfig
44+
"""Configuration for minimum_composite pricing"""
4545

46-
price_model_type: Literal["minimum"] = FieldInfo(alias="model_type")
46+
price_model_type: Literal["minimum_composite"] = FieldInfo(alias="model_type")
4747
"""The pricing model type"""
4848

4949
name: str

‎src/orb/types/shared/new_plan_minimum_composite_price.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
from .new_billing_cycle_configuration import NewBillingCycleConfiguration
1313
from .new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1414

15-
__all__ = ["NewPlanMinimumCompositePrice", "MinimumConfig", "ConversionRateConfig"]
15+
__all__ = ["NewPlanMinimumCompositePrice", "MinimumCompositeConfig", "ConversionRateConfig"]
1616

1717

18-
class MinimumConfig(BaseModel):
19-
"""Configuration for minimum pricing"""
18+
class MinimumCompositeConfig(BaseModel):
19+
"""Configuration for minimum_composite pricing"""
2020

2121
minimum_amount: str
2222
"""The minimum amount to apply"""
@@ -37,10 +37,10 @@ class NewPlanMinimumCompositePrice(BaseModel):
3737
item_id: str
3838
"""The id of the item the price will be associated with."""
3939

40-
minimum_config: MinimumConfig
41-
"""Configuration for minimum pricing"""
40+
minimum_composite_config: MinimumCompositeConfig
41+
"""Configuration for minimum_composite pricing"""
4242

43-
price_model_type: Literal["minimum"] = FieldInfo(alias="model_type")
43+
price_model_type: Literal["minimum_composite"] = FieldInfo(alias="model_type")
4444
"""The pricing model type"""
4545

4646
name: str

‎src/orb/types/shared/price.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@
154154
"MinimumCompositePrice",
155155
"MinimumCompositePriceCompositePriceFilter",
156156
"MinimumCompositePriceConversionRateConfig",
157-
"MinimumCompositePriceMinimumConfig",
157+
"MinimumCompositePriceMinimumCompositeConfig",
158158
"PercentCompositePrice",
159159
"PercentCompositePriceCompositePriceFilter",
160160
"PercentCompositePriceConversionRateConfig",
@@ -3175,8 +3175,8 @@ class MinimumCompositePriceCompositePriceFilter(BaseModel):
31753175
]
31763176

31773177

3178-
class MinimumCompositePriceMinimumConfig(BaseModel):
3179-
"""Configuration for minimum pricing"""
3178+
class MinimumCompositePriceMinimumCompositeConfig(BaseModel):
3179+
"""Configuration for minimum_composite pricing"""
31803180

31813181
minimum_amount: str
31823182
"""The minimum amount to apply"""
@@ -3238,10 +3238,10 @@ class MinimumCompositePrice(BaseModel):
32383238

32393239
minimum_amount: Optional[str] = None
32403240

3241-
minimum_config: MinimumCompositePriceMinimumConfig
3242-
"""Configuration for minimum pricing"""
3241+
minimum_composite_config: MinimumCompositePriceMinimumCompositeConfig
3242+
"""Configuration for minimum_composite pricing"""
32433243

3244-
price_model_type: Literal["minimum"] = FieldInfo(alias="model_type")
3244+
price_model_type: Literal["minimum_composite"] = FieldInfo(alias="model_type")
32453245
"""The pricing model type"""
32463246

32473247
name: str

‎src/orb/types/shared_params/new_floating_minimum_composite_price.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
from .new_billing_cycle_configuration import NewBillingCycleConfiguration
1111
from .new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1212

13-
__all__ = ["NewFloatingMinimumCompositePrice", "MinimumConfig", "ConversionRateConfig"]
13+
__all__ = ["NewFloatingMinimumCompositePrice", "MinimumCompositeConfig", "ConversionRateConfig"]
1414

1515

16-
class MinimumConfig(TypedDict, total=False):
17-
"""Configuration for minimum pricing"""
16+
class MinimumCompositeConfig(TypedDict, total=False):
17+
"""Configuration for minimum_composite pricing"""
1818

1919
minimum_amount: Required[str]
2020
"""The minimum amount to apply"""
@@ -36,10 +36,10 @@ class NewFloatingMinimumCompositePrice(TypedDict, total=False):
3636
item_id: Required[str]
3737
"""The id of the item the price will be associated with."""
3838

39-
minimum_config: Required[MinimumConfig]
40-
"""Configuration for minimum pricing"""
39+
minimum_composite_config: Required[MinimumCompositeConfig]
40+
"""Configuration for minimum_composite pricing"""
4141

42-
model_type: Required[Literal["minimum"]]
42+
model_type: Required[Literal["minimum_composite"]]
4343
"""The pricing model type"""
4444

4545
name: Required[str]

‎src/orb/types/shared_params/new_plan_minimum_composite_price.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
from .new_billing_cycle_configuration import NewBillingCycleConfiguration
1111
from .new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1212

13-
__all__ = ["NewPlanMinimumCompositePrice", "MinimumConfig", "ConversionRateConfig"]
13+
__all__ = ["NewPlanMinimumCompositePrice", "MinimumCompositeConfig", "ConversionRateConfig"]
1414

1515

16-
class MinimumConfig(TypedDict, total=False):
17-
"""Configuration for minimum pricing"""
16+
class MinimumCompositeConfig(TypedDict, total=False):
17+
"""Configuration for minimum_composite pricing"""
1818

1919
minimum_amount: Required[str]
2020
"""The minimum amount to apply"""
@@ -33,10 +33,10 @@ class NewPlanMinimumCompositePrice(TypedDict, total=False):
3333
item_id: Required[str]
3434
"""The id of the item the price will be associated with."""
3535

36-
minimum_config: Required[MinimumConfig]
37-
"""Configuration for minimum pricing"""
36+
minimum_composite_config: Required[MinimumCompositeConfig]
37+
"""Configuration for minimum_composite pricing"""
3838

39-
model_type: Required[Literal["minimum"]]
39+
model_type: Required[Literal["minimum_composite"]]
4040
"""The pricing model type"""
4141

4242
name: Required[str]

0 commit comments

Comments
 (0)