@naturalpay/sdk 0.2.1 → 0.3.0

package/resources/wallet.d.mts

@@ -2,28 +2,31 @@ import { APIResource } from "../core/resource.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 /**
- * Wallet balance, deposits, withdrawals, and external funding sources
+ * Wallet balance, deposits, withdrawals, and external accounts
  */
 export declare class Wallet extends APIResource {
     /**
-     * Get spendable and total wallet ledger balance.
+     * List wallets for the authenticated party, including balance and ACH deposit
+     * instructions when available. Currently returns at most one wallet.
      *
      * @example
      * ```ts
-     * const response = await client.wallet.getBalance();
+     * const wallets = await client.wallet.list();
      * ```
      */
-    getBalance(params?: WalletGetBalanceParams | null | undefined, options?: RequestOptions): APIPromise<WalletGetBalanceResponse>;
+    list(params?: WalletListParams | null | undefined, options?: RequestOptions): APIPromise<WalletListResponse>;
     /**
-     * Get account and routing numbers for ACH deposits.
+     * Get a wallet visible to the authenticated party, including balance and ACH
+     * deposit instructions when available.
      *
      * @example
      * ```ts
-     * const response =
-     *   await client.wallet.getDepositInstructions();
+     * const wallet = await client.wallet.get(
+     *   'wal_ecc2efdd09bd231a9ad9bd2aada37aa7',
+     * );
      * ```
      */
-    getDepositInstructions(params?: WalletGetDepositInstructionsParams | null | undefined, options?: RequestOptions): APIPromise<WalletGetDepositInstructionsResponse>;
+    get(walletID: string, params?: WalletGetParams | null | undefined, options?: RequestOptions): APIPromise<WalletGetResponse>;
     /**
      * Initiate a wallet deposit.
      *
@@ -31,8 +34,7 @@ export declare class Wallet extends APIResource {
      * ```ts
      * const response = await client.wallet.initiateDeposit({
      *   amount: 1,
-     *   externalFundingSourceId:
-     *     'efs_ecc2efdd09bd231a9ad9bd2aada37aa7',
+     *   externalAccountId: 'ea_ecc2efdd09bd231a9ad9bd2aada37aa7',
      *   'Idempotency-Key': 'Idempotency-Key',
      * });
      * ```
@@ -45,40 +47,18 @@ export declare class Wallet extends APIResource {
      * ```ts
      * const response = await client.wallet.initiateWithdrawal({
      *   amount: 1,
-     *   externalFundingSourceId:
-     *     'efs_ecc2efdd09bd231a9ad9bd2aada37aa7',
+     *   externalAccountId: 'ea_ecc2efdd09bd231a9ad9bd2aada37aa7',
      *   'Idempotency-Key': 'Idempotency-Key',
      * });
      * ```
      */
     initiateWithdrawal(params: WalletInitiateWithdrawalParams, options?: RequestOptions): APIPromise<WalletInitiateWithdrawalResponse>;
-    /**
-     * List linked external funding sources with cursor pagination.
-     *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.wallet.listPaymentInstruments();
-     * ```
-     */
-    listPaymentInstruments(params?: WalletListPaymentInstrumentsParams | null | undefined, options?: RequestOptions): APIPromise<WalletListPaymentInstrumentsResponse>;
-    /**
-     * Remove (unlink) a bank account.
-     *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.wallet.removePaymentInstrument(
-     *     'efs_ecc2efdd09bd231a9ad9bd2aada37aa7',
-     *   );
-     * ```
-     */
-    removePaymentInstrument(externalFundingSourceID: string, params?: WalletRemovePaymentInstrumentParams | null | undefined, options?: RequestOptions): APIPromise<WalletRemovePaymentInstrumentResponse>;
 }
