feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 116
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-d631cebb768659e659427b08c22243b7993936c24214eb1fc837e172c11012c2.yml
-openapi_spec_hash: e025faa481e0ca183949cd81548197bf
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-62651294c6bdd7c8d1c183fe4e5ba844a7ac29d80bef9e150739354a9c431ab4.yml
+openapi_spec_hash: 46c5d7f541c0c2143b975be9725c9189
 config_hash: 3c3524be9607afb24d2139ce26ce5389

src/orb/resources/plans/plans.py

@@ -60,10 +60,12 @@ def create(
         currency: str,
         name: str,
         prices: Iterable[plan_create_params.Price],
+        adjustments: Optional[Iterable[plan_create_params.Adjustment]] | NotGiven = NOT_GIVEN,
         default_invoice_memo: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
         net_terms: Optional[int] | NotGiven = NOT_GIVEN,
+        plan_phases: Optional[Iterable[plan_create_params.PlanPhase]] | NotGiven = NOT_GIVEN,
         status: Literal["active", "draft"] | 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.
@@ -83,6 +85,9 @@ def create(
           prices: Prices for this plan. If the plan has phases, this includes prices across all
               phases of the plan.
 
+          adjustments: Adjustments for this plan. If the plan has phases, this includes adjustments
+              across all phases of the plan.
+
           default_invoice_memo: Free-form text which is available on the invoice PDF and the Orb invoice portal.
 
           metadata: User-specified key/value pairs for the resource. Individual keys can be removed
@@ -93,6 +98,9 @@ def create(
               date for the invoice. If you intend the invoice to be due on issue, set this
               to 0.
 
+          plan_phases: Configuration of pre-defined phases, each with their own prices and adjustments.
+              Leave unspecified for plans with a single phase.
+
           status: The status of the plan to create (either active or draft). If not specified,
               this defaults to active.
 
@@ -113,10 +121,12 @@ def create(
                     "currency": currency,
                     "name": name,
                     "prices": prices,
+                    "adjustments": adjustments,
                     "default_invoice_memo": default_invoice_memo,
                     "external_plan_id": external_plan_id,
                     "metadata": metadata,
                     "net_terms": net_terms,
+                    "plan_phases": plan_phases,
                     "status": status,
                 },
                 plan_create_params.PlanCreateParams,
@@ -335,10 +345,12 @@ async def create(
         currency: str,
         name: str,
         prices: Iterable[plan_create_params.Price],
+        adjustments: Optional[Iterable[plan_create_params.Adjustment]] | NotGiven = NOT_GIVEN,
         default_invoice_memo: Optional[str] | NotGiven = NOT_GIVEN,
         external_plan_id: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
         net_terms: Optional[int] | NotGiven = NOT_GIVEN,
+        plan_phases: Optional[Iterable[plan_create_params.PlanPhase]] | NotGiven = NOT_GIVEN,
         status: Literal["active", "draft"] | 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.
@@ -358,6 +370,9 @@ async def create(
           prices: Prices for this plan. If the plan has phases, this includes prices across all
               phases of the plan.
 
+          adjustments: Adjustments for this plan. If the plan has phases, this includes adjustments
+              across all phases of the plan.
+
           default_invoice_memo: Free-form text which is available on the invoice PDF and the Orb invoice portal.
 
           metadata: User-specified key/value pairs for the resource. Individual keys can be removed
@@ -368,6 +383,9 @@ async def create(
               date for the invoice. If you intend the invoice to be due on issue, set this
               to 0.
 
+          plan_phases: Configuration of pre-defined phases, each with their own prices and adjustments.
+              Leave unspecified for plans with a single phase.
+
           status: The status of the plan to create (either active or draft). If not specified,
               this defaults to active.
 
@@ -388,10 +406,12 @@ async def create(
                     "currency": currency,
                     "name": name,
                     "prices": prices,
+                    "adjustments": adjustments,
                     "default_invoice_memo": default_invoice_memo,
                     "external_plan_id": external_plan_id,
                     "metadata": metadata,
                     "net_terms": net_terms,
+                    "plan_phases": plan_phases,
                     "status": status,
                 },
                 plan_create_params.PlanCreateParams,

src/orb/types/plan_create_params.py

@@ -5,12 +5,18 @@
 from typing import Dict, Union, Iterable, Optional
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from .shared_params.new_maximum import NewMaximum
+from .shared_params.new_minimum import NewMinimum
 from .shared_params.new_plan_bps_price import NewPlanBPSPrice
+from .shared_params.new_usage_discount import NewUsageDiscount
+from .shared_params.new_amount_discount import NewAmountDiscount
 from .shared_params.new_plan_bulk_price import NewPlanBulkPrice
 from .shared_params.new_plan_unit_price import NewPlanUnitPrice
+from .shared_params.new_allocation_price import NewAllocationPrice
 from .shared_params.new_plan_matrix_price import NewPlanMatrixPrice
 from .shared_params.new_plan_tiered_price import NewPlanTieredPrice
 from .shared_params.new_plan_package_price import NewPlanPackagePrice
+from .shared_params.new_percentage_discount import NewPercentageDiscount
 from .shared_params.new_plan_bulk_bps_price import NewPlanBulkBPSPrice
 from .shared_params.new_plan_tiered_bps_price import NewPlanTieredBPSPrice
 from .shared_params.new_plan_grouped_tiered_price import NewPlanGroupedTieredPrice
@@ -36,7 +42,7 @@
     NewPlanScalableMatrixWithTieredPricingPrice,
 )
 
-__all__ = ["PlanCreateParams", "Price"]
+__all__ = ["PlanCreateParams", "Price", "PricePrice", "Adjustment", "AdjustmentAdjustment", "PlanPhase"]
 
 
 class PlanCreateParams(TypedDict, total=False):
@@ -54,6 +60,12 @@ class PlanCreateParams(TypedDict, total=False):
     If the plan has phases, this includes prices across all phases of the plan.
     """
 
+    adjustments: Optional[Iterable[Adjustment]]
+    """Adjustments for this plan.
+
+    If the plan has phases, this includes adjustments across all phases of the plan.
+    """
+
     default_invoice_memo: Optional[str]
     """
     Free-form text which is available on the invoice PDF and the Orb invoice portal.
@@ -75,14 +87,20 @@ class PlanCreateParams(TypedDict, total=False):
     to 0.
     """
 
+    plan_phases: Optional[Iterable[PlanPhase]]
+    """Configuration of pre-defined phases, each with their own prices and adjustments.
+
+    Leave unspecified for plans with a single phase.
+    """
+
     status: Literal["active", "draft"]
     """The status of the plan to create (either active or draft).
 
     If not specified, this defaults to active.
     """
 
 
-Price: TypeAlias = Union[
+PricePrice: TypeAlias = Union[
     NewPlanUnitPrice,
     NewPlanPackagePrice,
     NewPlanMatrixPrice,
@@ -112,3 +130,43 @@ class PlanCreateParams(TypedDict, total=False):
     NewPlanMatrixWithAllocationPrice,
     NewPlanGroupedTieredPrice,
 ]
+
+
+class Price(TypedDict, total=False):
+    allocation_price: Optional[NewAllocationPrice]
+    """The allocation price to add to the plan."""
+
+    plan_phase_order: Optional[int]
+    """The phase to add this price to."""
+
+    price: Optional[PricePrice]
+    """The price to add to the plan"""
+
+
+AdjustmentAdjustment: TypeAlias = Union[
+    NewPercentageDiscount, NewUsageDiscount, NewAmountDiscount, NewMinimum, NewMaximum
+]
+
+
+class Adjustment(TypedDict, total=False):
+    adjustment: Required[AdjustmentAdjustment]
+    """The definition of a new adjustment to create and add to the plan."""
+
+    plan_phase_order: Optional[int]
+    """The phase to add this adjustment to."""
+
+
+class PlanPhase(TypedDict, total=False):
+    order: Required[int]
+    """Determines the ordering of the phase in a plan's lifecycle. 1 = first phase."""
+
+    align_billing_with_phase_start_date: Optional[bool]
+    """Align billing cycle day with phase start date."""
+
+    duration: Optional[int]
+    """How many terms of length `duration_unit` this phase is active for.
+
+    If null, this phase is evergreen and active indefinitely
+    """
+
+    duration_unit: Optional[Literal["daily", "monthly", "quarterly", "semi_annual", "annual"]]

src/orb/types/shared/new_plan_bps_price.py

@@ -92,3 +92,9 @@ class NewPlanBPSPrice(BaseModel):
     Individual keys can be removed by setting the value to `null`, and the entire
     metadata mapping can be cleared by setting `metadata` to `null`.
     """
+
+    reference_id: Optional[str] = None
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """

src/orb/types/shared/new_plan_bulk_bps_price.py

@@ -92,3 +92,9 @@ class NewPlanBulkBPSPrice(BaseModel):
     Individual keys can be removed by setting the value to `null`, and the entire
     metadata mapping can be cleared by setting `metadata` to `null`.
     """
+
+    reference_id: Optional[str] = None
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """

src/orb/types/shared/new_plan_bulk_price.py

@@ -92,3 +92,9 @@ class NewPlanBulkPrice(BaseModel):
     Individual keys can be removed by setting the value to `null`, and the entire
     metadata mapping can be cleared by setting `metadata` to `null`.
     """
+
+    reference_id: Optional[str] = None
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """

src/orb/types/shared/new_plan_bulk_with_proration_price.py

@@ -91,3 +91,9 @@ class NewPlanBulkWithProrationPrice(BaseModel):
     Individual keys can be removed by setting the value to `null`, and the entire
     metadata mapping can be cleared by setting `metadata` to `null`.
     """
+
+    reference_id: Optional[str] = None
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """

src/orb/types/shared/new_plan_cumulative_grouped_bulk_price.py

@@ -91,3 +91,9 @@ class NewPlanCumulativeGroupedBulkPrice(BaseModel):
     Individual keys can be removed by setting the value to `null`, and the entire
     metadata mapping can be cleared by setting `metadata` to `null`.
     """
+
+    reference_id: Optional[str] = None
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """

src/orb/types/shared/new_plan_grouped_allocation_price.py

@@ -91,3 +91,9 @@ class NewPlanGroupedAllocationPrice(BaseModel):
     Individual keys can be removed by setting the value to `null`, and the entire
     metadata mapping can be cleared by setting `metadata` to `null`.
     """
+
+    reference_id: Optional[str] = None
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """

src/orb/types/shared/new_plan_grouped_tiered_package_price.py

@@ -91,3 +91,9 @@ class NewPlanGroupedTieredPackagePrice(BaseModel):
     Individual keys can be removed by setting the value to `null`, and the entire
     metadata mapping can be cleared by setting `metadata` to `null`.
     """
+
+    reference_id: Optional[str] = None
+    """
+    A transient ID that can be used to reference this price when adding adjustments
+    in the same API call.
+    """