@naturalpay/sdk 0.11.0 → 0.13.0

package/src/resources/payment-requests.ts

@@ -11,7 +11,9 @@ import { path } from '../internal/utils/path';
  */
 export class PaymentRequests extends APIResource {
   /**
-   * Create a payment request and optionally send the link immediately.
+   * Create a payment request. Natural notifies the payer directly — email/phone
+   * payers receive the pay link, on-platform parties receive a dashboard deep-link,
+   * and agent payers receive only the in-app webhook.
    *
    * @example
    * ```ts
@@ -19,8 +21,6 @@ export class PaymentRequests extends APIResource {
    *   amount: 1,
    *   payer: { type: 'email', value: 'dev@stainless.com' },
    *   'Idempotency-Key': 'Idempotency-Key',
-   *   'X-Agent-ID': 'X-Agent-ID',
-   *   'X-Instance-ID': 'X-Instance-ID',
    * });
    * ```
    */
@@ -38,7 +38,11 @@ export class PaymentRequests extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
+        {
+          'Idempotency-Key': idempotencyKey,
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -49,18 +53,24 @@ export class PaymentRequests extends APIResource {
    *
    * @example
    * ```ts
-   * const paymentRequests = await client.paymentRequests.list({
-   *   'X-Agent-ID': 'X-Agent-ID',
-   *   'X-Instance-ID': 'X-Instance-ID',
-   * });
+   * const paymentRequests = await client.paymentRequests.list();
    * ```
    */
-  list(params: PaymentRequestListParams, options?: RequestOptions): APIPromise<PaymentRequestListResponse> {
-    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
+  list(
+    params: PaymentRequestListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PaymentRequestListResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
     return this._client.get('/payment-requests', {
       query,
       ...options,
-      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 
@@ -72,11 +82,7 @@ export class PaymentRequests extends APIResource {
    * ```ts
    * const response = await client.paymentRequests.decline(
    *   'prq_ecc2efdd09bd231a9ad9bd2aada37aa7',
-   *   {
-   *     'Idempotency-Key': 'Idempotency-Key',
-   *     'X-Agent-ID': 'X-Agent-ID',
-   *     'X-Instance-ID': 'X-Instance-ID',
-   *   },
+   *   { 'Idempotency-Key': 'Idempotency-Key' },
    * );
    * ```
    */
@@ -93,7 +99,11 @@ export class PaymentRequests extends APIResource {
     return this._client.post(path`/payment-requests/${paymentRequestID}/decline`, {
       ...options,
       headers: buildHeaders([
-        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
+        {
+          'Idempotency-Key': idempotencyKey,
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -112,8 +122,6 @@ export class PaymentRequests extends APIResource {
    *       walletId: 'wal_ecc2efdd09bd231a9ad9bd2aada37aa7',
    *     },
    *     'Idempotency-Key': 'Idempotency-Key',
-   *     'X-Agent-ID': 'X-Agent-ID',
-   *     'X-Instance-ID': 'X-Instance-ID',
    *   },
    * );
    * ```
@@ -133,7 +141,11 @@ export class PaymentRequests extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
+        {
+          'Idempotency-Key': idempotencyKey,
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -146,22 +158,24 @@ export class PaymentRequests extends APIResource {
    * ```ts
    * const paymentRequest = await client.paymentRequests.get(
    *   'prq_ecc2efdd09bd231a9ad9bd2aada37aa7',
-   *   {
-   *     'X-Agent-ID': 'X-Agent-ID',
-   *     'X-Instance-ID': 'X-Instance-ID',
-   *   },
    * );
    * ```
    */
   get(
     paymentRequestID: string,
-    params: PaymentRequestGetParams,
+    params: PaymentRequestGetParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<PaymentRequestGetResponse> {
-    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params;
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params ?? {};
     return this._client.get(path`/payment-requests/${paymentRequestID}`, {
       ...options,
-      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 
@@ -170,21 +184,25 @@ export class PaymentRequests extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.paymentRequests.listIncoming({
-   *   'X-Agent-ID': 'X-Agent-ID',
-   *   'X-Instance-ID': 'X-Instance-ID',
-   * });
+   * const response =
+   *   await client.paymentRequests.listIncoming();
    * ```
    */
   listIncoming(
-    params: PaymentRequestListIncomingParams,
+    params: PaymentRequestListIncomingParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<PaymentRequestListIncomingResponse> {
-    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
     return this._client.get('/payment-requests/incoming', {
       query,
       ...options,
-      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 }
@@ -1638,16 +1656,6 @@ export interface PaymentRequestCreateParams {
    */
   'Idempotency-Key': string;
 
-  /**
-   * Header param: Agent ID (agt_xxx) used for attribution and audit.
-   */
-  'X-Agent-ID': string;
-
-  /**
-   * Header param: Stable run, session, or conversation ID for agent observability.
-   */
-  'X-Instance-ID': string;
-
   /**
    * Body param: Currency code (currently only USD)
    */
@@ -1669,17 +1677,25 @@ export interface PaymentRequestCreateParams {
    */
   payerName?: string;
 
-  /**
-   * Body param: If provided, immediately deliver the payment link to the payer via
-   * the named channel
-   */
-  sendLink?: PaymentRequestCreateParams.SendLink;
-
   /**
    * Body param: Wallet that should receive the funds. Omit to use the requester
    * party's default wallet.
    */
   walletId?: string;
+
+  /**
+   * Header param: Conditionally required for payment-related API requests. Pass an
+   * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
+   * one active agent, which Natural defaults automatically.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Stable run, session, or conversation ID for agent observability.
+   * If omitted on a payment-related API request, Natural generates one after
+   * resolving the attribution agent.
+   */
+  'X-Instance-ID'?: string;
 }
 
 export namespace PaymentRequestCreateParams {
@@ -1718,39 +1734,32 @@ export namespace PaymentRequestCreateParams {
      */
     value: string;
   }
-
-  /**
-   * If provided, immediately deliver the payment link to the payer via the named
-   * channel
-   */
-  export interface SendLink {
-    /**
-     * Channel to deliver the payment link
-     */
-    channel: 'EMAIL' | 'SMS';
-  }
 }
 
 export interface PaymentRequestListParams {
   /**
-   * Header param: Agent ID (agt_xxx) used for attribution and audit.
+   * Query param: Pagination cursor returned by the previous response
    */
-  'X-Agent-ID': string;
+  cursor?: string;
 
   /**
-   * Header param: Stable run, session, or conversation ID for agent observability.
+   * Query param: Results per page (1-100)
    */
-  'X-Instance-ID': string;
+  limit?: number;
 
   /**
-   * Query param: Pagination cursor returned by the previous response
+   * Header param: Conditionally required for payment-related API requests. Pass an
+   * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
+   * one active agent, which Natural defaults automatically.
    */
-  cursor?: string;
+  'X-Agent-ID'?: string;
 
   /**
-   * Query param: Results per page (1-100)
+   * Header param: Stable run, session, or conversation ID for agent observability.
+   * If omitted on a payment-related API request, Natural generates one after
+   * resolving the attribution agent.
    */
-  limit?: number;
+  'X-Instance-ID'?: string;
 }
 
 export interface PaymentRequestDeclineParams {
@@ -1761,14 +1770,18 @@ export interface PaymentRequestDeclineParams {
   'Idempotency-Key': string;
 
   /**
-   * Agent ID (agt_xxx) used for attribution and audit.
+   * Conditionally required for payment-related API requests. Pass an agent ID
+   * (agt_xxx) for attribution, or omit it only when your party has exactly one
+   * active agent, which Natural defaults automatically.
    */
-  'X-Agent-ID': string;
+  'X-Agent-ID'?: string;
 
   /**
-   * Stable run, session, or conversation ID for agent observability.
+   * Stable run, session, or conversation ID for agent observability. If omitted on a
+   * payment-related API request, Natural generates one after resolving the
+   * attribution agent.
    */
-  'X-Instance-ID': string;
+  'X-Instance-ID'?: string;
 }
 
 export interface PaymentRequestFulfillParams {
@@ -1784,14 +1797,18 @@ export interface PaymentRequestFulfillParams {
   'Idempotency-Key': string;
 
   /**
-   * Header param: Agent ID (agt_xxx) used for attribution and audit.
+   * Header param: Conditionally required for payment-related API requests. Pass an
+   * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
+   * one active agent, which Natural defaults automatically.
    */
-  'X-Agent-ID': string;
+  'X-Agent-ID'?: string;
 
   /**
    * Header param: Stable run, session, or conversation ID for agent observability.
+   * If omitted on a payment-related API request, Natural generates one after
+   * resolving the attribution agent.
    */
-  'X-Instance-ID': string;
+  'X-Instance-ID'?: string;
 }
 
 export namespace PaymentRequestFulfillParams {
@@ -1810,36 +1827,44 @@ export namespace PaymentRequestFulfillParams {
 
 export interface PaymentRequestGetParams {
   /**
-   * Agent ID (agt_xxx) used for attribution and audit.
+   * Conditionally required for payment-related API requests. Pass an agent ID
+   * (agt_xxx) for attribution, or omit it only when your party has exactly one
+   * active agent, which Natural defaults automatically.
    */
-  'X-Agent-ID': string;
+  'X-Agent-ID'?: string;
 
   /**
-   * Stable run, session, or conversation ID for agent observability.
+   * Stable run, session, or conversation ID for agent observability. If omitted on a
+   * payment-related API request, Natural generates one after resolving the
+   * attribution agent.
    */
-  'X-Instance-ID': string;
+  'X-Instance-ID'?: string;
 }
 
 export interface PaymentRequestListIncomingParams {
   /**
-   * Header param: Agent ID (agt_xxx) used for attribution and audit.
+   * Query param: Pagination cursor returned by the previous response
    */
-  'X-Agent-ID': string;
+  cursor?: string;
 
   /**
-   * Header param: Stable run, session, or conversation ID for agent observability.
+   * Query param: Results per page (1-100)
    */
-  'X-Instance-ID': string;
+  limit?: number;
 
   /**
-   * Query param: Pagination cursor returned by the previous response
+   * Header param: Conditionally required for payment-related API requests. Pass an
+   * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
+   * one active agent, which Natural defaults automatically.
    */
-  cursor?: string;
+  'X-Agent-ID'?: string;
 
   /**
-   * Query param: Results per page (1-100)
+   * Header param: Stable run, session, or conversation ID for agent observability.
+   * If omitted on a payment-related API request, Natural generates one after
+   * resolving the attribution agent.
    */
-  limit?: number;
+  'X-Instance-ID'?: string;
 }
 
 export declare namespace PaymentRequests {

package/src/resources/payments.ts

@@ -22,8 +22,6 @@ export class Payments extends APIResource {
    *     value: 'dev@stainless.com',
    *   },
    *   'Idempotency-Key': 'Idempotency-Key',
-   *   'X-Agent-ID': 'X-Agent-ID',
-   *   'X-Instance-ID': 'X-Instance-ID',
    * });
    * ```
    */
@@ -38,7 +36,11 @@ export class Payments extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
+        {
+          'Idempotency-Key': idempotencyKey,
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -49,18 +51,24 @@ export class Payments extends APIResource {
    *
    * @example
    * ```ts
-   * const payments = await client.payments.list({
-   *   'X-Agent-ID': 'X-Agent-ID',
-   *   'X-Instance-ID': 'X-Instance-ID',
-   * });
+   * const payments = await client.payments.list();
    * ```
    */
-  list(params: PaymentListParams, options?: RequestOptions): APIPromise<PaymentListResponse> {
-    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
+  list(
+    params: PaymentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PaymentListResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
     return this._client.get('/payments', {
       query,
       ...options,
-      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 
@@ -71,11 +79,7 @@ export class Payments extends APIResource {
    * ```ts
    * const response = await client.payments.cancel(
    *   'pay_ecc2efdd09bd231a9ad9bd2aada37aa7',
-   *   {
-   *     'Idempotency-Key': 'Idempotency-Key',
-   *     'X-Agent-ID': 'X-Agent-ID',
-   *     'X-Instance-ID': 'X-Instance-ID',
-   *   },
+   *   { 'Idempotency-Key': 'Idempotency-Key' },
    * );
    * ```
    */
@@ -92,7 +96,11 @@ export class Payments extends APIResource {
     return this._client.post(path`/payments/${paymentID}/cancel`, {
       ...options,
       headers: buildHeaders([
-        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
+        {
+          'Idempotency-Key': idempotencyKey,
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
         options?.headers,
       ]),
     });
@@ -105,19 +113,25 @@ export class Payments extends APIResource {
    * ```ts
    * const payment = await client.payments.get(
    *   'pay_ecc2efdd09bd231a9ad9bd2aada37aa7',
-   *   {
-   *     'X-Agent-ID': 'X-Agent-ID',
-   *     'X-Instance-ID': 'X-Instance-ID',
-   *   },
    * );
    * ```
    */
-  get(paymentID: string, params: PaymentGetParams, options?: RequestOptions): APIPromise<PaymentGetResponse> {
-    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
+  get(
+    paymentID: string,
+    params: PaymentGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PaymentGetResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
     return this._client.get(path`/payments/${paymentID}`, {
       query,
       ...options,
-      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 }
@@ -1046,16 +1060,6 @@ export interface PaymentCreateParams {
    */
   'Idempotency-Key': string;
 
-  /**
-   * Header param: Agent ID (agt_xxx) used for attribution and audit.
-   */
-  'X-Agent-ID': string;
-
-  /**
-   * Header param: Stable run, session, or conversation ID for agent observability.
-   */
-  'X-Instance-ID': string;
-
   /**
    * Body param: Currency code
    */
@@ -1071,6 +1075,20 @@ export interface PaymentCreateParams {
    * Body param: Payment description. Maximum 500 characters.
    */
   description?: string;
+
+  /**
+   * Header param: Conditionally required for payment-related API requests. Pass an
+   * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
+   * one active agent, which Natural defaults automatically.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Stable run, session, or conversation ID for agent observability.
+   * If omitted on a payment-related API request, Natural generates one after
+   * resolving the attribution agent.
+   */
+  'X-Instance-ID'?: string;
 }
 
 export namespace PaymentCreateParams {
@@ -1112,16 +1130,6 @@ export namespace PaymentCreateParams {
 }
 
 export interface PaymentListParams {
-  /**
-   * Header param: Agent ID (agt_xxx) used for attribution and audit.
-   */
-  'X-Agent-ID': string;
-
-  /**
-   * Header param: Stable run, session, or conversation ID for agent observability.
-   */
-  'X-Instance-ID': string;
-
   /**
    * Query param: Pagination cursor from previous response
    */
@@ -1136,6 +1144,20 @@ export interface PaymentListParams {
    * Query param: Party ID for delegated payment lookup
    */
   partyId?: string;
+
+  /**
+   * Header param: Conditionally required for payment-related API requests. Pass an
+   * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
+   * one active agent, which Natural defaults automatically.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Stable run, session, or conversation ID for agent observability.
+   * If omitted on a payment-related API request, Natural generates one after
+   * resolving the attribution agent.
+   */
+  'X-Instance-ID'?: string;
 }
 
 export interface PaymentCancelParams {
@@ -1146,31 +1168,39 @@ export interface PaymentCancelParams {
   'Idempotency-Key': string;
 
   /**
-   * Agent ID (agt_xxx) used for attribution and audit.
+   * Conditionally required for payment-related API requests. Pass an agent ID
+   * (agt_xxx) for attribution, or omit it only when your party has exactly one
+   * active agent, which Natural defaults automatically.
    */
-  'X-Agent-ID': string;
+  'X-Agent-ID'?: string;
 
   /**
-   * Stable run, session, or conversation ID for agent observability.
+   * Stable run, session, or conversation ID for agent observability. If omitted on a
+   * payment-related API request, Natural generates one after resolving the
+   * attribution agent.
    */
-  'X-Instance-ID': string;
+  'X-Instance-ID'?: string;
 }
 
 export interface PaymentGetParams {
   /**
-   * Header param: Agent ID (agt_xxx) used for attribution and audit.
+   * Query param: Party ID for delegated payment lookup
    */
-  'X-Agent-ID': string;
+  partyId?: string;
 
   /**
-   * Header param: Stable run, session, or conversation ID for agent observability.
+   * Header param: Conditionally required for payment-related API requests. Pass an
+   * agent ID (agt_xxx) for attribution, or omit it only when your party has exactly
+   * one active agent, which Natural defaults automatically.
    */
-  'X-Instance-ID': string;
+  'X-Agent-ID'?: string;
 
   /**
-   * Query param: Party ID for delegated payment lookup
+   * Header param: Stable run, session, or conversation ID for agent observability.
+   * If omitted on a payment-related API request, Natural generates one after
+   * resolving the attribution agent.
    */
-  partyId?: string;
+  'X-Instance-ID'?: string;
 }
 
 export declare namespace Payments {