feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 115
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-fee4c7438579fd72ae7c08ad11cc502da279ad3cccfe2235b18afcacc91ad0d9.yml
-openapi_spec_hash: dc9d553a388715ba22d873aee54a3ed1
-config_hash: 391be06f59c5754193a4880894cb7878
+configured_endpoints: 116
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-c2a4808c828c8288c5c8dfe2fdfa51d4d7c1bcc33cacc6b859d0cf4b35ce95cc.yml
+openapi_spec_hash: a2b5a1bfabbd03dd1b411791576eb502
+config_hash: 3c3524be9607afb24d2139ce26ce5389

api.md

@@ -474,7 +474,12 @@ Methods:
 Types:
 
 ```python
-from orb.types import EvaluatePriceGroup, PriceEvaluateResponse, PriceEvaluateMultipleResponse
+from orb.types import (
+    EvaluatePriceGroup,
+    PriceEvaluateResponse,
+    PriceEvaluateMultipleResponse,
+    PriceEvaluatePreviewEventsResponse,
+)
 ```
 
 Methods:
@@ -484,6 +489,7 @@ Methods:
 - <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>
 - <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>
 - <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>
+- <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>
 - <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>
 
 ## ExternalPriceID

src/orb/resources/prices/prices.py

@@ -241,6 +241,7 @@
 from .alert_create_for_subscription_params import AlertCreateForSubscriptionParams as AlertCreateForSubscriptionParams
 from .beta_set_default_plan_version_params import BetaSetDefaultPlanVersionParams as BetaSetDefaultPlanVersionParams
 from .new_subscription_package_price_param import NewSubscriptionPackagePriceParam as NewSubscriptionPackagePriceParam
