feat(api): add matrix with allocation price (#193)

Author: stainless-app[bot]

src/orb/resources/prices/prices.py

@@ -258,6 +258,76 @@ def create(
         """
         ...
 
+    @overload
+    def create(
+        self,
+        *,
+        cadence: Literal["annual", "monthly", "quarterly", "one_time"],
+        currency: str,
+        item_id: str,
+        matrix_with_allocation_config: price_create_params.NewFloatingMatrixWithAllocationPriceMatrixWithAllocationConfig,
+        model_type: Literal["matrix_with_allocation"],
+        name: str,
+        billable_metric_id: Optional[str] | NotGiven = NOT_GIVEN,
+        billed_in_advance: Optional[bool] | 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,
+        # 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.
+
+          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
+
+          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
+        """
+        ...
+
     @overload
     def create(
         self,
@@ -1032,6 +1102,7 @@ def create(
         ["cadence", "currency", "item_id", "model_type", "name", "unit_config"],
         ["cadence", "currency", "item_id", "model_type", "name", "package_config"],
         ["cadence", "currency", "item_id", "matrix_config", "model_type", "name"],
+        ["cadence", "currency", "item_id", "matrix_with_allocation_config", "model_type", "name"],
         ["cadence", "currency", "item_id", "model_type", "name", "tiered_config"],
         ["cadence", "currency", "item_id", "model_type", "name", "tiered_bps_config"],
         ["bps_config", "cadence", "currency", "item_id", "model_type", "name"],
@@ -1053,6 +1124,7 @@ def create(
         model_type: Literal["unit"]
         | Literal["package"]
         | Literal["matrix"]
+        | Literal["matrix_with_allocation"]
         | Literal["tiered"]
         | Literal["tiered_bps"]
         | Literal["bps"]
@@ -1073,6 +1145,8 @@ def create(
         invoice_grouping_key: Optional[str] | NotGiven = NOT_GIVEN,
         package_config: price_create_params.NewFloatingPackagePricePackageConfig | NotGiven = NOT_GIVEN,
         matrix_config: price_create_params.NewFloatingMatrixPriceMatrixConfig | NotGiven = NOT_GIVEN,
+        matrix_with_allocation_config: price_create_params.NewFloatingMatrixWithAllocationPriceMatrixWithAllocationConfig
+        | NotGiven = NOT_GIVEN,
         tiered_config: price_create_params.NewFloatingTieredPriceTieredConfig | NotGiven = NOT_GIVEN,
         tiered_bps_config: price_create_params.NewFloatingTieredBpsPriceTieredBpsConfig | NotGiven = NOT_GIVEN,
         bps_config: price_create_params.NewFloatingBpsPriceBpsConfig | NotGiven = NOT_GIVEN,
@@ -1111,6 +1185,7 @@ def create(
                         "invoice_grouping_key": invoice_grouping_key,
                         "package_config": package_config,
                         "matrix_config": matrix_config,
+                        "matrix_with_allocation_config": matrix_with_allocation_config,
                         "tiered_config": tiered_config,
                         "tiered_bps_config": tiered_bps_config,
                         "bps_config": bps_config,
@@ -1445,6 +1520,76 @@ async def create(
         """
         ...
 
+    @overload
+    async def create(
+        self,
+        *,
+        cadence: Literal["annual", "monthly", "quarterly", "one_time"],
+        currency: str,
+        item_id: str,
+        matrix_with_allocation_config: price_create_params.NewFloatingMatrixWithAllocationPriceMatrixWithAllocationConfig,
+        model_type: Literal["matrix_with_allocation"],
+        name: str,
+        billable_metric_id: Optional[str] | NotGiven = NOT_GIVEN,
+        billed_in_advance: Optional[bool] | 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,
+        # 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.
+
+          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
+
+          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
+        """
+        ...
+
     @overload
     async def create(
         self,
@@ -2219,6 +2364,7 @@ async def create(
         ["cadence", "currency", "item_id", "model_type", "name", "unit_config"],
         ["cadence", "currency", "item_id", "model_type", "name", "package_config"],
         ["cadence", "currency", "item_id", "matrix_config", "model_type", "name"],
+        ["cadence", "currency", "item_id", "matrix_with_allocation_config", "model_type", "name"],
         ["cadence", "currency", "item_id", "model_type", "name", "tiered_config"],
         ["cadence", "currency", "item_id", "model_type", "name", "tiered_bps_config"],
         ["bps_config", "cadence", "currency", "item_id", "model_type", "name"],
@@ -2240,6 +2386,7 @@ async def create(
         model_type: Literal["unit"]
         | Literal["package"]
         | Literal["matrix"]
+        | Literal["matrix_with_allocation"]
         | Literal["tiered"]
         | Literal["tiered_bps"]
         | Literal["bps"]
@@ -2260,6 +2407,8 @@ async def create(
         invoice_grouping_key: Optional[str] | NotGiven = NOT_GIVEN,
         package_config: price_create_params.NewFloatingPackagePricePackageConfig | NotGiven = NOT_GIVEN,
         matrix_config: price_create_params.NewFloatingMatrixPriceMatrixConfig | NotGiven = NOT_GIVEN,
+        matrix_with_allocation_config: price_create_params.NewFloatingMatrixWithAllocationPriceMatrixWithAllocationConfig
+        | NotGiven = NOT_GIVEN,
         tiered_config: price_create_params.NewFloatingTieredPriceTieredConfig | NotGiven = NOT_GIVEN,
         tiered_bps_config: price_create_params.NewFloatingTieredBpsPriceTieredBpsConfig | NotGiven = NOT_GIVEN,
         bps_config: price_create_params.NewFloatingBpsPriceBpsConfig | NotGiven = NOT_GIVEN,
@@ -2298,6 +2447,7 @@ async def create(
                         "invoice_grouping_key": invoice_grouping_key,
                         "package_config": package_config,
                         "matrix_config": matrix_config,
+                        "matrix_with_allocation_config": matrix_with_allocation_config,
                         "tiered_config": tiered_config,
                         "tiered_bps_config": tiered_bps_config,
                         "bps_config": bps_config,

src/orb/types/credit_note.py

@@ -78,7 +78,7 @@ class LineItem(BaseModel):
     """The amount of the line item, including any line item minimums and discounts."""
 
     discounts: List[LineItemDiscount]
-    """Any line items discounts from the invoice's line item."""
+    """Any line item discounts from the invoice's line item."""
 
     name: str
     """The name of the corresponding invoice line item."""

src/orb/types/invoice.py

@@ -79,6 +79,9 @@ class CreditNote(BaseModel):
 
     credit_note_number: str
 
+    memo: Optional[str] = None
+    """An optional memo supplied on the credit note."""
+
     reason: str
 
     total: str

src/orb/types/invoice_fetch_upcoming_response.py

@@ -79,6 +79,9 @@ class CreditNote(BaseModel):
 
     credit_note_number: str
 
+    memo: Optional[str] = None
+    """An optional memo supplied on the credit note."""
+
     reason: str
 
     total: str

src/orb/types/price.py

@@ -89,6 +89,13 @@
     "UnitWithPercentPriceItem",
     "UnitWithPercentPriceMaximum",
     "UnitWithPercentPriceMinimum",
+    "MatrixWithAllocationPrice",
+    "MatrixWithAllocationPriceBillableMetric",
+    "MatrixWithAllocationPriceItem",
+    "MatrixWithAllocationPriceMatrixWithAllocationConfig",
+    "MatrixWithAllocationPriceMatrixWithAllocationConfigMatrixValue",
+    "MatrixWithAllocationPriceMaximum",
+    "MatrixWithAllocationPriceMinimum",
 ]
 
 
@@ -1132,6 +1139,111 @@ class UnitWithPercentPrice(BaseModel):
     unit_with_percent_config: Dict[str, object]
 
 
+class MatrixWithAllocationPriceBillableMetric(BaseModel):
+    id: str
+
+
+class MatrixWithAllocationPriceItem(BaseModel):
+    id: str
+
+    name: str
+
+
+class MatrixWithAllocationPriceMatrixWithAllocationConfigMatrixValue(BaseModel):
+    dimension_values: List[Optional[str]]
+    """One or two matrix keys to filter usage to this Matrix value by.
+
+    For example, ["region", "tier"] could be used to filter cloud usage by a cloud
+    region and an instance tier.
+    """
+
+    unit_amount: str
+    """Unit price for the specified dimension_values"""
+
+    scaling_factor: Optional[float] = None
+    """Optional multiplier to scale rated quantities by"""
+
+
+class MatrixWithAllocationPriceMatrixWithAllocationConfig(BaseModel):
+    allocation: float
+    """Allocation to be used to calculate the price"""
+
+    default_unit_amount: str
+    """Default per unit rate for any usage not bucketed into a specified matrix_value"""
+
+    dimensions: List[Optional[str]]
+    """One or two event property values to evaluate matrix groups by"""
+
+    matrix_values: List[MatrixWithAllocationPriceMatrixWithAllocationConfigMatrixValue]
+    """Matrix values for specified matrix grouping keys"""
+
+    scaling_factor: Optional[float] = None
+    """
+    Default optional multiplier to scale rated quantities that fall into the default
+    bucket by
+    """
+
+
+class MatrixWithAllocationPriceMaximum(BaseModel):
+    applies_to_price_ids: List[str]
+    """List of price_ids that this maximum amount applies to.
+
+    For plan/plan phase maximums, this can be a subset of prices.
+    """
+
+    maximum_amount: str
+    """Maximum amount applied"""
+
+
+class MatrixWithAllocationPriceMinimum(BaseModel):
+    applies_to_price_ids: List[str]
+    """List of price_ids that this minimum amount applies to.
+
+    For plan/plan phase minimums, this can be a subset of prices.
+    """
+
+    minimum_amount: str
+    """Minimum amount applied"""
+
+
+class MatrixWithAllocationPrice(BaseModel):
+    id: str
+
+    billable_metric: Optional[MatrixWithAllocationPriceBillableMetric] = None
+
+    cadence: Literal["one_time", "monthly", "quarterly", "annual"]
+
+    created_at: datetime
+
+    currency: str
+
+    discount: Optional[Discount] = None
+
+    external_price_id: Optional[str] = None
+
+    fixed_price_quantity: Optional[float] = None
+
+    item: MatrixWithAllocationPriceItem
+
+    matrix_with_allocation_config: MatrixWithAllocationPriceMatrixWithAllocationConfig
+
+    maximum: Optional[MatrixWithAllocationPriceMaximum] = None
+
+    maximum_amount: Optional[str] = None
+
+    minimum: Optional[MatrixWithAllocationPriceMinimum] = None
+
+    minimum_amount: Optional[str] = None
+
+    price_model_type: Literal["matrix_with_allocation"] = FieldInfo(alias="model_type")
+
+    name: str
+
+    plan_phase_order: Optional[int] = None
+
+    price_type: Literal["usage_price", "fixed_price"]
+
+
 Price = Union[
     UnitPrice,
     PackagePrice,
@@ -1146,4 +1258,5 @@ class UnitWithPercentPrice(BaseModel):
     TieredWithMinimumPrice,
     PackageWithAllocationPrice,
     UnitWithPercentPrice,
+    MatrixWithAllocationPrice,
 ]