@naturalpay/sdk 0.7.0 → 0.9.0

package/resources/approvals.d.mts

@@ -0,0 +1,414 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Approval review operations
+ */
+export declare class Approvals extends APIResource {
+    /**
+     * List approvals for your party.
+     */
+    list(params?: ApprovalListParams | null | undefined, options?: RequestOptions): APIPromise<ApprovalListResponse>;
+    /**
+     * Approve the product operation under review.
+     */
+    approve(approvalID: string, params?: ApprovalApproveParams | null | undefined, options?: RequestOptions): APIPromise<ApprovalApproveResponse>;
+    /**
+     * Deny the product operation under review.
+     */
+    deny(approvalID: string, params?: ApprovalDenyParams | null | undefined, options?: RequestOptions): APIPromise<ApprovalDenyResponse>;
+    /**
+     * Get details of a specific approval.
+     */
+    get(approvalID: string, params?: ApprovalGetParams | null | undefined, options?: RequestOptions): APIPromise<ApprovalGetResponse>;
+}
+export interface ApprovalListResponse {
+    data: Array<ApprovalListResponse.Data>;
+    meta: ApprovalListResponse.Meta;
+}
+export declare namespace ApprovalListResponse {
+    interface Data {
+        /**
+         * Approval ID
+         */
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource type
+         */
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * When the approval was created
+             */
+            createdAt: string;
+            /**
+             * Reasons this approval is under review
+             */
+            reasons: Array<Attributes.Reason>;
+            /**
+             * When the approval was resolved
+             */
+            resolvedAt: string | null;
+            /**
+             * Approval status
+             */
+            status: 'pending' | 'approved' | 'denied' | 'canceled';
+            /**
+             * Product operation that needs approval
+             */
+            target: Attributes.Target;
+            /**
+             * When the approval was last updated
+             */
+            updatedAt: string;
+        }
+        namespace Attributes {
+            interface Reason {
+                /**
+                 * Actual transaction amount in minor units
+                 */
+                actualAmount: number;
+                /**
+                 * Currency code
+                 */
+                currency: string;
+                /**
+                 * Configured limit amount in minor units
+                 */
+                limitAmount: number;
+                limitType: string;
+                type: string;
+            }
+            /**
+             * Product operation that needs approval
+             */
+            interface Target {
+                /**
+                 * Product execution ID
+                 */
+                id: string;
+                /**
+                 * Product execution type under approval
+                 */
+                type: 'payment' | 'paymentRequestFulfillment' | 'deposit' | 'withdrawal';
+            }
+        }
+    }
+    interface Meta {
+        pagination: Meta.Pagination;
+    }
+    namespace Meta {
+        interface Pagination {
+            hasMore: boolean;
+            nextCursor: string | null;
+        }
+    }
+}
+export interface ApprovalApproveResponse {
+    data: ApprovalApproveResponse.Data;
+}
+export declare namespace ApprovalApproveResponse {
+    interface Data {
+        /**
+         * Approval ID
+         */
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource type
+         */
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * When the approval was created
+             */
+            createdAt: string;
+            /**
+             * Reasons this approval is under review
+             */
+            reasons: Array<Attributes.Reason>;
+            /**
+             * When the approval was resolved
+             */
+            resolvedAt: string | null;
+            /**
+             * Approval status
+             */
+            status: 'pending' | 'approved' | 'denied' | 'canceled';
+            /**
+             * Product operation that needs approval
+             */
+            target: Attributes.Target;
+            /**
+             * When the approval was last updated
+             */
+            updatedAt: string;
+        }
+        namespace Attributes {
+            interface Reason {
+                /**
+                 * Actual transaction amount in minor units
+                 */
+                actualAmount: number;
+                /**
+                 * Currency code
+                 */
+                currency: string;
+                /**
+                 * Configured limit amount in minor units
+                 */
+                limitAmount: number;
+                limitType: string;
+                type: string;
+            }
+            /**
+             * Product operation that needs approval
+             */
+            interface Target {
+                /**
+                 * Product execution ID
+                 */
+                id: string;
+                /**
+                 * Product execution type under approval
+                 */
+                type: 'payment' | 'paymentRequestFulfillment' | 'deposit' | 'withdrawal';
+            }
+        }
+    }
+}
+export interface ApprovalDenyResponse {
+    data: ApprovalDenyResponse.Data;
+}
+export declare namespace ApprovalDenyResponse {
+    interface Data {
+        /**
+         * Approval ID
+         */
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource type
+         */
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * When the approval was created
+             */
+            createdAt: string;
+            /**
+             * Reasons this approval is under review
+             */
+            reasons: Array<Attributes.Reason>;
+            /**
+             * When the approval was resolved
+             */
+            resolvedAt: string | null;
+            /**
+             * Approval status
+             */
+            status: 'pending' | 'approved' | 'denied' | 'canceled';
+            /**
+             * Product operation that needs approval
+             */
+            target: Attributes.Target;
+            /**
+             * When the approval was last updated
+             */
+            updatedAt: string;
+        }
+        namespace Attributes {
+            interface Reason {
+                /**
+                 * Actual transaction amount in minor units
+                 */
+                actualAmount: number;
+                /**
+                 * Currency code
+                 */
+                currency: string;
+                /**
+                 * Configured limit amount in minor units
+                 */
+                limitAmount: number;
+                limitType: string;
+                type: string;
+            }
+            /**
+             * Product operation that needs approval
+             */
+            interface Target {
+                /**
+                 * Product execution ID
+                 */
+                id: string;
+                /**
+                 * Product execution type under approval
+                 */
+                type: 'payment' | 'paymentRequestFulfillment' | 'deposit' | 'withdrawal';
+            }
+        }
+    }
+}
+export interface ApprovalGetResponse {
+    data: ApprovalGetResponse.Data;
+}
+export declare namespace ApprovalGetResponse {
+    interface Data {
+        /**
+         * Approval ID
+         */
+        id: string;
+        /**
+         * Resource attributes
+         */
+        attributes: Data.Attributes;
+        /**
+         * Resource type
+         */
+        type: string;
+    }
+    namespace Data {
+        /**
+         * Resource attributes
+         */
+        interface Attributes {
+            /**
+             * When the approval was created
+             */
+            createdAt: string;
+            /**
+             * Reasons this approval is under review
+             */
+            reasons: Array<Attributes.Reason>;
+            /**
+             * When the approval was resolved
+             */
+            resolvedAt: string | null;
+            /**
+             * Approval status
+             */
+            status: 'pending' | 'approved' | 'denied' | 'canceled';
+            /**
+             * Product operation that needs approval
+             */
+            target: Attributes.Target;
+            /**
+             * When the approval was last updated
+             */
+            updatedAt: string;
+        }
+        namespace Attributes {
+            interface Reason {
+                /**
+                 * Actual transaction amount in minor units
+                 */
+                actualAmount: number;
+                /**
+                 * Currency code
+                 */
+                currency: string;
+                /**
+                 * Configured limit amount in minor units
+                 */
+                limitAmount: number;
+                limitType: string;
+                type: string;
+            }
+            /**
+             * Product operation that needs approval
+             */
+            interface Target {
+                /**
+                 * Product execution ID
+                 */
+                id: string;
+                /**
+                 * Product execution type under approval
+                 */
+                type: 'payment' | 'paymentRequestFulfillment' | 'deposit' | 'withdrawal';
+            }
+        }
+    }
+}
+export interface ApprovalListParams {
+    /**
+     * Query param: Maximum number to return
+     */
+    limit?: number;
+    /**
+     * Query param: Approval status to list. Defaults to pending approvals.
+     */
+    status?: 'pending' | 'approved' | 'denied' | 'canceled';
+    /**
+     * 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 ApprovalApproveParams {
+    /**
+     * 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 ApprovalDenyParams {
+    /**
+     * 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 ApprovalGetParams {
+    /**
+     * 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 Approvals {
+    export { type ApprovalListResponse as ApprovalListResponse, type ApprovalApproveResponse as ApprovalApproveResponse, type ApprovalDenyResponse as ApprovalDenyResponse, type ApprovalGetResponse as ApprovalGetResponse, type ApprovalListParams as ApprovalListParams, type ApprovalApproveParams as ApprovalApproveParams, type ApprovalDenyParams as ApprovalDenyParams, type ApprovalGetParams as ApprovalGetParams, };
+}
+//# sourceMappingURL=approvals.d.mts.map

package/resources/approvals.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"approvals.d.mts","sourceRoot":"","sources":["../src/resources/approvals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,IAAI,CACF,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAenC;;OAEG;IACH,OAAO,CACL,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IActC;;OAEG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAcnC;;OAEG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAanC;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEvC,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;QAE5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAElC;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;YAEvD;;eAEG;YACH,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;YAE1B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,WAAW,EAAE,MAAM,CAAC;gBAEpB,SAAS,EAAE,MAAM,CAAC;gBAElB,IAAI,EAAE,MAAM,CAAC;aACd;YAED;;eAEG;YACH,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;mBAEG;gBACH,IAAI,EAAE,SAAS,GAAG,2BAA2B,GAAG,SAAS,GAAG,YAAY,CAAC;aAC1E;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,uBAAuB;IACtC,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,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAElC;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;YAEvD;;eAEG;YACH,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;YAE1B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,WAAW,EAAE,MAAM,CAAC;gBAEpB,SAAS,EAAE,MAAM,CAAC;gBAElB,IAAI,EAAE,MAAM,CAAC;aACd;YAED;;eAEG;YACH,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;mBAEG;gBACH,IAAI,EAAE,SAAS,GAAG,2BAA2B,GAAG,SAAS,GAAG,YAAY,CAAC;aAC1E;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;QAE5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAElC;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;YAEvD;;eAEG;YACH,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;YAE1B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,WAAW,EAAE,MAAM,CAAC;gBAEpB,SAAS,EAAE,MAAM,CAAC;gBAElB,IAAI,EAAE,MAAM,CAAC;aACd;YAED;;eAEG;YACH,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;mBAEG;gBACH,IAAI,EAAE,SAAS,GAAG,2BAA2B,GAAG,SAAS,GAAG,YAAY,CAAC;aAC1E;SACF;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;QAE5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAElC;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B;;eAEG;YACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;YAEvD;;eAEG;YACH,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;YAE1B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,WAAW,EAAE,MAAM,CAAC;gBAEpB,SAAS,EAAE,MAAM,CAAC;gBAElB,IAAI,EAAE,MAAM,CAAC;aACd;YAED;;eAEG;YACH,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;mBAEG;gBACH,IAAI,EAAE,SAAS,GAAG,2BAA2B,GAAG,SAAS,GAAG,YAAY,CAAC;aAC1E;SACF;KACF;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;IAExD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}