@naturalpay/sdk 0.10.0 → 0.12.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,6 +21,8 @@ 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',
    * });
    * ```
    */
@@ -36,11 +40,7 @@ export class PaymentRequests extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        {
-          'Idempotency-Key': idempotencyKey,
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
+        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
         options?.headers,
       ]),
     });
@@ -51,24 +51,18 @@ export class PaymentRequests extends APIResource {
    *
    * @example
    * ```ts
-   * const paymentRequests = await client.paymentRequests.list();
+   * const paymentRequests = await client.paymentRequests.list({
+   *   'X-Agent-ID': 'X-Agent-ID',
+   *   'X-Instance-ID': 'X-Instance-ID',
+   * });
    * ```
    */
-  list(
-    params: PaymentRequestListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<PaymentRequestListResponse> {
-    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+  list(params: PaymentRequestListParams, 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([
-        {
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
-        options?.headers,
-      ]),
+      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
     });
   }
 
@@ -80,7 +74,11 @@ export class PaymentRequests extends APIResource {
    * ```ts
    * const response = await client.paymentRequests.decline(
    *   'prq_ecc2efdd09bd231a9ad9bd2aada37aa7',
-   *   { 'Idempotency-Key': 'Idempotency-Key' },
+   *   {
+   *     'Idempotency-Key': 'Idempotency-Key',
+   *     'X-Agent-ID': 'X-Agent-ID',
+   *     'X-Instance-ID': 'X-Instance-ID',
+   *   },
    * );
    * ```
    */
@@ -97,11 +95,7 @@ export class PaymentRequests extends APIResource {
     return this._client.post(path`/payment-requests/${paymentRequestID}/decline`, {
       ...options,
       headers: buildHeaders([
-        {
-          'Idempotency-Key': idempotencyKey,
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
+        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
         options?.headers,
       ]),
     });
@@ -120,6 +114,8 @@ export class PaymentRequests extends APIResource {
    *       walletId: 'wal_ecc2efdd09bd231a9ad9bd2aada37aa7',
    *     },
    *     'Idempotency-Key': 'Idempotency-Key',
+   *     'X-Agent-ID': 'X-Agent-ID',
+   *     'X-Instance-ID': 'X-Instance-ID',
    *   },
    * );
    * ```
@@ -139,11 +135,7 @@ export class PaymentRequests extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        {
-          'Idempotency-Key': idempotencyKey,
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
+        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
         options?.headers,
       ]),
     });
@@ -156,24 +148,22 @@ 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 | null | undefined = {},
+    params: PaymentRequestGetParams,
     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([
-        {
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
-        options?.headers,
-      ]),
+      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
     });
   }
 
