feat(api): api update (#423)

Author: Stainless Bot

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 93
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-4df283466fdce46e787565c6480138896b1d7ed98d68a79d5eb3438bed191276.yml
+configured_endpoints: 96
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-1345a8e288e34d5477b0e189877225f83939a59078c22fbb5367712e376c5d19.yml

src/orb/resources/prices/prices.py

@@ -1950,6 +1950,98 @@ def create(
         """
         ...
 
+    @overload
+    def create(
+        self,
+        *,
+        cadence: Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"],
+        currency: str,
+        grouped_tiered_package_config: Dict[str, object],
+        item_id: str,
+        model_type: Literal["grouped_tiered_package"],
+        name: str,
+        billable_metric_id: Optional[str] | NotGiven = NOT_GIVEN,
+        billed_in_advance: Optional[bool] | NotGiven = NOT_GIVEN,
+        billing_cycle_configuration: Optional[
+            price_create_params.NewFloatingGroupedTieredPackagePriceBillingCycleConfiguration
+        ]
+        | NotGiven = NOT_GIVEN,
+        conversion_rate: Optional[float] | NotGiven = NOT_GIVEN,
+        external_price_id: Optional[str] | NotGiven = NOT_GIVEN,
+        fixed_price_quantity: Optional[float] | NotGiven = NOT_GIVEN,
+        invoice_grouping_key: Optional[str] | NotGiven = NOT_GIVEN,
+        invoicing_cycle_configuration: Optional[
+            price_create_params.NewFloatingGroupedTieredPackagePriceInvoicingCycleConfiguration
+        ]
+        | NotGiven = NOT_GIVEN,
+        metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        idempotency_key: str | None = None,
+    ) -> Price:
+        """This endpoint is used to create a [price](../reference/price).
+
+        A price created
+        using this endpoint is always an add-on, meaning that it’s not associated with a
+        specific plan and can instead be individually added to subscriptions, including
+        subscriptions on different plans.
+
+        An `external_price_id` can be optionally specified as an alias to allow
+        ergonomic interaction with prices in the Orb API.
+
+        See the [Price resource](../reference/price) for the specification of different
+        price model configurations possible in this endpoint.
+
+        Args:
+          cadence: The cadence to bill for this price on.
+
+          currency: An ISO 4217 currency string for which this price is billed in.
+
+          item_id: The id of the item the plan will be associated with.
+
+          name: The name of the price.
+
+          billable_metric_id: The id of the billable metric for the price. Only needed if the price is
+              usage-based.
+
+          billed_in_advance: If the Price represents a fixed cost, the price will be billed in-advance if
+              this is true, and in-arrears if this is false.
+
+          billing_cycle_configuration: For custom cadence: specifies the duration of the billing period in days or
+              months.
+
+          conversion_rate: The per unit conversion rate of the price currency to the invoicing currency.
+
+          external_price_id: An alias for the price.
+
+          fixed_price_quantity: If the Price represents a fixed cost, this represents the quantity of units
+              applied.
+
+          invoice_grouping_key: The property used to group this price on an invoice
+
+          invoicing_cycle_configuration: Within each billing cycle, specifies the cadence at which invoices are produced.
+              If unspecified, a single invoice is produced per billing cycle.
+
+          metadata: User-specified key/value pairs for the resource. Individual keys can be removed
+              by setting the value to `null`, and the entire metadata mapping can be cleared
+              by setting `metadata` to `null`.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        ...
+
     @required_args(
         ["cadence", "currency", "item_id", "model_type", "name", "unit_config"],
         ["cadence", "currency", "item_id", "model_type", "name", "package_config"],
@@ -1972,6 +2064,7 @@ def create(
         ["cadence", "currency", "grouped_allocation_config", "item_id", "model_type", "name"],
         ["cadence", "currency", "grouped_with_prorated_minimum_config", "item_id", "model_type", "name"],
         ["bulk_with_proration_config", "cadence", "currency", "item_id", "model_type", "name"],
+        ["cadence", "currency", "grouped_tiered_package_config", "item_id", "model_type", "name"],
     )
     def create(
         self,
@@ -1999,7 +2092,10 @@ def create(
         | Literal["unit_with_proration"]
         | Literal["grouped_allocation"]
         | Literal["grouped_with_prorated_minimum"]
-        | Literal["bulk_with_proration"],
+        | Literal["grouped_with_metered_minimum"]
+        | Literal["matrix_with_display_name"]
+        | Literal["bulk_with_proration"]
+        | Literal["grouped_tiered_package"],
         name: str,
         unit_config: price_create_params.NewFloatingUnitPriceUnitConfig | NotGiven = NOT_GIVEN,
         billable_metric_id: Optional[str] | NotGiven = NOT_GIVEN,
@@ -2034,6 +2130,7 @@ def create(
         grouped_allocation_config: Dict[str, object] | NotGiven = NOT_GIVEN,
         grouped_with_prorated_minimum_config: Dict[str, object] | NotGiven = NOT_GIVEN,
         bulk_with_proration_config: Dict[str, object] | NotGiven = NOT_GIVEN,
+        grouped_tiered_package_config: Dict[str, object] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -2083,6 +2180,7 @@ def create(
                         "grouped_allocation_config": grouped_allocation_config,
                         "grouped_with_prorated_minimum_config": grouped_with_prorated_minimum_config,
                         "bulk_with_proration_config": bulk_with_proration_config,
+                        "grouped_tiered_package_config": grouped_tiered_package_config,
                     },
                     price_create_params.PriceCreateParams,
                 ),
@@ -4243,6 +4341,98 @@ async def create(
         """
         ...
 
+    @overload
+    async def create(
+        self,
+        *,
+        cadence: Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"],
+        currency: str,
+        grouped_tiered_package_config: Dict[str, object],
+        item_id: str,
+        model_type: Literal["grouped_tiered_package"],
+        name: str,
+        billable_metric_id: Optional[str] | NotGiven = NOT_GIVEN,
+        billed_in_advance: Optional[bool] | NotGiven = NOT_GIVEN,
+        billing_cycle_configuration: Optional[
+            price_create_params.NewFloatingGroupedTieredPackagePriceBillingCycleConfiguration
+        ]
+        | NotGiven = NOT_GIVEN,
+        conversion_rate: Optional[float] | NotGiven = NOT_GIVEN,
+        external_price_id: Optional[str] | NotGiven = NOT_GIVEN,
+        fixed_price_quantity: Optional[float] | NotGiven = NOT_GIVEN,
+        invoice_grouping_key: Optional[str] | NotGiven = NOT_GIVEN,
+        invoicing_cycle_configuration: Optional[
+            price_create_params.NewFloatingGroupedTieredPackagePriceInvoicingCycleConfiguration
+        ]
+        | NotGiven = NOT_GIVEN,
+        metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        idempotency_key: str | None = None,
+    ) -> Price:
+        """This endpoint is used to create a [price](../reference/price).
+
+        A price created
+        using this endpoint is always an add-on, meaning that it’s not associated with a
+        specific plan and can instead be individually added to subscriptions, including
+        subscriptions on different plans.
+
+        An `external_price_id` can be optionally specified as an alias to allow
+        ergonomic interaction with prices in the Orb API.
+
+        See the [Price resource](../reference/price) for the specification of different
+        price model configurations possible in this endpoint.
+
+        Args:
+          cadence: The cadence to bill for this price on.
+
+          currency: An ISO 4217 currency string for which this price is billed in.
+
+          item_id: The id of the item the plan will be associated with.
+
+          name: The name of the price.
+
+          billable_metric_id: The id of the billable metric for the price. Only needed if the price is
+              usage-based.
+
+          billed_in_advance: If the Price represents a fixed cost, the price will be billed in-advance if
+              this is true, and in-arrears if this is false.
+
+          billing_cycle_configuration: For custom cadence: specifies the duration of the billing period in days or
+              months.
+
+          conversion_rate: The per unit conversion rate of the price currency to the invoicing currency.
+
+          external_price_id: An alias for the price.
+
+          fixed_price_quantity: If the Price represents a fixed cost, this represents the quantity of units
+              applied.
+
+          invoice_grouping_key: The property used to group this price on an invoice
+
+          invoicing_cycle_configuration: Within each billing cycle, specifies the cadence at which invoices are produced.
+              If unspecified, a single invoice is produced per billing cycle.
+
+          metadata: User-specified key/value pairs for the resource. Individual keys can be removed
+              by setting the value to `null`, and the entire metadata mapping can be cleared
+              by setting `metadata` to `null`.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        ...
+
     @required_args(
         ["cadence", "currency", "item_id", "model_type", "name", "unit_config"],
         ["cadence", "currency", "item_id", "model_type", "name", "package_config"],
@@ -4265,6 +4455,7 @@ async def create(
         ["cadence", "currency", "grouped_allocation_config", "item_id", "model_type", "name"],
         ["cadence", "currency", "grouped_with_prorated_minimum_config", "item_id", "model_type", "name"],
         ["bulk_with_proration_config", "cadence", "currency", "item_id", "model_type", "name"],
+        ["cadence", "currency", "grouped_tiered_package_config", "item_id", "model_type", "name"],
     )
     async def create(
         self,
@@ -4292,7 +4483,10 @@ async def create(
         | Literal["unit_with_proration"]
         | Literal["grouped_allocation"]
         | Literal["grouped_with_prorated_minimum"]
-        | Literal["bulk_with_proration"],
+        | Literal["grouped_with_metered_minimum"]
+        | Literal["matrix_with_display_name"]
+        | Literal["bulk_with_proration"]
+        | Literal["grouped_tiered_package"],
         name: str,
         unit_config: price_create_params.NewFloatingUnitPriceUnitConfig | NotGiven = NOT_GIVEN,
         billable_metric_id: Optional[str] | NotGiven = NOT_GIVEN,
@@ -4327,6 +4521,7 @@ async def create(
         grouped_allocation_config: Dict[str, object] | NotGiven = NOT_GIVEN,
         grouped_with_prorated_minimum_config: Dict[str, object] | NotGiven = NOT_GIVEN,
         bulk_with_proration_config: Dict[str, object] | NotGiven = NOT_GIVEN,
+        grouped_tiered_package_config: Dict[str, object] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -4376,6 +4571,7 @@ async def create(
                         "grouped_allocation_config": grouped_allocation_config,
                         "grouped_with_prorated_minimum_config": grouped_with_prorated_minimum_config,
                         "bulk_with_proration_config": bulk_with_proration_config,
+                        "grouped_tiered_package_config": grouped_tiered_package_config,
                     },
                     price_create_params.PriceCreateParams,
                 ),

src/orb/types/plan_create_params.py

@@ -75,6 +75,9 @@
     "PriceNewPlanBulkWithProrationPrice",
     "PriceNewPlanBulkWithProrationPriceBillingCycleConfiguration",
     "PriceNewPlanBulkWithProrationPriceInvoicingCycleConfiguration",
+    "PriceNewPlanGroupedTieredPackagePrice",
+    "PriceNewPlanGroupedTieredPackagePriceBillingCycleConfiguration",
+    "PriceNewPlanGroupedTieredPackagePriceInvoicingCycleConfiguration",
 ]
 
 
@@ -1733,6 +1736,89 @@ class PriceNewPlanBulkWithProrationPrice(TypedDict, total=False):
     """
 
 
+class PriceNewPlanGroupedTieredPackagePriceBillingCycleConfiguration(TypedDict, total=False):
+    duration: Required[int]
+    """The duration of the billing period."""
+
+    duration_unit: Required[Literal["day", "month"]]
+    """The unit of billing period duration."""
+
+
+class PriceNewPlanGroupedTieredPackagePriceInvoicingCycleConfiguration(TypedDict, total=False):
+    duration: Required[int]
+    """The duration of the billing period."""
+
+    duration_unit: Required[Literal["day", "month"]]
+    """The unit of billing period duration."""
+
+
+class PriceNewPlanGroupedTieredPackagePrice(TypedDict, total=False):
+    cadence: Required[Literal["annual", "semi_annual", "monthly", "quarterly", "one_time", "custom"]]
+    """The cadence to bill for this price on."""
+
+    grouped_tiered_package_config: Required[Dict[str, object]]
+
+    item_id: Required[str]
+    """The id of the item the plan will be associated with."""
+
+    model_type: Required[Literal["grouped_tiered_package"]]
+
+    name: Required[str]
+    """The name of the price."""
+
+    billable_metric_id: Optional[str]
+    """The id of the billable metric for the price.
+
+    Only needed if the price is usage-based.
+    """
+
+    billed_in_advance: Optional[bool]
+    """
+    If the Price represents a fixed cost, the price will be billed in-advance if
+    this is true, and in-arrears if this is false.
+    """
+
+    billing_cycle_configuration: Optional[PriceNewPlanGroupedTieredPackagePriceBillingCycleConfiguration]
+    """
+    For custom cadence: specifies the duration of the billing period in days or
+    months.
+    """
+
+    conversion_rate: Optional[float]
+    """The per unit conversion 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
+    price is billed.
+    """
+
+    external_price_id: Optional[str]
+    """An alias for the price."""
+
+    fixed_price_quantity: Optional[float]
+    """
+    If the Price represents a fixed cost, this represents the quantity of units
+    applied.
+    """
+
+    invoice_grouping_key: Optional[str]
+    """The property used to group this price on an invoice"""
+
+    invoicing_cycle_configuration: Optional[PriceNewPlanGroupedTieredPackagePriceInvoicingCycleConfiguration]
+    """Within each billing cycle, specifies the cadence at which invoices are produced.
+
+    If unspecified, a single invoice is produced per billing cycle.
+    """
+
+    metadata: Optional[Dict[str, Optional[str]]]
+    """User-specified key/value pairs for the resource.
+
+    Individual keys can be removed by setting the value to `null`, and the entire
+    metadata mapping can be cleared by setting `metadata` to `null`.
+    """
+
+
 Price: TypeAlias = Union[
     PriceNewPlanUnitPrice,
     PriceNewPlanPackagePrice,
@@ -1752,4 +1838,5 @@ class PriceNewPlanBulkWithProrationPrice(TypedDict, total=False):
     PriceNewPlanGroupedAllocationPrice,
     PriceNewPlanGroupedWithProratedMinimumPrice,
     PriceNewPlanBulkWithProrationPrice,
+    PriceNewPlanGroupedTieredPackagePrice,
 ]