Skip to content

Commit a76a33a

Browse files
feat(api): api update
1 parent fd639a0 commit a76a33a

File tree

154 files changed

+11494
-448
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+11494
-448
lines changed

.stats.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
configured_endpoints: 115
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-fee4c7438579fd72ae7c08ad11cc502da279ad3cccfe2235b18afcacc91ad0d9.yml
3-
openapi_spec_hash: dc9d553a388715ba22d873aee54a3ed1
4-
config_hash: 38d4539e31b962c34d7ceb224b161855
1+
configured_endpoints: 116
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-84f839bf30c9974915924b75d13e9de6f72952fd64cf7b59ef6146f88be9b985.yml
3+
openapi_spec_hash: 4e1225a45bb47ae6854fcb1e3b710d69
4+
config_hash: c3e48c662ff76bcdb6cd5dc1c139e4c9

api.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,12 @@ Methods:
469469
Types:
470470

471471
```python
472-
from orb.types import EvaluatePriceGroup, PriceEvaluateResponse, PriceEvaluateMultipleResponse
472+
from orb.types import (
473+
EvaluatePriceGroup,
474+
PriceEvaluateResponse,
475+
PriceEvaluateMultipleResponse,
476+
PriceEvaluatePreviewEventsResponse,
477+
)
473478
```
474479

475480
Methods:
@@ -479,6 +484,7 @@ Methods:
479484
- <code title="get /prices">client.prices.<a href="./src/orb/resources/prices/prices.py">list</a>(\*\*<a href="src/orb/types/price_list_params.py">params</a>) -> <a href="./src/orb/types/shared/price.py">SyncPage[Price]</a></code>
480485
- <code title="post /prices/{price_id}/evaluate">client.prices.<a href="./src/orb/resources/prices/prices.py">evaluate</a>(price_id, \*\*<a href="src/orb/types/price_evaluate_params.py">params</a>) -> <a href="./src/orb/types/price_evaluate_response.py">PriceEvaluateResponse</a></code>
481486
- <code title="post /prices/evaluate">client.prices.<a href="./src/orb/resources/prices/prices.py">evaluate_multiple</a>(\*\*<a href="src/orb/types/price_evaluate_multiple_params.py">params</a>) -> <a href="./src/orb/types/price_evaluate_multiple_response.py">PriceEvaluateMultipleResponse</a></code>
487+
- <code title="post /prices/evaluate_preview_events">client.prices.<a href="./src/orb/resources/prices/prices.py">evaluate_preview_events</a>(\*\*<a href="src/orb/types/price_evaluate_preview_events_params.py">params</a>) -> <a href="./src/orb/types/price_evaluate_preview_events_response.py">PriceEvaluatePreviewEventsResponse</a></code>
482488
- <code title="get /prices/{price_id}">client.prices.<a href="./src/orb/resources/prices/prices.py">fetch</a>(price_id) -> <a href="./src/orb/types/shared/price.py">Price</a></code>
483489

484490
## ExternalPriceID

src/orb/resources/prices/prices.py

Lines changed: 442 additions & 8 deletions
Large diffs are not rendered by default.