@@ -182,25 +172,21 @@ export class PaymentRequests extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.paymentRequests.listIncoming();
+   * const response = await client.paymentRequests.listIncoming({
+   *   'X-Agent-ID': 'X-Agent-ID',
+   *   'X-Instance-ID': 'X-Instance-ID',
+   * });
    * ```
    */
   listIncoming(
-    params: PaymentRequestListIncomingParams | null | undefined = {},
+    params: PaymentRequestListIncomingParams,
     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([
-        {
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
-        options?.headers,
-      ]),
+      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
     });
   }
 }
@@ -1654,6 +1640,16 @@ 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)
    */
@@ -1675,28 +1671,11 @@ 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: Agent ID (agt_xxx) identifying which agent is making the request.
-   */
-  'X-Agent-ID'?: string;
-
-  /**
-   * Header param: Required when X-Agent-ID is present. Session or conversation ID
-   * for agent observability.
-   */
-  'X-Instance-ID'?: string;
 }
 
 export namespace PaymentRequestCreateParams {
@@ -1735,40 +1714,28 @@ 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 {
   /**
-   * Query param: Pagination cursor returned by the previous response
+   * Header param: Agent ID (agt_xxx) used for attribution and audit.
    */
-  cursor?: string;
+  'X-Agent-ID': string;
 
   /**
-   * Query param: Results per page (1-100)
+   * Header param: Stable run, session, or conversation ID for agent observability.
    */
-  limit?: number;
+  'X-Instance-ID': string;
 
   /**
-   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   * Query param: Pagination cursor returned by the previous response
    */
-  'X-Agent-ID'?: string;
+  cursor?: string;
 
   /**
-   * Header param: Required when X-Agent-ID is present. Session or conversation ID
-   * for agent observability.
+   * Query param: Results per page (1-100)
    */
-  'X-Instance-ID'?: string;
+  limit?: number;
 }
 
 export interface PaymentRequestDeclineParams {
@@ -1779,15 +1746,14 @@ export interface PaymentRequestDeclineParams {
   'Idempotency-Key': string;
 
   /**
-   * Agent ID (agt_xxx) identifying which agent is making the request.
+   * Agent ID (agt_xxx) used for attribution and audit.
    */
-  'X-Agent-ID'?: string;
+  'X-Agent-ID': string;
 
   /**
-   * Required when X-Agent-ID is present. Session or conversation ID for agent
-   * observability.
+   * Stable run, session, or conversation ID for agent observability.
    */
-  'X-Instance-ID'?: string;
+  'X-Instance-ID': string;
 }
 
 export interface PaymentRequestFulfillParams {
@@ -1803,15 +1769,14 @@ export interface PaymentRequestFulfillParams {
   'Idempotency-Key': string;
 
   /**
-   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   * Header param: Agent ID (agt_xxx) used for attribution and audit.
    */
-  'X-Agent-ID'?: string;
+  'X-Agent-ID': string;
 
   /**
-   * Header param: Required when X-Agent-ID is present. Session or conversation ID
-   * for agent observability.
+   * Header param: Stable run, session, or conversation ID for agent observability.
    */
-  'X-Instance-ID'?: string;
+  'X-Instance-ID': string;
 }
 
 export namespace PaymentRequestFulfillParams {
@@ -1830,38 +1795,36 @@ export namespace PaymentRequestFulfillParams {
 
 export interface PaymentRequestGetParams {
   /**
-   * Agent ID (agt_xxx) identifying which agent is making the request.
+   * Agent ID (agt_xxx) used for attribution and audit.
    */
-  'X-Agent-ID'?: string;
+  'X-Agent-ID': string;
 
   /**
-   * Required when X-Agent-ID is present. Session or conversation ID for agent
-   * observability.
+   * Stable run, session, or conversation ID for agent observability.
    */
-  'X-Instance-ID'?: string;
+  'X-Instance-ID': string;
 }
 
 export interface PaymentRequestListIncomingParams {
   /**
-   * Query param: Pagination cursor returned by the previous response
+   * Header param: Agent ID (agt_xxx) used for attribution and audit.
    */
-  cursor?: string;
+  'X-Agent-ID': string;
 
   /**
-   * Query param: Results per page (1-100)
+   * Header param: Stable run, session, or conversation ID for agent observability.
    */
-  limit?: number;
+  'X-Instance-ID': string;
 
   /**
-   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   * Query param: Pagination cursor returned by the previous response
    */
-  'X-Agent-ID'?: string;
+  cursor?: string;
 
   /**
-   * Header param: Required when X-Agent-ID is present. Session or conversation ID
-   * for agent observability.
+   * Query param: Results per page (1-100)
    */
-  'X-Instance-ID'?: string;
+  limit?: number;
 }
 
 export declare namespace PaymentRequests {

package/src/resources/payments.ts

@@ -22,6 +22,8 @@ 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',
    * });
    * ```
    */
@@ -36,11 +38,7 @@ export class Payments extends APIResource {
       body,
       ...options,
       headers: buildHeaders([
-        {
-          'Idempotency-Key': idempotencyKey,
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
+        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
         options?.headers,
       ]),
     });
