feat(api): api update (#549)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 103
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-99ab2def905df4700d0555a61c3e6f3e378664df85756fc0ff604aed8f8c5f8b.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-097aa5c0e1408d7bd31c15caded400b84f45c0296aebdf67a1dc1a4013f371dd.yml

src/orb/resources/customers/customers.py

@@ -99,6 +99,7 @@ def create(
         currency: Optional[str] | NotGiven = NOT_GIVEN,
         email_delivery: Optional[bool] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
+        hierarchy: Optional[customer_create_params.Hierarchy] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
         payment_provider: Optional[Literal["quickbooks", "bill.com", "stripe_charge", "stripe_invoice", "netsuite"]]
         | NotGiven = NOT_GIVEN,
@@ -151,6 +152,8 @@ def create(
               system as an alias for this Customer. Use this field to identify a customer by
               an existing identifier in your system.
 
+          hierarchy: The hierarchical relationships for this customer.
+
           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`.
@@ -295,6 +298,7 @@ def create(
                     "currency": currency,
                     "email_delivery": email_delivery,
                     "external_customer_id": external_customer_id,
+                    "hierarchy": hierarchy,
                     "metadata": metadata,
                     "payment_provider": payment_provider,
                     "payment_provider_id": payment_provider_id,
@@ -329,6 +333,7 @@ def update(
         email: Optional[str] | NotGiven = NOT_GIVEN,
         email_delivery: Optional[bool] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
+        hierarchy: Optional[customer_update_params.Hierarchy] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
         name: Optional[str] | NotGiven = NOT_GIVEN,
         payment_provider: Optional[Literal["quickbooks", "bill.com", "stripe_charge", "stripe_invoice", "netsuite"]]
@@ -369,6 +374,8 @@ def update(
           external_customer_id: The external customer ID. This can only be set if empty and the customer has no
               past or current subscriptions.
 
+          hierarchy: The hierarchical relationships for this customer.
+
           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`.
@@ -516,6 +523,7 @@ def update(
                     "email": email,
                     "email_delivery": email_delivery,
                     "external_customer_id": external_customer_id,
+                    "hierarchy": hierarchy,
                     "metadata": metadata,
                     "name": name,
                     "payment_provider": payment_provider,
@@ -839,6 +847,7 @@ def update_by_external_id(
         email: Optional[str] | NotGiven = NOT_GIVEN,
         email_delivery: Optional[bool] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
+        hierarchy: Optional[customer_update_by_external_id_params.Hierarchy] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
         name: Optional[str] | NotGiven = NOT_GIVEN,
         payment_provider: Optional[Literal["quickbooks", "bill.com", "stripe_charge", "stripe_invoice", "netsuite"]]
@@ -879,6 +888,8 @@ def update_by_external_id(
           external_customer_id: The external customer ID. This can only be set if empty and the customer has no
               past or current subscriptions.
 
+          hierarchy: The hierarchical relationships for this customer.
+
           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`.
@@ -1026,6 +1037,7 @@ def update_by_external_id(
                     "email": email,
                     "email_delivery": email_delivery,
                     "external_customer_id": external_customer_id,
+                    "hierarchy": hierarchy,
                     "metadata": metadata,
                     "name": name,
                     "payment_provider": payment_provider,
@@ -1093,6 +1105,7 @@ async def create(
         currency: Optional[str] | NotGiven = NOT_GIVEN,
         email_delivery: Optional[bool] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
+        hierarchy: Optional[customer_create_params.Hierarchy] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
         payment_provider: Optional[Literal["quickbooks", "bill.com", "stripe_charge", "stripe_invoice", "netsuite"]]
         | NotGiven = NOT_GIVEN,
@@ -1145,6 +1158,8 @@ async def create(
               system as an alias for this Customer. Use this field to identify a customer by
               an existing identifier in your system.
 
+          hierarchy: The hierarchical relationships for this customer.
+
           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`.
@@ -1289,6 +1304,7 @@ async def create(
                     "currency": currency,
                     "email_delivery": email_delivery,
                     "external_customer_id": external_customer_id,
+                    "hierarchy": hierarchy,
                     "metadata": metadata,
                     "payment_provider": payment_provider,
                     "payment_provider_id": payment_provider_id,
@@ -1323,6 +1339,7 @@ async def update(
         email: Optional[str] | NotGiven = NOT_GIVEN,
         email_delivery: Optional[bool] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
+        hierarchy: Optional[customer_update_params.Hierarchy] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
         name: Optional[str] | NotGiven = NOT_GIVEN,
         payment_provider: Optional[Literal["quickbooks", "bill.com", "stripe_charge", "stripe_invoice", "netsuite"]]
@@ -1363,6 +1380,8 @@ async def update(
           external_customer_id: The external customer ID. This can only be set if empty and the customer has no
               past or current subscriptions.
 
+          hierarchy: The hierarchical relationships for this customer.
+
           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`.
@@ -1510,6 +1529,7 @@ async def update(
                     "email": email,
                     "email_delivery": email_delivery,
                     "external_customer_id": external_customer_id,
+                    "hierarchy": hierarchy,
                     "metadata": metadata,
                     "name": name,
                     "payment_provider": payment_provider,
@@ -1833,6 +1853,7 @@ async def update_by_external_id(
         email: Optional[str] | NotGiven = NOT_GIVEN,
         email_delivery: Optional[bool] | NotGiven = NOT_GIVEN,
         external_customer_id: Optional[str] | NotGiven = NOT_GIVEN,
+        hierarchy: Optional[customer_update_by_external_id_params.Hierarchy] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, Optional[str]]] | NotGiven = NOT_GIVEN,
         name: Optional[str] | NotGiven = NOT_GIVEN,
         payment_provider: Optional[Literal["quickbooks", "bill.com", "stripe_charge", "stripe_invoice", "netsuite"]]
@@ -1873,6 +1894,8 @@ async def update_by_external_id(
           external_customer_id: The external customer ID. This can only be set if empty and the customer has no
               past or current subscriptions.
 
+          hierarchy: The hierarchical relationships for this customer.
+
           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`.
@@ -2020,6 +2043,7 @@ async def update_by_external_id(
                     "email": email,
                     "email_delivery": email_delivery,
                     "external_customer_id": external_customer_id,
+                    "hierarchy": hierarchy,
                     "metadata": metadata,
                     "name": name,
                     "payment_provider": payment_provider,

src/orb/resources/subscriptions.py

@@ -110,6 +110,7 @@ def create(
         replace_prices: Optional[Iterable[subscription_create_params.ReplacePrice]] | NotGiven = NOT_GIVEN,
         start_date: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
         trial_duration_days: Optional[int] | NotGiven = NOT_GIVEN,
+        usage_customer_ids: Optional[List[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,
@@ -442,6 +443,13 @@ def create(
               value specified in the plan. If `0` is provided, the trial on the plan will be
               skipped.
 
+          usage_customer_ids: A list of customer IDs whose usage events will be aggregated and billed under
+              this subscription. By default, a subscription only considers usage events
+              associated with its attached customer's customer_id. When usage_customer_ids is
+              provided, the subscription includes usage events from the specified customers
+              only. Provided usage_customer_ids must be either the customer for this
+              subscription itself, or any of that customer's children.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -486,6 +494,7 @@ def create(
                     "replace_prices": replace_prices,
                     "start_date": start_date,
                     "trial_duration_days": trial_duration_days,
+                    "usage_customer_ids": usage_customer_ids,
                 },
                 subscription_create_params.SubscriptionCreateParams,
             ),
@@ -1382,6 +1391,7 @@ def schedule_plan_change(
         replace_prices: Optional[Iterable[subscription_schedule_plan_change_params.ReplacePrice]]
         | NotGiven = NOT_GIVEN,
         trial_duration_days: Optional[int] | NotGiven = NOT_GIVEN,
+        usage_customer_ids: Optional[List[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,
@@ -1648,6 +1658,13 @@ def schedule_plan_change(
               value specified in the plan. If `0` is provided, the trial on the plan will be
               skipped.
 
+          usage_customer_ids: A list of customer IDs whose usage events will be aggregated and billed under
+              this subscription. By default, a subscription only considers usage events
+              associated with its attached customer's customer_id. When usage_customer_ids is
+              provided, the subscription includes usage events from the specified customers
+              only. Provided usage_customer_ids must be either the customer for this
+              subscription itself, or any of that customer's children.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1689,6 +1706,7 @@ def schedule_plan_change(
                     "replace_adjustments": replace_adjustments,
                     "replace_prices": replace_prices,
                     "trial_duration_days": trial_duration_days,
+                    "usage_customer_ids": usage_customer_ids,
                 },
                 subscription_schedule_plan_change_params.SubscriptionSchedulePlanChangeParams,
             ),
@@ -2106,6 +2124,7 @@ async def create(
         replace_prices: Optional[Iterable[subscription_create_params.ReplacePrice]] | NotGiven = NOT_GIVEN,
         start_date: Union[str, datetime, None] | NotGiven = NOT_GIVEN,
         trial_duration_days: Optional[int] | NotGiven = NOT_GIVEN,
+        usage_customer_ids: Optional[List[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,
@@ -2438,6 +2457,13 @@ async def create(
               value specified in the plan. If `0` is provided, the trial on the plan will be
               skipped.
 
+          usage_customer_ids: A list of customer IDs whose usage events will be aggregated and billed under
+              this subscription. By default, a subscription only considers usage events
+              associated with its attached customer's customer_id. When usage_customer_ids is
+              provided, the subscription includes usage events from the specified customers
+              only. Provided usage_customer_ids must be either the customer for this
+              subscription itself, or any of that customer's children.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -2482,6 +2508,7 @@ async def create(
                     "replace_prices": replace_prices,
                     "start_date": start_date,
                     "trial_duration_days": trial_duration_days,
+                    "usage_customer_ids": usage_customer_ids,
                 },
                 subscription_create_params.SubscriptionCreateParams,
             ),
@@ -3378,6 +3405,7 @@ async def schedule_plan_change(
         replace_prices: Optional[Iterable[subscription_schedule_plan_change_params.ReplacePrice]]
         | NotGiven = NOT_GIVEN,
         trial_duration_days: Optional[int] | NotGiven = NOT_GIVEN,
+        usage_customer_ids: Optional[List[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,
@@ -3644,6 +3672,13 @@ async def schedule_plan_change(
               value specified in the plan. If `0` is provided, the trial on the plan will be
               skipped.
 
+          usage_customer_ids: A list of customer IDs whose usage events will be aggregated and billed under
+              this subscription. By default, a subscription only considers usage events
+              associated with its attached customer's customer_id. When usage_customer_ids is
+              provided, the subscription includes usage events from the specified customers
+              only. Provided usage_customer_ids must be either the customer for this
+              subscription itself, or any of that customer's children.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -3685,6 +3720,7 @@ async def schedule_plan_change(
                     "replace_adjustments": replace_adjustments,
                     "replace_prices": replace_prices,
                     "trial_duration_days": trial_duration_days,
+                    "usage_customer_ids": usage_customer_ids,
                 },
                 subscription_schedule_plan_change_params.SubscriptionSchedulePlanChangeParams,
             ),

src/orb/types/customer.py

@@ -9,6 +9,9 @@
 __all__ = [
     "Customer",
     "BillingAddress",
+    "Hierarchy",
+    "HierarchyChild",
+    "HierarchyParent",
     "ShippingAddress",
     "TaxID",
     "AccountingSyncConfiguration",
@@ -31,6 +34,24 @@ class BillingAddress(BaseModel):
     state: Optional[str] = None
 
 
+class HierarchyChild(BaseModel):
+    id: str
+
+    external_customer_id: Optional[str] = None
+
+
+class HierarchyParent(BaseModel):
+    id: str
+
+    external_customer_id: Optional[str] = None
+
+
+class Hierarchy(BaseModel):
+    children: List[HierarchyChild]
+
+    parent: Optional[HierarchyParent] = None
+
+
 class ShippingAddress(BaseModel):
     city: Optional[str] = None
 
@@ -254,6 +275,9 @@ class Customer(BaseModel):
     an existing identifier in your system.
     """
 
+    hierarchy: Hierarchy
+    """The hierarchical relationships for this customer."""
+
     metadata: Dict[str, str]
     """User specified key-value pairs for the resource.
 

src/orb/types/customer_create_params.py

@@ -10,6 +10,7 @@
     "AccountingSyncConfiguration",
     "AccountingSyncConfigurationAccountingProvider",
     "BillingAddress",
+    "Hierarchy",
     "ReportingConfiguration",
     "ShippingAddress",
     "TaxConfiguration",
@@ -62,6 +63,9 @@ class CustomerCreateParams(TypedDict, total=False):
     an existing identifier in your system.
     """
 
+    hierarchy: Optional[Hierarchy]
+    """The hierarchical relationships for this customer."""
+
     metadata: Optional[Dict[str, Optional[str]]]
     """User-specified key/value pairs for the resource.
 
@@ -231,6 +235,20 @@ class BillingAddress(TypedDict, total=False):
     state: Optional[str]
 
 
+class Hierarchy(TypedDict, total=False):
+    child_customer_ids: List[str]
+    """A list of child customer IDs to add to the hierarchy.
+
+    The desired child customers must not already be part of another hierarchy.
+    """
+
+    parent_customer_id: Optional[str]
+    """The ID of the parent customer in the hierarchy.
+
+    The desired parent customer must not be a child of another customer.
+    """
+
+
 class ReportingConfiguration(TypedDict, total=False):
     exempt: Required[bool]
 

src/orb/types/customer_update_by_external_id_params.py

@@ -10,6 +10,7 @@
     "AccountingSyncConfiguration",
     "AccountingSyncConfigurationAccountingProvider",
     "BillingAddress",
+    "Hierarchy",
     "ReportingConfiguration",
     "ShippingAddress",
     "TaxConfiguration",
@@ -55,6 +56,9 @@ class CustomerUpdateByExternalIDParams(TypedDict, total=False):
     subscriptions.
     """
 
+    hierarchy: Optional[Hierarchy]
+    """The hierarchical relationships for this customer."""
+
     metadata: Optional[Dict[str, Optional[str]]]
     """User-specified key/value pairs for the resource.
 
@@ -224,6 +228,20 @@ class BillingAddress(TypedDict, total=False):
     state: Optional[str]
 
 
+class Hierarchy(TypedDict, total=False):
+    child_customer_ids: List[str]
+    """A list of child customer IDs to add to the hierarchy.
+
+    The desired child customers must not already be part of another hierarchy.
+    """
+
+    parent_customer_id: Optional[str]
+    """The ID of the parent customer in the hierarchy.
+
+    The desired parent customer must not be a child of another customer.
+    """
+
+
 class ReportingConfiguration(TypedDict, total=False):
     exempt: Required[bool]