src/orb/types/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,7 @@
236236
from .alert_create_for_subscription_params import AlertCreateForSubscriptionParams as AlertCreateForSubscriptionParams
237237
from .beta_set_default_plan_version_params import BetaSetDefaultPlanVersionParams as BetaSetDefaultPlanVersionParams
238238
from .new_subscription_package_price_param import NewSubscriptionPackagePriceParam as NewSubscriptionPackagePriceParam
239+
from .price_evaluate_preview_events_params import PriceEvaluatePreviewEventsParams as PriceEvaluatePreviewEventsParams
239240
from .subscription_fetch_schedule_response import SubscriptionFetchScheduleResponse as SubscriptionFetchScheduleResponse
240241
from .customer_update_by_external_id_params import CustomerUpdateByExternalIDParams as CustomerUpdateByExternalIDParams
241242
from .dimensional_price_group_create_params import (
@@ -245,6 +246,9 @@
245246
from .subscription_change_retrieve_response import (
246247
SubscriptionChangeRetrieveResponse as SubscriptionChangeRetrieveResponse,
247248
)
249+
from .price_evaluate_preview_events_response import (
250+
PriceEvaluatePreviewEventsResponse as PriceEvaluatePreviewEventsResponse,
251+
)
248252
from .new_accounting_sync_configuration_param import (
249253
NewAccountingSyncConfigurationParam as NewAccountingSyncConfigurationParam,
250254
)

src/orb/types/new_subscription_bps_price_param.py

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,60 @@
22

33
from __future__ import annotations
44

5-
from typing import Dict, Optional
6-
from typing_extensions import Literal, Required, TypedDict
5+
from typing import Dict, Union, Iterable, Optional
6+
from typing_extensions import Literal, Required, TypeAlias, TypedDict
77

88
from .shared_params.bps_config import BPSConfig
99
from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
1010
from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1111

12-
__all__ = ["NewSubscriptionBPSPriceParam"]
12+
__all__ = [
13+
"NewSubscriptionBPSPriceParam",
14+
"ConversionRateConfig",
15+
"ConversionRateConfigUnitConversionRateConfig",
16+
"ConversionRateConfigUnitConversionRateConfigUnitConfig",
17+
"ConversionRateConfigTieredConversionRateConfig",
18+
"ConversionRateConfigTieredConversionRateConfigTieredConfig",
19+
"ConversionRateConfigTieredConversionRateConfigTieredConfigTier",
20+
]
21+
22+
23+
class ConversionRateConfigUnitConversionRateConfigUnitConfig(TypedDict, total=False):
24+
unit_amount: Required[str]
25+
"""Amount per unit of overage"""
26+
27+
28+
class ConversionRateConfigUnitConversionRateConfig(TypedDict, total=False):
29+
conversion_rate_type: Required[Literal["unit"]]
30+
31+
unit_config: Required[ConversionRateConfigUnitConversionRateConfigUnitConfig]
32+
33+
34+
class ConversionRateConfigTieredConversionRateConfigTieredConfigTier(TypedDict, total=False):
35+
first_unit: Required[float]
36+
"""Exclusive tier starting value"""
37+
38+
unit_amount: Required[str]
39+
"""Amount per unit of overage"""
40+
41+
last_unit: Optional[float]
42+
"""Inclusive tier ending value. If null, this is treated as the last tier"""
43+
44+
45+
class ConversionRateConfigTieredConversionRateConfigTieredConfig(TypedDict, total=False):
46+
tiers: Required[Iterable[ConversionRateConfigTieredConversionRateConfigTieredConfigTier]]
47+
"""Tiers for rating based on total usage quantities into the specified tier"""
48+
49+
50+
class ConversionRateConfigTieredConversionRateConfig(TypedDict, total=False):
51+
conversion_rate_type: Required[Literal["tiered"]]
52+
53+
tiered_config: Required[ConversionRateConfigTieredConversionRateConfigTieredConfig]
54+
55+
56+
ConversionRateConfig: TypeAlias = Union[
57+
ConversionRateConfigUnitConversionRateConfig, ConversionRateConfigTieredConversionRateConfig
58+
]
1359

1460

1561
class NewSubscriptionBPSPriceParam(TypedDict, total=False):
@@ -47,6 +93,9 @@ class NewSubscriptionBPSPriceParam(TypedDict, total=False):
4793
conversion_rate: Optional[float]
4894
"""The per unit conversion rate of the price currency to the invoicing currency."""
4995

96+
conversion_rate_config: Optional[ConversionRateConfig]
97+
"""The configuration for the rate of the price currency to the invoicing currency."""
98+
5099
currency: Optional[str]
51100
"""
52101
An ISO 4217 currency string, or custom pricing unit identifier, in which this

src/orb/types/new_subscription_bulk_bps_price_param.py

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,60 @@
22

33
from __future__ import annotations
44

5-
from typing import Dict, Optional
6-
from typing_extensions import Literal, Required, TypedDict
5+
from typing import Dict, Union, Iterable, Optional
6+
from typing_extensions import Literal, Required, TypeAlias, TypedDict
77

88
from .shared_params.bulk_bps_config import BulkBPSConfig
99
from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
1010
from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1111

12-
__all__ = ["NewSubscriptionBulkBPSPriceParam"]
12+
__all__ = [
13+
"NewSubscriptionBulkBPSPriceParam",
14+
"ConversionRateConfig",
15+
"ConversionRateConfigUnitConversionRateConfig",
16+
"ConversionRateConfigUnitConversionRateConfigUnitConfig",
17+
"ConversionRateConfigTieredConversionRateConfig",
18+
"ConversionRateConfigTieredConversionRateConfigTieredConfig",
19+
"ConversionRateConfigTieredConversionRateConfigTieredConfigTier",
20+
]
21+
22+
23+
class ConversionRateConfigUnitConversionRateConfigUnitConfig(TypedDict, total=False):
24+
unit_amount: Required[str]
25+
"""Amount per unit of overage"""
26+
27+
28+
class ConversionRateConfigUnitConversionRateConfig(TypedDict, total=False):
29+
conversion_rate_type: Required[Literal["unit"]]
30+
31+
unit_config: Required[ConversionRateConfigUnitConversionRateConfigUnitConfig]
32+
33+
34+
class ConversionRateConfigTieredConversionRateConfigTieredConfigTier(TypedDict, total=False):
35+
first_unit: Required[float]
36+
"""Exclusive tier starting value"""
37+
38+
unit_amount: Required[str]
39+
"""Amount per unit of overage"""
40+
41+
last_unit: Optional[float]
42+
"""Inclusive tier ending value. If null, this is treated as the last tier"""
43+
44+
45+
class ConversionRateConfigTieredConversionRateConfigTieredConfig(TypedDict, total=False):
46+
tiers: Required[Iterable[ConversionRateConfigTieredConversionRateConfigTieredConfigTier]]
47+
"""Tiers for rating based on total usage quantities into the specified tier"""
48+
49+
50+
class ConversionRateConfigTieredConversionRateConfig(TypedDict, total=False):
51+
conversion_rate_type: Required[Literal["tiered"]]
52+
53+
tiered_config: Required[ConversionRateConfigTieredConversionRateConfigTieredConfig]
54+
55+
56+
ConversionRateConfig: TypeAlias = Union[
57+
ConversionRateConfigUnitConversionRateConfig, ConversionRateConfigTieredConversionRateConfig
58+
]
1359

1460

1561
class NewSubscriptionBulkBPSPriceParam(TypedDict, total=False):
@@ -47,6 +93,9 @@ class NewSubscriptionBulkBPSPriceParam(TypedDict, total=False):
4793
conversion_rate: Optional[float]
4894
"""The per unit conversion rate of the price currency to the invoicing currency."""
4995

96+
conversion_rate_config: Optional[ConversionRateConfig]
97+
"""The configuration for the rate of the price currency to the invoicing currency."""
98+
5099
currency: Optional[str]
51100
"""
52101
An ISO 4217 currency string, or custom pricing unit identifier, in which this

src/orb/types/new_subscription_bulk_price_param.py

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,60 @@
22

33
from __future__ import annotations
44

5-
from typing import Dict, Optional
6-
from typing_extensions import Literal, Required, TypedDict
5+
from typing import Dict, Union, Iterable, Optional
6+
from typing_extensions import Literal, Required, TypeAlias, TypedDict
77

88
from .shared_params.bulk_config import BulkConfig
99
from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
1010
from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1111

12-
__all__ = ["NewSubscriptionBulkPriceParam"]
12+
__all__ = [
13+
"NewSubscriptionBulkPriceParam",
14+
"ConversionRateConfig",
15+
"ConversionRateConfigUnitConversionRateConfig",
16+
"ConversionRateConfigUnitConversionRateConfigUnitConfig",
17+
"ConversionRateConfigTieredConversionRateConfig",
18+
"ConversionRateConfigTieredConversionRateConfigTieredConfig",
19+
"ConversionRateConfigTieredConversionRateConfigTieredConfigTier",
20+
]
21+
22+
23+
class ConversionRateConfigUnitConversionRateConfigUnitConfig(TypedDict, total=False):
24+
unit_amount: Required[str]
25+
"""Amount per unit of overage"""
26+
27+
28+
class ConversionRateConfigUnitConversionRateConfig(TypedDict, total=False):
29+
conversion_rate_type: Required[Literal["unit"]]
30+
31+
unit_config: Required[ConversionRateConfigUnitConversionRateConfigUnitConfig]
32+
33+
34+
class ConversionRateConfigTieredConversionRateConfigTieredConfigTier(TypedDict, total=False):
35+
first_unit: Required[float]
36+
"""Exclusive tier starting value"""
37+
38+
unit_amount: Required[str]
39+
"""Amount per unit of overage"""
40+
41+
last_unit: Optional[float]
42+
"""Inclusive tier ending value. If null, this is treated as the last tier"""
43+
44+
45+
class ConversionRateConfigTieredConversionRateConfigTieredConfig(TypedDict, total=False):
46+
tiers: Required[Iterable[ConversionRateConfigTieredConversionRateConfigTieredConfigTier]]
47+
"""Tiers for rating based on total usage quantities into the specified tier"""
48+
49+
50+
class ConversionRateConfigTieredConversionRateConfig(TypedDict, total=False):
51+
conversion_rate_type: Required[Literal["tiered"]]
52+
53+
tiered_config: Required[ConversionRateConfigTieredConversionRateConfigTieredConfig]
54+
55+
56+
ConversionRateConfig: TypeAlias = Union[
57+
ConversionRateConfigUnitConversionRateConfig, ConversionRateConfigTieredConversionRateConfig
58+
]
1359

1460

1561
class NewSubscriptionBulkPriceParam(TypedDict, total=False):
@@ -47,6 +93,9 @@ class NewSubscriptionBulkPriceParam(TypedDict, total=False):
4793
conversion_rate: Optional[float]
4894
"""The per unit conversion rate of the price currency to the invoicing currency."""
4995

96+
conversion_rate_config: Optional[ConversionRateConfig]
97+
"""The configuration for the rate of the price currency to the invoicing currency."""
98+
5099
currency: Optional[str]
51100
"""
52101
An ISO 4217 currency string, or custom pricing unit identifier, in which this

src/orb/types/new_subscription_bulk_with_proration_price_param.py

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,59 @@
22

33
from __future__ import annotations
44

5-
from typing import Dict, Optional
6-
from typing_extensions import Literal, Required, TypedDict
5+
from typing import Dict, Union, Iterable, Optional
6+
from typing_extensions import Literal, Required, TypeAlias, TypedDict
77

88
from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
99
from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
1010

11-
__all__ = ["NewSubscriptionBulkWithProrationPriceParam"]
11+
__all__ = [
12+
"NewSubscriptionBulkWithProrationPriceParam",
13+
"ConversionRateConfig",
14+
"ConversionRateConfigUnitConversionRateConfig",
15+
"ConversionRateConfigUnitConversionRateConfigUnitConfig",
16+
"ConversionRateConfigTieredConversionRateConfig",
17+
"ConversionRateConfigTieredConversionRateConfigTieredConfig",
18+
"ConversionRateConfigTieredConversionRateConfigTieredConfigTier",
19+
]
20+
21+
22+
class ConversionRateConfigUnitConversionRateConfigUnitConfig(TypedDict, total=False):
23+
unit_amount: Required[str]
24+
"""Amount per unit of overage"""
25+
26+
27+
class ConversionRateConfigUnitConversionRateConfig(TypedDict, total=False):
28+
conversion_rate_type: Required[Literal["unit"]]
29+
30+
unit_config: Required[ConversionRateConfigUnitConversionRateConfigUnitConfig]
31+
32+
33+
class ConversionRateConfigTieredConversionRateConfigTieredConfigTier(TypedDict, total=False):
34+
first_unit: Required[float]
35+
"""Exclusive tier starting value"""
36+
37+
unit_amount: Required[str]
38+
"""Amount per unit of overage"""
39+
40+
last_unit: Optional[float]
41+
"""Inclusive tier ending value. If null, this is treated as the last tier"""
42+
43+
44+
class ConversionRateConfigTieredConversionRateConfigTieredConfig(TypedDict, total=False):
45+
tiers: Required[Iterable[ConversionRateConfigTieredConversionRateConfigTieredConfigTier]]
46+
"""Tiers for rating based on total usage quantities into the specified tier"""
47+
48+
49+
class ConversionRateConfigTieredConversionRateConfig(TypedDict, total=False):
50+
conversion_rate_type: Required[Literal["tiered"]]
51+
52+
tiered_config: Required[ConversionRateConfigTieredConversionRateConfigTieredConfig]
53+
54+
55+
ConversionRateConfig: TypeAlias = Union[
56+
ConversionRateConfigUnitConversionRateConfig, ConversionRateConfigTieredConversionRateConfig
57+
]
1258

1359

1460
class NewSubscriptionBulkWithProrationPriceParam(TypedDict, total=False):
@@ -46,6 +92,9 @@ class NewSubscriptionBulkWithProrationPriceParam(TypedDict, total=False):
4692
conversion_rate: Optional[float]
4793
"""The per unit conversion rate of the price currency to the invoicing currency."""
4894

95+
conversion_rate_config: Optional[ConversionRateConfig]
96+
"""The configuration for the rate of the price currency to the invoicing currency."""
97+
4998
currency: Optional[str]
5099
"""
51100
An ISO 4217 currency string, or custom pricing unit identifier, in which this

0 commit comments

Comments
 (0)