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

@@ -370,7 +370,7 @@ Methods:
 - <code title="post /invoices/summary/{invoice_id}/issue">client.invoices.<a href="./src/resources/invoices.ts">issueSummary</a>(invoiceId, { ...params }) -> InvoiceIssueSummaryResponse</code>
 - <code title="get /invoices/summary">client.invoices.<a href="./src/resources/invoices.ts">listSummary</a>({ ...params }) -> InvoiceListSummaryResponsesPage</code>
 - <code title="post /invoices/{invoice_id}/mark_paid">client.invoices.<a href="./src/resources/invoices.ts">markPaid</a>(invoiceId, { ...params }) -> Invoice</code>
-- <code title="post /invoices/{invoice_id}/pay">client.invoices.<a href="./src/resources/invoices.ts">pay</a>(invoiceId) -> Invoice</code>
+- <code title="post /invoices/{invoice_id}/pay">client.invoices.<a href="./src/resources/invoices.ts">pay</a>(invoiceId, { ...params }) -> Invoice</code>
 - <code title="post /invoices/{invoice_id}/void">client.invoices.<a href="./src/resources/invoices.ts">void</a>(invoiceId) -> Invoice</code>
 
 # Items

src/index.ts

@@ -44,6 +44,7 @@ import {
   InvoiceListSummaryResponse,
   InvoiceListSummaryResponsesPage,
   InvoiceMarkPaidParams,
+  InvoicePayParams,
   InvoiceUpdateParams,
   Invoices,
 } from './resources/invoices';
@@ -614,6 +615,7 @@ export declare namespace Orb {
     type InvoiceIssueSummaryParams as InvoiceIssueSummaryParams,
     type InvoiceListSummaryParams as InvoiceListSummaryParams,
     type InvoiceMarkPaidParams as InvoiceMarkPaidParams,
+    type InvoicePayParams as InvoicePayParams,
   };
 
   export {

src/resources/customers/customers.ts

@@ -543,6 +543,13 @@ export namespace Customer {
        */
       provider_type: 'stripe';
 
+      /**
+       * 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.
+       */
+      default_shared_payment_token?: string | null;
+
       /**
        * List of Stripe payment method types to exclude for this customer. Excluded
        * payment methods will not be available for the customer to select during payment,
@@ -902,6 +909,13 @@ export namespace CustomerCreateParams {
        */
       provider_type: 'stripe';
 
+      /**
+       * 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.
+       */
+      default_shared_payment_token?: string | null;
+
       /**
        * List of Stripe payment method types to exclude for this customer. Excluded
        * payment methods will not be available for the customer to select during payment,
@@ -1230,6 +1244,13 @@ export namespace CustomerUpdateParams {
        */
       provider_type: 'stripe';
 
+      /**
+       * 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.
+       */
+      default_shared_payment_token?: string | null;
+
       /**
        * List of Stripe payment method types to exclude for this customer. Excluded
        * payment methods will not be available for the customer to select during payment,
@@ -1568,6 +1589,13 @@ export namespace CustomerUpdateByExternalIDParams {
        */
       provider_type: 'stripe';
 
+      /**
+       * 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.
+       */
+      default_shared_payment_token?: string | null;
+
       /**
        * List of Stripe payment method types to exclude for this customer. Excluded
        * payment methods will not be available for the customer to select during payment,

src/resources/index.ts

@@ -96,6 +96,7 @@ export {
   type InvoiceIssueSummaryParams,
   type InvoiceListSummaryParams,
   type InvoiceMarkPaidParams,
+  type InvoicePayParams,
 } from './invoices';
 export {
   ItemsPage,

src/resources/invoices.ts

@@ -214,11 +214,17 @@ export class Invoices extends APIResource {
   }
 
   /**
-   * 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".
    */
-  pay(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice> {
-    return this._client.post(`/invoices/${invoiceId}/pay`, options);
+  pay(
+    invoiceId: string,
+    body: InvoicePayParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.Invoice> {
+    return this._client.post(`/invoices/${invoiceId}/pay`, { body, ...options });
   }
 
   /**
@@ -2002,6 +2008,13 @@ export interface InvoiceMarkPaidParams {
   notes?: string | null;
 }
 
+export interface InvoicePayParams {
+  /**
+   * The ID of a shared payment token granted by an agent to use for this payment.
+   */
+  shared_payment_token_id: string;
+}
+
 Invoices.InvoiceListSummaryResponsesPage = InvoiceListSummaryResponsesPage;
 
 export declare namespace Invoices {
@@ -2018,6 +2031,7 @@ export declare namespace Invoices {
     type InvoiceIssueSummaryParams as InvoiceIssueSummaryParams,
     type InvoiceListSummaryParams as InvoiceListSummaryParams,
     type InvoiceMarkPaidParams as InvoiceMarkPaidParams,
+    type InvoicePayParams as InvoicePayParams,
   };
 }
 

tests/api-resources/customers/customers.test.ts

@@ -47,7 +47,13 @@ describe('resource customers', () => {
       hierarchy: { child_customer_ids: ['string'], parent_customer_id: 'parent_customer_id' },
       metadata: { foo: 'string' },
       payment_configuration: {
-        payment_providers: [{ provider_type: 'stripe', excluded_payment_method_types: ['string'] }],
+        payment_providers: [
+          {
+            provider_type: 'stripe',
+            default_shared_payment_token: 'default_shared_payment_token',
+            excluded_payment_method_types: ['string'],
+          },
+        ],
       },
       payment_provider: 'quickbooks',
       payment_provider_id: 'payment_provider_id',

tests/api-resources/invoices.test.ts

@@ -300,8 +300,10 @@ describe('resource invoices', () => {
     });
   });
 
-  test('pay', async () => {
-    const responsePromise = client.invoices.pay('invoice_id');
+  test('pay: only required params', async () => {
+    const responsePromise = client.invoices.pay('invoice_id', {
+      shared_payment_token_id: 'shared_payment_token_id',
+    });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -311,11 +313,10 @@ describe('resource invoices', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  test('pay: request options instead of params are passed correctly', async () => {
-    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
-    await expect(client.invoices.pay('invoice_id', { path: '/_stainless_unknown_path' })).rejects.toThrow(
-      Orb.NotFoundError,
-    );
+  test('pay: required and optional params', async () => {
+    const response = await client.invoices.pay('invoice_id', {
+      shared_payment_token_id: 'shared_payment_token_id',
+    });
   });
 
   test('void', async () => {