@@ -51,24 +49,18 @@ export class Payments extends APIResource {
    *
    * @example
    * ```ts
-   * const payments = await client.payments.list();
+   * const payments = await client.payments.list({
+   *   'X-Agent-ID': 'X-Agent-ID',
+   *   'X-Instance-ID': 'X-Instance-ID',
+   * });
    * ```
    */
-  list(
-    params: PaymentListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<PaymentListResponse> {
-    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+  list(params: PaymentListParams, options?: RequestOptions): APIPromise<PaymentListResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params;
     return this._client.get('/payments', {
       query,
       ...options,
-      headers: buildHeaders([
-        {
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
-        options?.headers,
-      ]),
+      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
     });
   }
 
@@ -79,7 +71,11 @@ export class Payments extends APIResource {
    * ```ts
    * const response = await client.payments.cancel(
    *   'pay_ecc2efdd09bd231a9ad9bd2aada37aa7',
-   *   { 'Idempotency-Key': 'Idempotency-Key' },
+   *   {
+   *     'Idempotency-Key': 'Idempotency-Key',
+   *     'X-Agent-ID': 'X-Agent-ID',
+   *     'X-Instance-ID': 'X-Instance-ID',
+   *   },
    * );
    * ```
    */
@@ -96,11 +92,7 @@ export class Payments extends APIResource {
     return this._client.post(path`/payments/${paymentID}/cancel`, {
       ...options,
       headers: buildHeaders([
-        {
-          'Idempotency-Key': idempotencyKey,
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
+        { 'Idempotency-Key': idempotencyKey, 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID },
         options?.headers,
       ]),
     });
@@ -113,25 +105,19 @@ 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 | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<PaymentGetResponse> {
-    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+  get(paymentID: string, params: PaymentGetParams, 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([
-        {
-          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
-          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
-        },
-        options?.headers,
-      ]),
+      headers: buildHeaders([{ 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID }, options?.headers]),
     });
   }
 }
@@ -1060,6 +1046,16 @@ 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
    */
@@ -1075,17 +1071,6 @@ export interface PaymentCreateParams {
    * Body param: Payment description. Maximum 500 characters.
    */
   description?: string;
-
-  /**
-   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
-   */
-  'X-Agent-ID'?: string;
-
-  /**
-   * Header param: Required when X-Agent-ID is present. Session or conversation ID
-   * for agent observability.
-   */
-  'X-Instance-ID'?: string;
 }
 
 export namespace PaymentCreateParams {
@@ -1128,30 +1113,29 @@ export namespace PaymentCreateParams {
 
 export interface PaymentListParams {
   /**
-   * Query param: Pagination cursor from previous response
+   * Header param: Agent ID (agt_xxx) used for attribution and audit.
    */
-  cursor?: string;
+  'X-Agent-ID': string;
 
   /**
-   * Query param: Results per page
+   * Header param: Stable run, session, or conversation ID for agent observability.
    */
-  limit?: number;
+  'X-Instance-ID': string;
 
   /**
-   * Query param: Party ID for delegated payment lookup
+   * Query param: Pagination cursor from previous response
    */
-  partyId?: string;
+  cursor?: string;
 
   /**
-   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   * Query param: Results per page
    */
-  'X-Agent-ID'?: string;
+  limit?: number;
 
   /**
-   * Header param: Required when X-Agent-ID is present. Session or conversation ID
-   * for agent observability.
+   * Query param: Party ID for delegated payment lookup
    */
-  'X-Instance-ID'?: string;
+  partyId?: string;
 }
 
 export interface PaymentCancelParams {
@@ -1162,33 +1146,31 @@ export interface PaymentCancelParams {
   'Idempotency-Key': string;
 
   /**
-   * Agent ID (agt_xxx) identifying which agent is making the request.
+   * Agent ID (agt_xxx) used for attribution and audit.
    */
-  'X-Agent-ID'?: string;
+  'X-Agent-ID': string;
 
   /**
-   * Required when X-Agent-ID is present. Session or conversation ID for agent
-   * observability.
+   * Stable run, session, or conversation ID for agent observability.
    */
-  'X-Instance-ID'?: string;
+  'X-Instance-ID': string;
 }
 
 export interface PaymentGetParams {
   /**
-   * Query param: Party ID for delegated payment lookup
+   * Header param: Agent ID (agt_xxx) used for attribution and audit.
    */
-  partyId?: string;
+  'X-Agent-ID': string;
 
   /**
-   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   * Header param: Stable run, session, or conversation ID for agent observability.
    */
-  'X-Agent-ID'?: string;
+  'X-Instance-ID': string;
 
   /**
-   * Header param: Required when X-Agent-ID is present. Session or conversation ID
-   * for agent observability.
+   * Query param: Party ID for delegated payment lookup
    */
-  'X-Instance-ID'?: string;
+  partyId?: string;
 }
 
 export declare namespace Payments {