+from .price_evaluate_preview_events_params import PriceEvaluatePreviewEventsParams as PriceEvaluatePreviewEventsParams
 from .subscription_fetch_schedule_response import SubscriptionFetchScheduleResponse as SubscriptionFetchScheduleResponse
 from .customer_update_by_external_id_params import CustomerUpdateByExternalIDParams as CustomerUpdateByExternalIDParams
 from .dimensional_price_group_create_params import (
@@ -250,6 +251,9 @@
 from .subscription_change_retrieve_response import (
     SubscriptionChangeRetrieveResponse as SubscriptionChangeRetrieveResponse,
 )
+from .price_evaluate_preview_events_response import (
+    PriceEvaluatePreviewEventsResponse as PriceEvaluatePreviewEventsResponse,
+)
 from .new_accounting_sync_configuration_param import (
     NewAccountingSyncConfigurationParam as NewAccountingSyncConfigurationParam,
 )

src/orb/types/__init__.py

@@ -2,14 +2,18 @@
 
 from __future__ import annotations
 
-from typing import Dict, Optional
-from typing_extensions import Literal, Required, TypedDict
+from typing import Dict, Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
 from .shared_params.bps_config import BPSConfig
+from .shared_params.unit_conversion_rate_config import UnitConversionRateConfig
+from .shared_params.tiered_conversion_rate_config import TieredConversionRateConfig
 from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
 from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
 
-__all__ = ["NewSubscriptionBPSPriceParam"]
+__all__ = ["NewSubscriptionBPSPriceParam", "ConversionRateConfig"]
+
+ConversionRateConfig: TypeAlias = Union[UnitConversionRateConfig, TieredConversionRateConfig]
 
 
 class NewSubscriptionBPSPriceParam(TypedDict, total=False):
@@ -47,6 +51,9 @@ class NewSubscriptionBPSPriceParam(TypedDict, total=False):
     conversion_rate: Optional[float]
     """The per unit conversion rate of the price currency to the invoicing currency."""
 
+    conversion_rate_config: Optional[ConversionRateConfig]
+    """The configuration for the rate of the price currency to the invoicing currency."""
+
     currency: Optional[str]
     """
     An ISO 4217 currency string, or custom pricing unit identifier, in which this

src/orb/types/new_subscription_bps_price_param.py

@@ -2,14 +2,18 @@
 
 from __future__ import annotations
 
-from typing import Dict, Optional
-from typing_extensions import Literal, Required, TypedDict
+from typing import Dict, Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
 from .shared_params.bulk_bps_config import BulkBPSConfig
+from .shared_params.unit_conversion_rate_config import UnitConversionRateConfig
+from .shared_params.tiered_conversion_rate_config import TieredConversionRateConfig
 from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
 from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
 
-__all__ = ["NewSubscriptionBulkBPSPriceParam"]
+__all__ = ["NewSubscriptionBulkBPSPriceParam", "ConversionRateConfig"]
+
+ConversionRateConfig: TypeAlias = Union[UnitConversionRateConfig, TieredConversionRateConfig]
 
 
 class NewSubscriptionBulkBPSPriceParam(TypedDict, total=False):
@@ -47,6 +51,9 @@ class NewSubscriptionBulkBPSPriceParam(TypedDict, total=False):
     conversion_rate: Optional[float]
     """The per unit conversion rate of the price currency to the invoicing currency."""
 
+    conversion_rate_config: Optional[ConversionRateConfig]
+    """The configuration for the rate of the price currency to the invoicing currency."""
+
     currency: Optional[str]
     """
     An ISO 4217 currency string, or custom pricing unit identifier, in which this

src/orb/types/new_subscription_bulk_bps_price_param.py

@@ -2,14 +2,18 @@
 
 from __future__ import annotations
 
-from typing import Dict, Optional
-from typing_extensions import Literal, Required, TypedDict
+from typing import Dict, Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
 from .shared_params.bulk_config import BulkConfig
+from .shared_params.unit_conversion_rate_config import UnitConversionRateConfig
+from .shared_params.tiered_conversion_rate_config import TieredConversionRateConfig
 from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
 from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
 
-__all__ = ["NewSubscriptionBulkPriceParam"]
+__all__ = ["NewSubscriptionBulkPriceParam", "ConversionRateConfig"]
+
+ConversionRateConfig: TypeAlias = Union[UnitConversionRateConfig, TieredConversionRateConfig]
 
 
 class NewSubscriptionBulkPriceParam(TypedDict, total=False):
@@ -47,6 +51,9 @@ class NewSubscriptionBulkPriceParam(TypedDict, total=False):
     conversion_rate: Optional[float]
     """The per unit conversion rate of the price currency to the invoicing currency."""
 
+    conversion_rate_config: Optional[ConversionRateConfig]
+    """The configuration for the rate of the price currency to the invoicing currency."""
+
     currency: Optional[str]
     """
     An ISO 4217 currency string, or custom pricing unit identifier, in which this

src/orb/types/new_subscription_bulk_price_param.py

@@ -2,13 +2,17 @@
 
 from __future__ import annotations
 
-from typing import Dict, Optional
-from typing_extensions import Literal, Required, TypedDict
+from typing import Dict, Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from .shared_params.unit_conversion_rate_config import UnitConversionRateConfig
+from .shared_params.tiered_conversion_rate_config import TieredConversionRateConfig
 from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
 from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
 
-__all__ = ["NewSubscriptionBulkWithProrationPriceParam"]
+__all__ = ["NewSubscriptionBulkWithProrationPriceParam", "ConversionRateConfig"]
+
+ConversionRateConfig: TypeAlias = Union[UnitConversionRateConfig, TieredConversionRateConfig]
 
 
 class NewSubscriptionBulkWithProrationPriceParam(TypedDict, total=False):
@@ -46,6 +50,9 @@ class NewSubscriptionBulkWithProrationPriceParam(TypedDict, total=False):
     conversion_rate: Optional[float]
     """The per unit conversion rate of the price currency to the invoicing currency."""
 
+    conversion_rate_config: Optional[ConversionRateConfig]
+    """The configuration for the rate of the price currency to the invoicing currency."""
+
     currency: Optional[str]
     """
     An ISO 4217 currency string, or custom pricing unit identifier, in which this

src/orb/types/new_subscription_bulk_with_proration_price_param.py

@@ -2,13 +2,17 @@
 
 from __future__ import annotations
 
-from typing import Dict, Optional
-from typing_extensions import Literal, Required, TypedDict
+from typing import Dict, Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from .shared_params.unit_conversion_rate_config import UnitConversionRateConfig
+from .shared_params.tiered_conversion_rate_config import TieredConversionRateConfig
 from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
 from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
 
-__all__ = ["NewSubscriptionCumulativeGroupedBulkPriceParam"]
+__all__ = ["NewSubscriptionCumulativeGroupedBulkPriceParam", "ConversionRateConfig"]
+
+ConversionRateConfig: TypeAlias = Union[UnitConversionRateConfig, TieredConversionRateConfig]
 
 
 class NewSubscriptionCumulativeGroupedBulkPriceParam(TypedDict, total=False):
@@ -46,6 +50,9 @@ class NewSubscriptionCumulativeGroupedBulkPriceParam(TypedDict, total=False):
     conversion_rate: Optional[float]
     """The per unit conversion rate of the price currency to the invoicing currency."""
 
+    conversion_rate_config: Optional[ConversionRateConfig]
+    """The configuration for the rate of the price currency to the invoicing currency."""
+
     currency: Optional[str]
     """
     An ISO 4217 currency string, or custom pricing unit identifier, in which this

src/orb/types/new_subscription_cumulative_grouped_bulk_price_param.py

@@ -2,13 +2,17 @@
 
 from __future__ import annotations
 
-from typing import Dict, Optional
-from typing_extensions import Literal, Required, TypedDict
+from typing import Dict, Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from .shared_params.unit_conversion_rate_config import UnitConversionRateConfig
+from .shared_params.tiered_conversion_rate_config import TieredConversionRateConfig
 from .shared_params.new_billing_cycle_configuration import NewBillingCycleConfiguration
 from .shared_params.new_dimensional_price_configuration import NewDimensionalPriceConfiguration
 
-__all__ = ["NewSubscriptionGroupedAllocationPriceParam"]
+__all__ = ["NewSubscriptionGroupedAllocationPriceParam", "ConversionRateConfig"]
+
+ConversionRateConfig: TypeAlias = Union[UnitConversionRateConfig, TieredConversionRateConfig]
 
 
 class NewSubscriptionGroupedAllocationPriceParam(TypedDict, total=False):
@@ -46,6 +50,9 @@ class NewSubscriptionGroupedAllocationPriceParam(TypedDict, total=False):
     conversion_rate: Optional[float]
     """The per unit conversion rate of the price currency to the invoicing currency."""
 
+    conversion_rate_config: Optional[ConversionRateConfig]
+    """The configuration for the rate of the price currency to the invoicing currency."""
+
     currency: Optional[str]
     """
     An ISO 4217 currency string, or custom pricing unit identifier, in which this