-export interface WalletGetBalanceResponse {
-    data: WalletGetBalanceResponse.Data;
+export interface WalletListResponse {
+    data: Array<WalletListResponse.Data>;
+    meta: WalletListResponse.Meta;
 }
-export declare namespace WalletGetBalanceResponse {
+export declare namespace WalletListResponse {
     interface Data {
         /**
          * Resource ID
@@ -103,17 +83,70 @@ export declare namespace WalletGetBalanceResponse {
          */
         interface Attributes {
             /**
-             * Amount currently available to spend or withdraw (cents)
+             * Wallet ledger balance
              */
-            availableAmountMinor: number;
+            balance: Attributes.Balance;
             /**
-             * Currency code
+             * Claimable payment totals
+             */
+            claims: Attributes.Claims;
+            /**
+             * ACH deposit instructions for this wallet, when available
+             */
+            depositInstructions: Attributes.DepositInstructions | null;
+            /**
+             * Wallet readiness status
+             */
+            status: 'active';
+        }
+        namespace Attributes {
+            /**
+             * Wallet ledger balance
              */
-            currency: 'USD';
+            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
+             */
+            interface Claims {
+                /**
+                 * Total unclaimed product-payment amount (cents)
+                 */
+                amount: number;
+                /**
+                 * Number of unclaimed product payments
+                 */
+                count: number;
+            }
             /**
-             * Total wallet ledger balance (cents)
+             * ACH deposit instructions for this wallet, when available
              */
-            totalAmountMinor: number;
+            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
@@ -148,168 +181,20 @@ export declare namespace WalletGetBalanceResponse {
             }
         }
     }
-}
-export interface WalletGetDepositInstructionsResponse {
-    data: WalletGetDepositInstructionsResponse.Data;
-}
-export declare namespace WalletGetDepositInstructionsResponse {
-    interface Data {
-        /**
-         * Resource ID (the wallet handle)
-         */
-        id: string;
-        /**
-         * Resource attributes
-         */
-        attributes: Data.Attributes;
-        /**
-         * Resource type
-         */
-        type: string;
-    }
-    namespace Data {
-        /**
-         * Resource attributes
-         */
-        interface Attributes {
-            /**
-             * Account number for ACH deposits
-             */
-            accountNumber: string;
-            /**
-             * Name of the receiving bank
-             */
-            bankName: string;
-            /**
-             * Bank routing number for ACH deposits
-             */
-            routingNumber: string;
-        }
-    }
-}
-export interface WalletInitiateDepositResponse {
-    data: WalletInitiateDepositResponse.Data;
-}
-export declare namespace WalletInitiateDepositResponse {
-    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;
-    }
-    namespace Data {
-        /**
-         * Resource attributes
-         */
-        interface Attributes {
-            /**
-             * Amount in cents
-             */
-            amount: number;
-            /**
-             * Currency code
-             */
-            currency: string;
-            /**
-             * Error message if failed
-             */
-            error: string | null;
-            /**
-             * Detailed error information
-             */
-            errorDetails: string | null;
-            /**
-             * Estimated settlement time
-             */
-            estimatedSettlement: string | null;
-            /**
-             * Operation status
-             */
-            status: 'PROCESSING' | 'IN_REVIEW' | 'COMPLETED' | 'FAILED' | 'RETURNED';
-        }
-    }
-}
-export interface WalletInitiateWithdrawalResponse {
-    data: WalletInitiateWithdrawalResponse.Data;
-}
-export declare namespace WalletInitiateWithdrawalResponse {
-    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;
+    interface Meta {
+        pagination: Meta.Pagination;
     }
-    namespace Data {
-        /**
-         * Resource attributes
-         */
-        interface Attributes {
-            /**
-             * Amount in cents
-             */
-            amount: number;
-            /**
-             * Currency code
-             */
-            currency: string;
-            /**
-             * Error message if failed
-             */
-            error: string | null;
-            /**
-             * Detailed error information
-             */
-            errorDetails: string | null;
-            /**
-             * Estimated settlement time
-             */
-            estimatedSettlement: string | null;
-            /**
-             * Payment instruction ID
-             */
-            instructionId: string | null;
-            /**
-             * MFA challenge ID
-             */
-            mfaChallengeId: string | null;
-            /**
-             * MFA challenge expiration
-             */
-            mfaExpiresAt: string | null;
-            /**
-             * Whether MFA is required
-             */
-            mfaRequired: boolean;
-            /**
-             * Operation status
-             */
-            status: 'PROCESSING' | 'IN_REVIEW' | 'COMPLETED' | 'FAILED' | 'RETURNED';
+    namespace Meta {
+        interface Pagination {
+            hasMore: boolean;
+            nextCursor: string | null;
         }
     }
 }
-export interface WalletListPaymentInstrumentsResponse {
-    data: Array<WalletListPaymentInstrumentsResponse.Data>;
-    meta: WalletListPaymentInstrumentsResponse.Meta;
+export interface WalletGetResponse {
+    data: WalletGetResponse.Data;
 }
-export declare namespace WalletListPaymentInstrumentsResponse {
+export declare namespace WalletGetResponse {
     interface Data {
         /**
          * Resource ID
@@ -334,46 +219,83 @@ export declare namespace WalletListPaymentInstrumentsResponse {
          */
         interface Attributes {
             /**
-             * Account display name
+             * Wallet ledger balance
              */
-            accountName: string | null;
+            balance: Attributes.Balance;
             /**
-             * Account type (checking, savings)
+             * Claimable payment totals
              */
-            accountType: 'checking' | 'savings' | 'unknown' | null;
+            claims: Attributes.Claims;
             /**
-             * Bank institution name
+             * ACH deposit instructions for this wallet, when available
              */
-            bankName: string | null;
+            depositInstructions: Attributes.DepositInstructions | null;
             /**
-             * When the funding source was linked
+             * Wallet readiness status
              */
-            createdAt: string;
+            status: 'active';
+        }
+        namespace Attributes {
             /**
-             * Last 4 digits of account
+             * Wallet ledger balance
              */
-            lastFour: string;
+            interface Balance {
+                /**
+                 * Amount currently available to spend or withdraw (cents)
+                 */
+                available: number;
+                /**
+                 * Currency code
+                 */
+                currency: 'USD';
+                /**
+                 * Total wallet ledger balance (cents)
+                 */
+                total: number;
+            }
             /**
-             * Status (new, active, disabled)
+             * Claimable payment totals
              */
-            status: 'new' | 'active' | 'disabled' | 'deleted' | 'unknown';
+            interface Claims {
+                /**
+                 * Total unclaimed product-payment amount (cents)
+                 */
+                amount: number;
+                /**
+                 * Number of unclaimed product payments
+                 */
+                count: number;
+            }
             /**
-             * Verification state
+             * ACH deposit instructions for this wallet, when available
              */
-            verificationState: string | null;
+            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
          */
         interface Relationships {
             /**
-             * Party that owns the funding source
+             * Party that owns the wallet
              */
             party: Relationships.Party;
         }
         namespace Relationships {
             /**
-             * Party that owns the funding source
+             * Party that owns the wallet
              */
             interface Party {
                 /**
@@ -395,34 +317,21 @@ export declare namespace WalletListPaymentInstrumentsResponse {
             }
         }
     }
-    interface Meta {
-        pagination: Meta.Pagination;
-    }
-    namespace Meta {
-        interface Pagination {
-            hasMore: boolean;
-            nextCursor: string | null;
-        }
-    }
 }
-export interface WalletRemovePaymentInstrumentResponse {
-    data: WalletRemovePaymentInstrumentResponse.Data;
-    meta: WalletRemovePaymentInstrumentResponse.Meta;
+export interface WalletInitiateDepositResponse {
+    data: WalletInitiateDepositResponse.Data;
 }
-export declare namespace WalletRemovePaymentInstrumentResponse {
+export declare namespace WalletInitiateDepositResponse {
     interface Data {
         /**
-         * Resource ID
+         * Transaction handle (txn_xxx). Empty when the operation failed before a
+         * transaction was created.
          */
         id: string;
         /**
          * Resource attributes
          */
         attributes: Data.Attributes;
-        /**
-         * Resource relationships
-         */
-        relationships: Data.Relationships;
         /**
          * Resource type
          */
@@ -434,90 +343,79 @@ export declare namespace WalletRemovePaymentInstrumentResponse {
          */
         interface Attributes {
             /**
-             * Account display name
-             */
-            accountName: string | null;
-            /**
-             * Account type (checking, savings)
+             * Amount in cents
              */
-            accountType: 'checking' | 'savings' | 'unknown' | null;
+            amount: number;
             /**
-             * Bank institution name
+             * Currency code
              */
-            bankName: string | null;
+            currency: string;
             /**
-             * When the funding source was linked
+             * Estimated settlement time
              */
-            createdAt: string;
+            estimatedSettlement: string | null;
             /**
-             * Last 4 digits of account
+             * Operation status
              */
-            lastFour: string;
+            status: 'PROCESSING' | 'IN_REVIEW' | 'AWAITING_APPROVAL' | 'COMPLETED' | 'FAILED' | 'RETURNED';
+        }
+    }
+}
+export interface WalletInitiateWithdrawalResponse {
+    data: WalletInitiateWithdrawalResponse.Data;
+}
+export declare namespace WalletInitiateWithdrawalResponse {
+    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;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
             /**
-             * Status (new, active, disabled)
+             * Amount in cents
              */
-            status: 'new' | 'active' | 'disabled' | 'deleted' | 'unknown';
+            amount: number;
             /**
-             * Verification state
+             * Currency code
              */
-            verificationState: string | null;
-        }
-        /**
-         * Resource relationships
-         */
-        interface Relationships {
+            currency: string;
             /**
-             * Party that owns the funding source
+             * Estimated settlement time
              */
-            party: Relationships.Party;
-        }
-        namespace Relationships {
+            estimatedSettlement: string | null;
             /**
-             * Party that owns the funding source
+             * Operation status
              */
-            interface Party {
-                /**
-                 * Related resource identifier
-                 */
-                data: Party.Data;
-            }
-            namespace Party {
-                /**
-                 * Related resource identifier
-                 */
-                interface Data {
-                    id: string;
-                    /**
-                     * Resource type
-                     */
-                    type: string;
-                }
-            }
+            status: 'PROCESSING' | 'IN_REVIEW' | 'AWAITING_APPROVAL' | 'COMPLETED' | 'FAILED' | 'RETURNED';
         }
     }
-    interface Meta {
-        /**
-         * Indicates the resource was deleted
-         */
-        deleted: true;
-    }
 }
-export interface WalletGetBalanceParams {
+export interface WalletListParams {
     /**
-     * Query param
-     */
-    partyId?: string;
-    /**
-     * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+     * 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.
+     * Required when X-Agent-ID is present. Session or conversation ID for agent
+     * observability.
      */
     'X-Instance-ID'?: string;
 }
-export interface WalletGetDepositInstructionsParams {
+export interface WalletGetParams {
     /**
      * Agent ID (agt_xxx) identifying which agent is making the request.
      */
@@ -534,9 +432,9 @@ export interface WalletInitiateDepositParams {
      */
     amount: number;
     /**
-     * Body param: External funding source ID (efs\_\*)
+     * Body param: External account ID (ea\_\*)
      */
-    externalFundingSourceId: string;
+    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.
@@ -566,9 +464,9 @@ export interface WalletInitiateWithdrawalParams {
      */
     amount: number;
     /**
-     * Body param: External funding source ID (efs\_\*)
+     * Body param: External account ID (ea\_\*)
      */
-    externalFundingSourceId: string;
+    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.
@@ -592,37 +490,7 @@ export interface WalletInitiateWithdrawalParams {
      */
     'X-Instance-ID'?: string;
 }
-export interface WalletListPaymentInstrumentsParams {
-    /**
-     * Query param
-     */
-    cursor?: string;
-    /**
-     * Query param
-     */
-    limit?: number;
-    /**
-     * 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 WalletRemovePaymentInstrumentParams {
-    /**
-     * 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 declare namespace Wallet {
-    export { type WalletGetBalanceResponse as WalletGetBalanceResponse, type WalletGetDepositInstructionsResponse as WalletGetDepositInstructionsResponse, type WalletInitiateDepositResponse as WalletInitiateDepositResponse, type WalletInitiateWithdrawalResponse as WalletInitiateWithdrawalResponse, type WalletListPaymentInstrumentsResponse as WalletListPaymentInstrumentsResponse, type WalletRemovePaymentInstrumentResponse as WalletRemovePaymentInstrumentResponse, type WalletGetBalanceParams as WalletGetBalanceParams, type WalletGetDepositInstructionsParams as WalletGetDepositInstructionsParams, type WalletInitiateDepositParams as WalletInitiateDepositParams, type WalletInitiateWithdrawalParams as WalletInitiateWithdrawalParams, type WalletListPaymentInstrumentsParams as WalletListPaymentInstrumentsParams, type WalletRemovePaymentInstrumentParams as WalletRemovePaymentInstrumentParams, };
+    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, };
 }
 //# sourceMappingURL=wallet.d.mts.map