feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 139
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-6b1440d47f0b1b1b92f2e40f9ad5efd301d90f66e2e05c5a932902608935aa64.yml
-openapi_spec_hash: 14f386604d0d87d9459352b8a7b84eff
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-ebac75191b7fecb0dc03df5b9eeb62d99811905552ddc2a2bd5a7a77dbfe00d3.yml
+openapi_spec_hash: 1b96488643f8c4bc07ea184aa2505ca7
 config_hash: c01c1191b1cd696c7ca855ff6d28a8df

api.md

@@ -408,7 +408,7 @@ Methods:
 - <code title="post /invoices/summary/{invoice_id}/issue">client.invoices.<a href="./src/orb/resources/invoices.py">issue_summary</a>(invoice_id, \*\*<a href="src/orb/types/invoice_issue_summary_params.py">params</a>) -> <a href="./src/orb/types/invoice_issue_summary_response.py">InvoiceIssueSummaryResponse</a></code>
 - <code title="get /invoices/summary">client.invoices.<a href="./src/orb/resources/invoices.py">list_summary</a>(\*\*<a href="src/orb/types/invoice_list_summary_params.py">params</a>) -> <a href="./src/orb/types/invoice_list_summary_response.py">SyncPage[InvoiceListSummaryResponse]</a></code>
 - <code title="post /invoices/{invoice_id}/mark_paid">client.invoices.<a href="./src/orb/resources/invoices.py">mark_paid</a>(invoice_id, \*\*<a href="src/orb/types/invoice_mark_paid_params.py">params</a>) -> <a href="./src/orb/types/shared/invoice.py">Invoice</a></code>
-- <code title="post /invoices/{invoice_id}/pay">client.invoices.<a href="./src/orb/resources/invoices.py">pay</a>(invoice_id) -> <a href="./src/orb/types/shared/invoice.py">Invoice</a></code>
+- <code title="post /invoices/{invoice_id}/pay">client.invoices.<a href="./src/orb/resources/invoices.py">pay</a>(invoice_id, \*\*<a href="src/orb/types/invoice_pay_params.py">params</a>) -> <a href="./src/orb/types/shared/invoice.py">Invoice</a></code>
 - <code title="post /invoices/{invoice_id}/void">client.invoices.<a href="./src/orb/resources/invoices.py">void</a>(invoice_id) -> <a href="./src/orb/types/shared/invoice.py">Invoice</a></code>
 
 # Items

src/orb/resources/invoices.py

