@naturalpay/sdk 0.2.0 → 0.3.0

package/src/resources/wallet.ts

@@ -0,0 +1,668 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Wallet balance, deposits, withdrawals, and external accounts
+ */
+export class Wallet extends APIResource {
+  /**
+   * List wallets for the authenticated party, including balance and ACH deposit
+   * instructions when available. Currently returns at most one wallet.
+   *
+   * @example
+   * ```ts
+   * const wallets = await client.wallet.list();
+   * ```
+   */
+  list(
+    params: WalletListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WalletListResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params ?? {};
+    return this._client.get('/wallets', {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Get a wallet visible to the authenticated party, including balance and ACH
+   * deposit instructions when available.
+   *
+   * @example
+   * ```ts
+   * const wallet = await client.wallet.get(
+   *   'wal_ecc2efdd09bd231a9ad9bd2aada37aa7',
+   * );
+   * ```
+   */
+  get(
+    walletID: string,
+    params: WalletGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WalletGetResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params ?? {};
+    return this._client.get(path`/wallets/${walletID}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Initiate a wallet deposit.
+   *
+   * @example
+   * ```ts
+   * const response = await client.wallet.initiateDeposit({
+   *   amount: 1,
+   *   externalAccountId: 'ea_ecc2efdd09bd231a9ad9bd2aada37aa7',
+   *   'Idempotency-Key': 'Idempotency-Key',
+   * });
+   * ```
+   */
+  initiateDeposit(
+    params: WalletInitiateDepositParams,
+    options?: RequestOptions,
+  ): APIPromise<WalletInitiateDepositResponse> {
+    const {
+      'Idempotency-Key': idempotencyKey,
+      'X-Agent-ID': xAgentID,
+      'X-Instance-ID': xInstanceID,
+      ...body
+    } = params;
+    return this._client.post('/wallet/deposit', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          'Idempotency-Key': idempotencyKey,
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Initiate a wallet withdrawal.
+   *
+   * @example
+   * ```ts
+   * const response = await client.wallet.initiateWithdrawal({
+   *   amount: 1,
+   *   externalAccountId: 'ea_ecc2efdd09bd231a9ad9bd2aada37aa7',
+   *   'Idempotency-Key': 'Idempotency-Key',
+   * });
+   * ```
+   */
+  initiateWithdrawal(
+    params: WalletInitiateWithdrawalParams,
+    options?: RequestOptions,
+  ): APIPromise<WalletInitiateWithdrawalResponse> {
+    const {
+      'Idempotency-Key': idempotencyKey,
+      'X-Agent-ID': xAgentID,
+      'X-Instance-ID': xInstanceID,
+      ...body
+    } = params;
+    return this._client.post('/wallet/withdraw', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          'Idempotency-Key': idempotencyKey,
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface WalletListResponse {
+  data: Array<WalletListResponse.Data>;
+
+  meta: WalletListResponse.Meta;
+}
+
+export namespace WalletListResponse {
+  export interface Data {
+    /**
+     * Resource ID
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource relationships
+     */
+    relationships: Data.Relationships;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * Wallet ledger balance
+       */
+      balance: Attributes.Balance;
+
+      /**
+       * Claimable payment totals
+       */
+      claims: Attributes.Claims;
+
+      /**
+       * ACH deposit instructions for this wallet, when available
+       */
+      depositInstructions: Attributes.DepositInstructions | null;
+
+      /**
+       * Wallet readiness status
+       */
+      status: 'active';
+    }
+
+    export namespace Attributes {
+      /**
+       * Wallet ledger balance
+       */
+      export interface Balance {
+        /**
+         * Amount currently available to spend or withdraw (cents)
+         */
+        available: number;
+
+        /**
+         * Currency code
+         */
+        currency: 'USD';
+
+        /**
+         * Total wallet ledger balance (cents)
+         */
+        total: number;
+      }
+
+      /**
+       * Claimable payment totals
+       */
+      export interface Claims {
+        /**
+         * Total unclaimed product-payment amount (cents)
+         */
+        amount: number;
+
+        /**
+         * Number of unclaimed product payments
+         */
+        count: number;
+      }
+
+      /**
+       * ACH deposit instructions for this wallet, when available
+       */
+      export interface DepositInstructions {
+        /**
+         * Account number for ACH deposits
+         */
+        accountNumber: string;
+
+        /**
+         * Name of the receiving bank
+         */
+        bankName: string;
+
+        /**
+         * Bank routing number for ACH deposits
+         */
+        routingNumber: string;
+      }
+    }
+
+    /**
+     * Resource relationships
+     */
+    export interface Relationships {
+      /**
+       * Party that owns the wallet
+       */
+      party: Relationships.Party;
+    }
+
+    export namespace Relationships {
+      /**
+       * Party that owns the wallet
+       */
+      export interface Party {
+        /**
+         * Related resource identifier
+         */
+        data: Party.Data;
+      }
+
+      export namespace Party {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: string;
+        }
+      }
+    }
+  }
+
+  export interface Meta {
+    pagination: Meta.Pagination;
+  }
+
+  export namespace Meta {
+    export interface Pagination {
+      hasMore: boolean;
+
+      nextCursor: string | null;
+    }
+  }
+}
+
+export interface WalletGetResponse {
+  data: WalletGetResponse.Data;
+}
+
+export namespace WalletGetResponse {
+  export interface Data {
+    /**
+     * Resource ID
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource relationships
+     */
+    relationships: Data.Relationships;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * Wallet ledger balance
+       */
+      balance: Attributes.Balance;
+
+      /**
+       * Claimable payment totals
+       */
+      claims: Attributes.Claims;
+
+      /**
+       * ACH deposit instructions for this wallet, when available
+       */
+      depositInstructions: Attributes.DepositInstructions | null;
+
+      /**
+       * Wallet readiness status
+       */
+      status: 'active';
+    }
+
+    export namespace Attributes {
+      /**
+       * Wallet ledger balance
+       */
+      export interface Balance {
+        /**
+         * Amount currently available to spend or withdraw (cents)
+         */
+        available: number;
+
+        /**
+         * Currency code
+         */
+        currency: 'USD';
+
+        /**
+         * Total wallet ledger balance (cents)
+         */
+        total: number;
+      }
+
+      /**
+       * Claimable payment totals
+       */
+      export interface Claims {
+        /**
+         * Total unclaimed product-payment amount (cents)
+         */
+        amount: number;
+
+        /**
+         * Number of unclaimed product payments
+         */
+        count: number;
+      }
+
+      /**
+       * ACH deposit instructions for this wallet, when available
+       */
+      export interface DepositInstructions {
+        /**
+         * Account number for ACH deposits
+         */
+        accountNumber: string;
+
+        /**
+         * Name of the receiving bank
+         */
+        bankName: string;
+
+        /**
+         * Bank routing number for ACH deposits
+         */
+        routingNumber: string;
+      }
+    }
+
+    /**
+     * Resource relationships
+     */
+    export interface Relationships {
+      /**
+       * Party that owns the wallet
+       */
+      party: Relationships.Party;
+    }
+
+    export namespace Relationships {
+      /**
+       * Party that owns the wallet
+       */
+      export interface Party {
+        /**
+         * Related resource identifier
+         */
+        data: Party.Data;
+      }
+
+      export namespace Party {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: string;
+        }
+      }
+    }
+  }
+}
+
+export interface WalletInitiateDepositResponse {
+  data: WalletInitiateDepositResponse.Data;
+}
+
+export namespace WalletInitiateDepositResponse {
+  export interface Data {
+    /**
+     * Transaction handle (txn_xxx). Empty when the operation failed before a
+     * transaction was created.
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * Amount in cents
+       */
+      amount: number;
+
+      /**
+       * Currency code
+       */
+      currency: string;
+
+      /**
+       * Estimated settlement time
+       */
+      estimatedSettlement: string | null;
+
+      /**
+       * Operation status
+       */
+      status: 'PROCESSING' | 'IN_REVIEW' | 'AWAITING_APPROVAL' | 'COMPLETED' | 'FAILED' | 'RETURNED';
+    }
+  }
+}
+
+export interface WalletInitiateWithdrawalResponse {
+  data: WalletInitiateWithdrawalResponse.Data;
+}
+
+export namespace WalletInitiateWithdrawalResponse {
+  export interface Data {
+    /**
+     * Transaction handle (txn_xxx). Empty when the operation failed before a
+     * transaction was created.
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * Amount in cents
+       */
+      amount: number;
+
+      /**
+       * Currency code
+       */
+      currency: string;
+
+      /**
+       * Estimated settlement time
+       */
+      estimatedSettlement: string | null;
+
+      /**
+       * Operation status
+       */
+      status: 'PROCESSING' | 'IN_REVIEW' | 'AWAITING_APPROVAL' | 'COMPLETED' | 'FAILED' | 'RETURNED';
+    }
+  }
+}
+
+export interface WalletListParams {
+  /**
+   * Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Required when X-Agent-ID is present. Session or conversation ID for agent
+   * observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export interface WalletGetParams {
+  /**
+   * Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Required when X-Agent-ID is present. Session or conversation ID for agent
+   * observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export interface WalletInitiateDepositParams {
+  /**
+   * Body param: Amount in cents
+   */
+  amount: number;
+
+  /**
+   * Body param: External account ID (ea\_\*)
+   */
+  externalAccountId: string;
+
+  /**
+   * Header param: Unique key for idempotent request handling. If a request with the
+   * same key was already processed, the original response is returned.
+   */
+  'Idempotency-Key': string;
+
+  /**
+   * Body param: Currency code
+   */
+  currency?: string;
+
+  /**
+   * Body param: Deposit description
+   */
+  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 interface WalletInitiateWithdrawalParams {
+  /**
+   * Body param: Amount in cents
+   */
+  amount: number;
+
+  /**
+   * Body param: External account ID (ea\_\*)
+   */
+  externalAccountId: string;
+
+  /**
+   * Header param: Unique key for idempotent request handling. If a request with the
+   * same key was already processed, the original response is returned.
+   */
+  'Idempotency-Key': string;
+
+  /**
+   * Body param: Currency code
+   */
+  currency?: string;
+
+  /**
+   * Body param: Withdrawal description
+   */
+  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 declare namespace Wallet {
+  export {
+    type WalletListResponse as WalletListResponse,
+    type WalletGetResponse as WalletGetResponse,
+    type WalletInitiateDepositResponse as WalletInitiateDepositResponse,
+    type WalletInitiateWithdrawalResponse as WalletInitiateWithdrawalResponse,
+    type WalletListParams as WalletListParams,
+    type WalletGetParams as WalletGetParams,
+    type WalletInitiateDepositParams as WalletInitiateDepositParams,
+    type WalletInitiateWithdrawalParams as WalletInitiateWithdrawalParams,
+  };
+}