@naturalpay/sdk 0.2.0 → 0.2.1

package/resources/transactions.d.mts

@@ -0,0 +1,478 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Payment and transaction operations
+ */
+export declare class Transactions extends APIResource {
+    /**
+     * List transactions visible to the authenticated party and its delegated agents.
+     */
+    list(params?: TransactionListParams | null | undefined, options?: RequestOptions): APIPromise<TransactionListResponse>;
+    /**
+     * Get a single transaction visible to the authenticated party.
+     */
+    get(transactionID: string, params?: TransactionGetParams | null | undefined, options?: RequestOptions): APIPromise<TransactionGetResponse>;
+}
+export interface TransactionListResponse {
+    data: Array<TransactionListResponse.Data>;
+    meta: TransactionListResponse.Meta;
+}
+export declare namespace TransactionListResponse {
+    interface Data {
+        /**
+         * Transaction handle (txn_xxx)
+         */
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource relationships
+         */
+        relationships: Data.Relationships;
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * Agent that initiated this transaction. Null when initiated by a human user.
+             */
+            agentId: string | null;
+            /**
+             * Amount in cents
+             */
+            amount: number;
+            /**
+             * Classification from the authenticated party's perspective. Derived from
+             * transactionType + direction: "sent"/"received" for wallet-to-wallet payments
+             * (OUTBOUND/INBOUND), "deposit"/"withdrawal" for external transfers
+             * (INBOUND/OUTBOUND).
+             */
+            category: 'sent' | 'received' | 'deposit' | 'withdrawal';
+            /**
+             * When this transaction was created
+             */
+            createdAt: string;
+            /**
+             * Currency code
+             */
+            currency: string;
+            /**
+             * Customer name if delegated
+             */
+            customerName: string | null;
+            /**
+             * Payment description
+             */
+            description: string | null;
+            /**
+             * Direction: INBOUND | OUTBOUND
+             */
+            direction: 'INBOUND' | 'OUTBOUND';
+            /**
+             * Active dispute ID when a dispute has been filed for this transaction
+             */
+            disputeId: string | null;
+            /**
+             * Pending escalation ID when this transaction requires approval
+             */
+            escalationId: string | null;
+            /**
+             * Display name of the user or agent that initiated this transaction
+             */
+            initiatorName: string | null;
+            /**
+             * True if this is a delegated customer payment
+             */
+            isDelegated: boolean;
+            /**
+             * Recipient display name
+             */
+            recipientName: string | null;
+            /**
+             * Sender display name
+             */
+            senderName: string | null;
+            /**
+             * Transaction status
+             */
+            status: string;
+            /**
+             * Transaction type: payment | transfer
+             */
+            transactionType: 'payment' | 'transfer';
+            /**
+             * When this transaction was last updated
+             */
+            updatedAt: string | null;
+        }
+        /**
+         * Resource relationships
+         */
+        interface Relationships {
+            /**
+             * Destination party
+             */
+            destinationParty: Relationships.DestinationParty;
+            /**
+             * Destination wallet
+             */
+            destinationWallet: Relationships.DestinationWallet;
+            /**
+             * Source party
+             */
+            sourceParty: Relationships.SourceParty;
+            /**
+             * Source wallet
+             */
+            sourceWallet: Relationships.SourceWallet;
+        }
+        namespace Relationships {
+            /**
+             * Destination party
+             */
+            interface DestinationParty {
+                /**
+                 * Related resource identifier
+                 */
+                data: DestinationParty.Data | null;
+            }
+            namespace DestinationParty {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Destination wallet
+             */
+            interface DestinationWallet {
+                /**
+                 * Related resource identifier
+                 */
+                data: DestinationWallet.Data | null;
+            }
+            namespace DestinationWallet {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Source party
+             */
+            interface SourceParty {
+                /**
+                 * Related resource identifier
+                 */
+                data: SourceParty.Data | null;
+            }
+            namespace SourceParty {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Source wallet
+             */
+            interface SourceWallet {
+                /**
+                 * Related resource identifier
+                 */
+                data: SourceWallet.Data | null;
+            }
+            namespace SourceWallet {
+                /**
+                 * 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 TransactionGetResponse {
+    data: TransactionGetResponse.Data;
+}
+export declare namespace TransactionGetResponse {
+    interface Data {
+        /**
+         * Transaction handle (txn_xxx)
+         */
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource relationships
+         */
+        relationships: Data.Relationships;
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * Agent that initiated this transaction. Null when initiated by a human user.
+             */
+            agentId: string | null;
+            /**
+             * Amount in cents
+             */
+            amount: number;
+            /**
+             * Classification from the authenticated party's perspective. Derived from
+             * transactionType + direction: "sent"/"received" for wallet-to-wallet payments
+             * (OUTBOUND/INBOUND), "deposit"/"withdrawal" for external transfers
+             * (INBOUND/OUTBOUND).
+             */
+            category: 'sent' | 'received' | 'deposit' | 'withdrawal';
+            /**
+             * When this transaction was created
+             */
+            createdAt: string;
+            /**
+             * Currency code
+             */
+            currency: string;
+            /**
+             * Customer name if delegated
+             */
+            customerName: string | null;
+            /**
+             * Payment description
+             */
+            description: string | null;
+            /**
+             * Direction: INBOUND | OUTBOUND
+             */
+            direction: 'INBOUND' | 'OUTBOUND';
+            /**
+             * Active dispute ID when a dispute has been filed for this transaction
+             */
+            disputeId: string | null;
+            /**
+             * Pending escalation ID when this transaction requires approval
+             */
+            escalationId: string | null;
+            /**
+             * Display name of the user or agent that initiated this transaction
+             */
+            initiatorName: string | null;
+            /**
+             * True if this is a delegated customer payment
+             */
+            isDelegated: boolean;
+            /**
+             * Recipient display name
+             */
+            recipientName: string | null;
+            /**
+             * Sender display name
+             */
+            senderName: string | null;
+            /**
+             * Transaction status
+             */
+            status: string;
+            /**
+             * Transaction type: payment | transfer
+             */
+            transactionType: 'payment' | 'transfer';
+            /**
+             * When this transaction was last updated
+             */
+            updatedAt: string | null;
+        }
+        /**
+         * Resource relationships
+         */
+        interface Relationships {
+            /**
+             * Destination party
+             */
+            destinationParty: Relationships.DestinationParty;
+            /**
+             * Destination wallet
+             */
+            destinationWallet: Relationships.DestinationWallet;
+            /**
+             * Source party
+             */
+            sourceParty: Relationships.SourceParty;
+            /**
+             * Source wallet
+             */
+            sourceWallet: Relationships.SourceWallet;
+        }
+        namespace Relationships {
+            /**
+             * Destination party
+             */
+            interface DestinationParty {
+                /**
+                 * Related resource identifier
+                 */
+                data: DestinationParty.Data | null;
+            }
+            namespace DestinationParty {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Destination wallet
+             */
+            interface DestinationWallet {
+                /**
+                 * Related resource identifier
+                 */
+                data: DestinationWallet.Data | null;
+            }
+            namespace DestinationWallet {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Source party
+             */
+            interface SourceParty {
+                /**
+                 * Related resource identifier
+                 */
+                data: SourceParty.Data | null;
+            }
+            namespace SourceParty {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+            /**
+             * Source wallet
+             */
+            interface SourceWallet {
+                /**
+                 * Related resource identifier
+                 */
+                data: SourceWallet.Data | null;
+            }
+            namespace SourceWallet {
+                /**
+                 * Related resource identifier
+                 */
+                interface Data {
+                    id: string;
+                    /**
+                     * Resource type
+                     */
+                    type: string;
+                }
+            }
+        }
+    }
+}
+export interface TransactionListParams {
+    /**
+     * Query param: Pagination cursor from previous response
+     */
+    cursor?: string;
+    /**
+     * Query param: Results per page
+     */
+    limit?: number;
+    /**
+     * Query param
+     */
+    type?: 'payment' | 'transfer' | 'all';
+    /**
+     * 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 TransactionGetParams {
+    /**
+     * Query param: Party ID for delegated transaction 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 declare namespace Transactions {
+    export { type TransactionListResponse as TransactionListResponse, type TransactionGetResponse as TransactionGetResponse, type TransactionListParams as TransactionListParams, type TransactionGetParams as TransactionGetParams, };
+}
+//# sourceMappingURL=transactions.d.mts.map

package/resources/transactions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.d.mts","sourceRoot":"","sources":["../src/resources/transactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,IAAI,CACF,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAetC;;OAEG;IACH,GAAG,CACD,aAAa,EAAE,MAAM,EACrB,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CActC;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAE1C,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;QAE5B;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;;;eAKG;YACH,QAAQ,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,YAAY,CAAC;YAEzD;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,WAAW,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC;YAExC;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,gBAAgB,EAAE,aAAa,CAAC,gBAAgB,CAAC;YAEjD;;eAEG;YACH,iBAAiB,EAAE,aAAa,CAAC,iBAAiB,CAAC;YAEnD;;eAEG;YACH,WAAW,EAAE,aAAa,CAAC,WAAW,CAAC;YAEvC;;eAEG;YACH,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC;SAC1C;QAED,UAAiB,aAAa,CAAC;YAC7B;;eAEG;YACH,UAAiB,gBAAgB;gBAC/B;;mBAEG;gBACH,IAAI,EAAE,gBAAgB,CAAC,IAAI,GAAG,IAAI,CAAC;aACpC;YAED,UAAiB,gBAAgB,CAAC;gBAChC;;mBAEG;gBACH,UAAiB,IAAI;oBACnB,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;eAEG;YACH,UAAiB,iBAAiB;gBAChC;;mBAEG;gBACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC;aACrC;YAED,UAAiB,iBAAiB,CAAC;gBACjC;;mBAEG;gBACH,UAAiB,IAAI;oBACnB,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;eAEG;YACH,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,IAAI,EAAE,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;aAC/B;YAED,UAAiB,WAAW,CAAC;gBAC3B;;mBAEG;gBACH,UAAiB,IAAI;oBACnB,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;eAEG;YACH,UAAiB,YAAY;gBAC3B;;mBAEG;gBACH,IAAI,EAAE,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;aAChC;YAED,UAAiB,YAAY,CAAC;gBAC5B;;mBAEG;gBACH,UAAiB,IAAI;oBACnB,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;SACF;KACF;IAED,UAAiB,IAAI;QACnB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,UAAU;YACzB,OAAO,EAAE,OAAO,CAAC;YAEjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;QAE5B;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;;;eAKG;YACH,QAAQ,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,YAAY,CAAC;YAEzD;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,WAAW,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC;YAExC;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,gBAAgB,EAAE,aAAa,CAAC,gBAAgB,CAAC;YAEjD;;eAEG;YACH,iBAAiB,EAAE,aAAa,CAAC,iBAAiB,CAAC;YAEnD;;eAEG;YACH,WAAW,EAAE,aAAa,CAAC,WAAW,CAAC;YAEvC;;eAEG;YACH,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC;SAC1C;QAED,UAAiB,aAAa,CAAC;YAC7B;;eAEG;YACH,UAAiB,gBAAgB;gBAC/B;;mBAEG;gBACH,IAAI,EAAE,gBAAgB,CAAC,IAAI,GAAG,IAAI,CAAC;aACpC;YAED,UAAiB,gBAAgB,CAAC;gBAChC;;mBAEG;gBACH,UAAiB,IAAI;oBACnB,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;eAEG;YACH,UAAiB,iBAAiB;gBAChC;;mBAEG;gBACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC;aACrC;YAED,UAAiB,iBAAiB,CAAC;gBACjC;;mBAEG;gBACH,UAAiB,IAAI;oBACnB,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;eAEG;YACH,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,IAAI,EAAE,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;aAC/B;YAED,UAAiB,WAAW,CAAC;gBAC3B;;mBAEG;gBACH,UAAiB,IAAI;oBACnB,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;eAEG;YACH,UAAiB,YAAY;gBAC3B;;mBAEG;gBACH,IAAI,EAAE,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;aAChC;YAED,UAAiB,YAAY,CAAC;gBAC5B;;mBAEG;gBACH,UAAiB,IAAI;oBACnB,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;SACF;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,KAAK,CAAC;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}