@@ -10,6 +10,7 @@
 
 from .. import _legacy_response
 from ..types import (
+    invoice_pay_params,
     invoice_list_params,
     invoice_issue_params,
     invoice_create_params,
@@ -743,6 +744,7 @@ def pay(
         self,
         invoice_id: str,
         *,
+        shared_payment_token_id: str,
         # 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,
@@ -751,11 +753,16 @@ def pay(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
         idempotency_key: str | None = None,
     ) -> Invoice:
-        """
-        This endpoint collects payment for an invoice using the customer's default
-        payment method. This action can only be taken on invoices with status "issued".
+        """This endpoint collects payment for an invoice.
+
+        By default, it uses the
+        customer's default payment method. Optionally, a shared payment token (SPT) can
+        be provided to pay using agent-granted credentials instead. This action can only
+        be taken on invoices with status "issued".
 
         Args:
+          shared_payment_token_id: The ID of a shared payment token granted by an agent to use for this payment.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -770,6 +777,9 @@ def pay(
             raise ValueError(f"Expected a non-empty value for `invoice_id` but received {invoice_id!r}")
         return self._post(
             f"/invoices/{invoice_id}/pay",
+            body=maybe_transform(
+                {"shared_payment_token_id": shared_payment_token_id}, invoice_pay_params.InvoicePayParams
+            ),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -1542,6 +1552,7 @@ async def pay(
         self,
         invoice_id: str,
         *,
+        shared_payment_token_id: str,
         # 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,
@@ -1550,11 +1561,16 @@ async def pay(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
         idempotency_key: str | None = None,
     ) -> Invoice:
-        """
-        This endpoint collects payment for an invoice using the customer's default
-        payment method. This action can only be taken on invoices with status "issued".
+        """This endpoint collects payment for an invoice.
+
+        By default, it uses the
+        customer's default payment method. Optionally, a shared payment token (SPT) can
+        be provided to pay using agent-granted credentials instead. This action can only
+        be taken on invoices with status "issued".
 
         Args:
+          shared_payment_token_id: The ID of a shared payment token granted by an agent to use for this payment.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -1569,6 +1585,9 @@ async def pay(
             raise ValueError(f"Expected a non-empty value for `invoice_id` but received {invoice_id!r}")
         return await self._post(
             f"/invoices/{invoice_id}/pay",
+            body=await async_maybe_transform(
+                {"shared_payment_token_id": shared_payment_token_id}, invoice_pay_params.InvoicePayParams
+            ),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,

src/orb/types/__init__.py

@@ -150,6 +150,7 @@
 from .alert_list_params import AlertListParams as AlertListParams
 from .price_list_params import PriceListParams as PriceListParams
 from .coupon_list_params import CouponListParams as CouponListParams
+from .invoice_pay_params import InvoicePayParams as InvoicePayParams
 from .item_create_params import ItemCreateParams as ItemCreateParams
 from .item_update_params import ItemUpdateParams as ItemUpdateParams
 from .metric_list_params import MetricListParams as MetricListParams

src/orb/types/customer.py

@@ -44,6 +44,13 @@ class PaymentConfigurationPaymentProvider(BaseModel):
     provider_type: Literal["stripe"]
     """The payment provider to configure."""
 
+    default_shared_payment_token: Optional[str] = None
+    """
+    The ID of a shared payment token granted by an agent to use as the default
+    payment instrument for this customer. When set, auto-collection will use this
+    token instead of the customer's default payment method.
+    """
+
     excluded_payment_method_types: Optional[List[str]] = None
     """List of Stripe payment method types to exclude for this customer.
 

src/orb/types/customer_create_params.py

@@ -277,6 +277,13 @@ class PaymentConfigurationPaymentProvider(TypedDict, total=False):
     provider_type: Required[Literal["stripe"]]
     """The payment provider to configure."""
 
+    default_shared_payment_token: Optional[str]
+    """
+    The ID of a shared payment token granted by an agent to use as the default
+    payment instrument for this customer. When set, auto-collection will use this
+    token instead of the customer's default payment method.
+    """
+
     excluded_payment_method_types: SequenceNotStr[str]
     """List of Stripe payment method types to exclude for this customer.
 

src/orb/types/customer_update_by_external_id_params.py

@@ -274,6 +274,13 @@ class PaymentConfigurationPaymentProvider(TypedDict, total=False):
     provider_type: Required[Literal["stripe"]]
     """The payment provider to configure."""
 
+    default_shared_payment_token: Optional[str]
+    """
+    The ID of a shared payment token granted by an agent to use as the default
+    payment instrument for this customer. When set, auto-collection will use this
+    token instead of the customer's default payment method.
+    """
+
     excluded_payment_method_types: SequenceNotStr[str]
     """List of Stripe payment method types to exclude for this customer.
 

src/orb/types/customer_update_params.py

@@ -274,6 +274,13 @@ class PaymentConfigurationPaymentProvider(TypedDict, total=False):
     provider_type: Required[Literal["stripe"]]
     """The payment provider to configure."""
 
+    default_shared_payment_token: Optional[str]
+    """
+    The ID of a shared payment token granted by an agent to use as the default
+    payment instrument for this customer. When set, auto-collection will use this
+    token instead of the customer's default payment method.
+    """
+
     excluded_payment_method_types: SequenceNotStr[str]
     """List of Stripe payment method types to exclude for this customer.
 

src/orb/types/invoice_pay_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["InvoicePayParams"]
+
+
+class InvoicePayParams(TypedDict, total=False):
+    shared_payment_token_id: Required[str]
+    """The ID of a shared payment token granted by an agent to use for this payment."""

tests/api_resources/test_customers.py

@@ -66,6 +66,7 @@ def test_method_create_with_all_params(self, client: Orb) -> None:
                 "payment_providers": [
                     {
                         "provider_type": "stripe",
+                        "default_shared_payment_token": "default_shared_payment_token",
                         "excluded_payment_method_types": ["string"],
                     }
                 ]
@@ -167,6 +168,7 @@ def test_method_update_with_all_params(self, client: Orb) -> None:
                 "payment_providers": [
                     {
                         "provider_type": "stripe",
+                        "default_shared_payment_token": "default_shared_payment_token",
                         "excluded_payment_method_types": ["string"],
                     }
                 ]
@@ -499,6 +501,7 @@ def test_method_update_by_external_id_with_all_params(self, client: Orb) -> None
                 "payment_providers": [
                     {
                         "provider_type": "stripe",
+                        "default_shared_payment_token": "default_shared_payment_token",
                         "excluded_payment_method_types": ["string"],
                     }
                 ]
@@ -610,6 +613,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncOrb) -> No
                 "payment_providers": [
                     {
                         "provider_type": "stripe",
+                        "default_shared_payment_token": "default_shared_payment_token",
                         "excluded_payment_method_types": ["string"],
                     }
                 ]
@@ -711,6 +715,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncOrb) -> No
                 "payment_providers": [
                     {
                         "provider_type": "stripe",
+                        "default_shared_payment_token": "default_shared_payment_token",
                         "excluded_payment_method_types": ["string"],
                     }
                 ]
@@ -1055,6 +1060,7 @@ async def test_method_update_by_external_id_with_all_params(self, async_client:
                 "payment_providers": [
                     {
                         "provider_type": "stripe",
+                        "default_shared_payment_token": "default_shared_payment_token",
                         "excluded_payment_method_types": ["string"],
                     }
                 ]