@naturalpay/sdk 0.3.0 → 0.4.0

package/resources/transfers.d.ts

@@ -0,0 +1,1030 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Deposit and withdrawal operations
+ */
+export declare class Transfers extends APIResource {
+    /**
+     * List deposits and withdrawals for the authenticated party.
+     *
+     * @example
+     * ```ts
+     * const transfers = await client.transfers.list();
+     * ```
+     */
+    list(params?: TransferListParams | null | undefined, options?: RequestOptions): APIPromise<TransferListResponse>;
+    /**
+     * Get a deposit or withdrawal by ID.
+     *
+     * @example
+     * ```ts
+     * const transfer = await client.transfers.get(
+     *   'trf_ecc2efdd09bd231a9ad9bd2aada37aa7',
+     * );
+     * ```
+     */
+    get(transferID: string, params?: TransferGetParams | null | undefined, options?: RequestOptions): APIPromise<TransferGetResponse>;
+    /**
+     * Initiate a wallet deposit.
+     *
+     * @example
+     * ```ts
+     * const response = await client.transfers.initiateDeposit({
+     *   amount: 1,
+     *   externalAccountId: 'eac_ecc2efdd09bd231a9ad9bd2aada37aa7',
+     *   'Idempotency-Key': 'Idempotency-Key',
+     * });
+     * ```
+     */
+    initiateDeposit(params: TransferInitiateDepositParams, options?: RequestOptions): APIPromise<TransferInitiateDepositResponse>;
+    /**
+     * Initiate a wallet withdrawal.
+     *
+     * @example
+     * ```ts
+     * const response = await client.transfers.initiateWithdrawal({
+     *   amount: 1,
+     *   externalAccountId: 'eac_ecc2efdd09bd231a9ad9bd2aada37aa7',
+     *   'Idempotency-Key': 'Idempotency-Key',
+     * });
+     * ```
+     */
+    initiateWithdrawal(params: TransferInitiateWithdrawalParams, options?: RequestOptions): APIPromise<TransferInitiateWithdrawalResponse>;
+}
+export interface TransferListResponse {
+    data: Array<TransferListResponse.Data>;
+    meta: TransferListResponse.Meta;
+}
+export declare namespace TransferListResponse {
+    interface Data {
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource relationships
+         */
+        relationships: Data.Relationships;
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * Amount in cents
+             */
+            amount: number;
+            /**
+             * When this transfer was created
+             */
+            createdAt: string;
+            /**
+             * Currency code
+             */
+            currency: string;
+            /**
+             * Transfer description
+             */
+            description: string | null;
+            /**
+             * Expected availability time, when known
+             */
+            expectedAvailableAt: string | null;
+            /**
+             * Masked external account display
+             */
+            externalAccountDisplayMask: string | null;
+            /**
+             * Failure details when this transfer failed.
+             */
+            failure: Attributes.Failure | null;
+            /**
+             * Return details when this transfer was returned.
+             */
+            return: Attributes.Return | null;
+            /**
+             * When this transfer settled
+             */
+            settledAt: string | null;
+            /**
+             * Transfer status
+             */
+            status: 'CREATED' | 'APPROVAL_DENIED' | 'PROCESSING' | 'IN_REVIEW' | 'COMPLETED' | 'FAILED' | 'RETURNED' | 'CANCELLED';
+            /**
+             * When this transfer was submitted
+             */
+            submittedAt: string | null;
+            /**
+             * Transfer type
+             */
+            type: 'deposit' | 'withdrawal';
+            /**
+             * When this transfer was last updated
+             */
+            updatedAt: string | null;
+        }
+        namespace Attributes {
+            /**
+             * Failure details when this transfer failed.
+             */
+            interface Failure {
+                /**
+                 * Failure code, when available
+                 */
+                code: string | null;
+                /**
+                 * Failure reason, when available
+                 */
+                reason: string | null;
+            }
+            /**
+             * Return details when this transfer was returned.
+             */
+            interface Return {
+                /**
+                 * Return code, when available
+                 */
+                code: string | null;
+                /**
+                 * Return reason, when available
+                 */
+                reason: string | null;
+                /**
+                 * When this transfer returned
+                 */
+                returnedAt: string | null;
+            }
+        }
+        /**
+         * Resource relationships
+         */
+        interface Relationships {
+            /**
+             * External account used for this transfer, when available.
+             */
+            externalAccount: Relationships.ExternalAccount;
+            /**
+             * Party that owns the transfer
+             */
+            party: Relationships.Party;
+            /**
+             * Primary transaction row for this transfer, when available.
+             */
+            transaction: Relationships.Transaction;
+            /**
+             * Wallet for this transfer
+             */
+            wallet: Relationships.Wallet;
+        }
+        namespace Relationships {
+            /**
+             * External account used for this transfer, when available.
+             */
+            interface ExternalAccount {
+                /**
+                 * Related resource identifier
+                 */
+                data: ExternalAccount.Data | null;
+            }
+            namespace ExternalAccount {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Party that owns the transfer
+             */
+            interface Party {
+                /**
+                 * Related resource identifier
+                 */
+                data: Party.Data;
+            }
+            namespace Party {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Primary transaction row for this transfer, when available.
+             */
+            interface Transaction {
+                /**
+                 * Related resource identifier
+                 */
+                data: Transaction.Data | null;
+            }
+            namespace Transaction {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Wallet for this transfer
+             */
+            interface Wallet {
+                /**
+                 * Related resource identifier
+                 */
+                data: Wallet.Data;
+            }
+            namespace Wallet {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+        }
+    }
+    interface Meta {
+        pagination: Meta.Pagination;
+    }
+    namespace Meta {
+        interface Pagination {
+            hasMore: boolean;
+            nextCursor: string | null;
+        }
+    }
+}
+export interface TransferGetResponse {
+    data: TransferGetResponse.Data;
+}
+export declare namespace TransferGetResponse {
+    interface Data {
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource relationships
+         */
+        relationships: Data.Relationships;
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * Amount in cents
+             */
+            amount: number;
+            /**
+             * When this transfer was created
+             */
+            createdAt: string;
+            /**
+             * Currency code
+             */
+            currency: string;
+            /**
+             * Transfer description
+             */
+            description: string | null;
+            /**
+             * Expected availability time, when known
+             */
+            expectedAvailableAt: string | null;
+            /**
+             * Masked external account display
+             */
+            externalAccountDisplayMask: string | null;
+            /**
+             * Failure details when this transfer failed.
+             */
+            failure: Attributes.Failure | null;
+            /**
+             * Return details when this transfer was returned.
+             */
+            return: Attributes.Return | null;
+            /**
+             * When this transfer settled
+             */
+            settledAt: string | null;
+            /**
+             * Transfer status
+             */
+            status: 'CREATED' | 'APPROVAL_DENIED' | 'PROCESSING' | 'IN_REVIEW' | 'COMPLETED' | 'FAILED' | 'RETURNED' | 'CANCELLED';
+            /**
+             * When this transfer was submitted
+             */
+            submittedAt: string | null;
+            /**
+             * Transfer type
+             */
+            type: 'deposit' | 'withdrawal';
+            /**
+             * When this transfer was last updated
+             */
+            updatedAt: string | null;
+        }
+        namespace Attributes {
+            /**
+             * Failure details when this transfer failed.
+             */
+            interface Failure {
+                /**
+                 * Failure code, when available
+                 */
+                code: string | null;
+                /**
+                 * Failure reason, when available
+                 */
+                reason: string | null;
+            }
+            /**
+             * Return details when this transfer was returned.
+             */
+            interface Return {
+                /**
+                 * Return code, when available
+                 */
+                code: string | null;
+                /**
+                 * Return reason, when available
+                 */
+                reason: string | null;
+                /**
+                 * When this transfer returned
+                 */
+                returnedAt: string | null;
+            }
+        }
+        /**
+         * Resource relationships
+         */
+        interface Relationships {
+            /**
+             * External account used for this transfer, when available.
+             */
+            externalAccount: Relationships.ExternalAccount;
+            /**
+             * Party that owns the transfer
+             */
+            party: Relationships.Party;
+            /**
+             * Primary transaction row for this transfer, when available.
+             */
+            transaction: Relationships.Transaction;
+            /**
+             * Wallet for this transfer
+             */
+            wallet: Relationships.Wallet;
+        }
+        namespace Relationships {
+            /**
+             * External account used for this transfer, when available.
+             */
+            interface ExternalAccount {
+                /**
+                 * Related resource identifier
+                 */
+                data: ExternalAccount.Data | null;
+            }
+            namespace ExternalAccount {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Party that owns the transfer
+             */
+            interface Party {
+                /**
+                 * Related resource identifier
+                 */
+                data: Party.Data;
+            }
+            namespace Party {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Primary transaction row for this transfer, when available.
+             */
+            interface Transaction {
+                /**
+                 * Related resource identifier
+                 */
+                data: Transaction.Data | null;
+            }
+            namespace Transaction {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Wallet for this transfer
+             */
+            interface Wallet {
+                /**
+                 * Related resource identifier
+                 */
+                data: Wallet.Data;
+            }
+            namespace Wallet {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+        }
+    }
+}
+export interface TransferInitiateDepositResponse {
+    data: TransferInitiateDepositResponse.Data;
+}
+export declare namespace TransferInitiateDepositResponse {
+    interface Data {
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource relationships
+         */
+        relationships: Data.Relationships;
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * Amount in cents
+             */
+            amount: number;
+            /**
+             * When this transfer was created
+             */
+            createdAt: string;
+            /**
+             * Currency code
+             */
+            currency: string;
+            /**
+             * Transfer description
+             */
+            description: string | null;
+            /**
+             * Expected availability time, when known
+             */
+            expectedAvailableAt: string | null;
+            /**
+             * Masked external account display
+             */
+            externalAccountDisplayMask: string | null;
+            /**
+             * Failure details when this transfer failed.
+             */
+            failure: Attributes.Failure | null;
+            /**
+             * Return details when this transfer was returned.
+             */
+            return: Attributes.Return | null;
+            /**
+             * When this transfer settled
+             */
+            settledAt: string | null;
+            /**
+             * Transfer status
+             */
+            status: 'CREATED' | 'APPROVAL_DENIED' | 'PROCESSING' | 'IN_REVIEW' | 'COMPLETED' | 'FAILED' | 'RETURNED' | 'CANCELLED';
+            /**
+             * When this transfer was submitted
+             */
+            submittedAt: string | null;
+            /**
+             * Transfer type
+             */
+            type: 'deposit' | 'withdrawal';
+            /**
+             * When this transfer was last updated
+             */
+            updatedAt: string | null;
+        }
+        namespace Attributes {
+            /**
+             * Failure details when this transfer failed.
+             */
+            interface Failure {
+                /**
+                 * Failure code, when available
+                 */
+                code: string | null;
+                /**
+                 * Failure reason, when available
+                 */
+                reason: string | null;
+            }
+            /**
+             * Return details when this transfer was returned.
+             */
+            interface Return {
+                /**
+                 * Return code, when available
+                 */
+                code: string | null;
+                /**
+                 * Return reason, when available
+                 */
+                reason: string | null;
+                /**
+                 * When this transfer returned
+                 */
+                returnedAt: string | null;
+            }
+        }
+        /**
+         * Resource relationships
+         */
+        interface Relationships {
+            /**
+             * External account used for this transfer, when available.
+             */
+            externalAccount: Relationships.ExternalAccount;
+            /**
+             * Party that owns the transfer
+             */
+            party: Relationships.Party;
+            /**
+             * Primary transaction row for this transfer, when available.
+             */
+            transaction: Relationships.Transaction;
+            /**
+             * Wallet for this transfer
+             */
+            wallet: Relationships.Wallet;
+        }
+        namespace Relationships {
+            /**
+             * External account used for this transfer, when available.
+             */
+            interface ExternalAccount {
+                /**
+                 * Related resource identifier
+                 */
+                data: ExternalAccount.Data | null;
+            }
+            namespace ExternalAccount {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Party that owns the transfer
+             */
+            interface Party {
+                /**
+                 * Related resource identifier
+                 */
+                data: Party.Data;
+            }
+            namespace Party {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Primary transaction row for this transfer, when available.
+             */
+            interface Transaction {
+                /**
+                 * Related resource identifier
+                 */
+                data: Transaction.Data | null;
+            }
+            namespace Transaction {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Wallet for this transfer
+             */
+            interface Wallet {
+                /**
+                 * Related resource identifier
+                 */
+                data: Wallet.Data;
+            }
+            namespace Wallet {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+        }
+    }
+}
+export interface TransferInitiateWithdrawalResponse {
+    data: TransferInitiateWithdrawalResponse.Data;
+}
+export declare namespace TransferInitiateWithdrawalResponse {
+    interface Data {
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource relationships
+         */
+        relationships: Data.Relationships;
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * Amount in cents
+             */
+            amount: number;
+            /**
+             * When this transfer was created
+             */
+            createdAt: string;
+            /**
+             * Currency code
+             */
+            currency: string;
+            /**
+             * Transfer description
+             */
+            description: string | null;
+            /**
+             * Expected availability time, when known
+             */
+            expectedAvailableAt: string | null;
+            /**
+             * Masked external account display
+             */
+            externalAccountDisplayMask: string | null;
+            /**
+             * Failure details when this transfer failed.
+             */
+            failure: Attributes.Failure | null;
+            /**
+             * Return details when this transfer was returned.
+             */
+            return: Attributes.Return | null;
+            /**
+             * When this transfer settled
+             */
+            settledAt: string | null;
+            /**
+             * Transfer status
+             */
+            status: 'CREATED' | 'APPROVAL_DENIED' | 'PROCESSING' | 'IN_REVIEW' | 'COMPLETED' | 'FAILED' | 'RETURNED' | 'CANCELLED';
+            /**
+             * When this transfer was submitted
+             */
+            submittedAt: string | null;
+            /**
+             * Transfer type
+             */
+            type: 'deposit' | 'withdrawal';
+            /**
+             * When this transfer was last updated
+             */
+            updatedAt: string | null;
+        }
+        namespace Attributes {
+            /**
+             * Failure details when this transfer failed.
+             */
+            interface Failure {
+                /**
+                 * Failure code, when available
+                 */
+                code: string | null;
+                /**
+                 * Failure reason, when available
+                 */
+                reason: string | null;
+            }
+            /**
+             * Return details when this transfer was returned.
+             */
+            interface Return {
+                /**
+                 * Return code, when available
+                 */
+                code: string | null;
+                /**
+                 * Return reason, when available
+                 */
+                reason: string | null;
+                /**
+                 * When this transfer returned
+                 */
+                returnedAt: string | null;
+            }
+        }
+        /**
+         * Resource relationships
+         */
+        interface Relationships {
+            /**
+             * External account used for this transfer, when available.
+             */
+            externalAccount: Relationships.ExternalAccount;
+            /**
+             * Party that owns the transfer
+             */
+            party: Relationships.Party;
+            /**
+             * Primary transaction row for this transfer, when available.
+             */
+            transaction: Relationships.Transaction;
+            /**
+             * Wallet for this transfer
+             */
+            wallet: Relationships.Wallet;
+        }
+        namespace Relationships {
+            /**
+             * External account used for this transfer, when available.
+             */
+            interface ExternalAccount {
+                /**
+                 * Related resource identifier
+                 */
+                data: ExternalAccount.Data | null;
+            }
+            namespace ExternalAccount {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Party that owns the transfer
+             */
+            interface Party {
+                /**
+                 * Related resource identifier
+                 */
+                data: Party.Data;
+            }
+            namespace Party {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Primary transaction row for this transfer, when available.
+             */
+            interface Transaction {
+                /**
+                 * Related resource identifier
+                 */
+                data: Transaction.Data | null;
+            }
+            namespace Transaction {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Wallet for this transfer
+             */
+            interface Wallet {
+                /**
+                 * Related resource identifier
+                 */
+                data: Wallet.Data;
+            }
+            namespace Wallet {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+        }
+    }
+}
+export interface TransferListParams {
+    /**
+     * Query param: Pagination cursor from previous response
+     */
+    cursor?: string;
+    /**
+     * Query param: Results per page
+     */
+    limit?: number;
+    /**
+     * Query param: Party ID for delegated transfer lookup
+     */
+    partyId?: 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 TransferGetParams {
+    /**
+     * Query param: Party ID for delegated transfer lookup
+     */
+    partyId?: 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 TransferInitiateDepositParams {
+    /**
+     * Body param: Amount in cents
+     */
+    amount: number;
+    /**
+     * Body param: External account ID (eac\_\*)
+     */
+    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 TransferInitiateWithdrawalParams {
+    /**
+     * Body param: Amount in cents
+     */
+    amount: number;
+    /**
+     * Body param: External account ID (eac\_\*)
+     */
+    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 Transfers {
+    export { type TransferListResponse as TransferListResponse, type TransferGetResponse as TransferGetResponse, type TransferInitiateDepositResponse as TransferInitiateDepositResponse, type TransferInitiateWithdrawalResponse as TransferInitiateWithdrawalResponse, type TransferListParams as TransferListParams, type TransferGetParams as TransferGetParams, type TransferInitiateDepositParams as TransferInitiateDepositParams, type TransferInitiateWithdrawalParams as TransferInitiateWithdrawalParams, };
+}
+//# sourceMappingURL=transfers.d.ts.map