@naturalpay/sdk 0.7.0 → 0.9.0

package/src/resources/approvals.ts

@@ -0,0 +1,577 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Approval review operations
+ */
+export class Approvals extends APIResource {
+  /**
+   * List approvals for your party.
+   */
+  list(
+    params: ApprovalListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ApprovalListResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+    return this._client.get('/approvals', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Approve the product operation under review.
+   */
+  approve(
+    approvalID: string,
+    params: ApprovalApproveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ApprovalApproveResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params ?? {};
+    return this._client.post(path`/approvals/${approvalID}/approve`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Deny the product operation under review.
+   */
+  deny(
+    approvalID: string,
+    params: ApprovalDenyParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ApprovalDenyResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params ?? {};
+    return this._client.post(path`/approvals/${approvalID}/deny`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Get details of a specific approval.
+   */
+  get(
+    approvalID: string,
+    params: ApprovalGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ApprovalGetResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params ?? {};
+    return this._client.get(path`/approvals/${approvalID}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface ApprovalListResponse {
+  data: Array<ApprovalListResponse.Data>;
+
+  meta: ApprovalListResponse.Meta;
+}
+
+export namespace ApprovalListResponse {
+  export interface Data {
+    /**
+     * Approval ID
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export 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;
+    }
+
+    export namespace Attributes {
+      export 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
+       */
+      export interface Target {
+        /**
+         * Product execution ID
+         */
+        id: string;
+
+        /**
+         * Product execution type under approval
+         */
+        type: 'payment' | 'paymentRequestFulfillment' | 'deposit' | 'withdrawal';
+      }
+    }
+  }
+
+  export interface Meta {
+    pagination: Meta.Pagination;
+  }
+
+  export namespace Meta {
+    export interface Pagination {
+      hasMore: boolean;
+
+      nextCursor: string | null;
+    }
+  }
+}
+
+export interface ApprovalApproveResponse {
+  data: ApprovalApproveResponse.Data;
+}
+
+export namespace ApprovalApproveResponse {
+  export interface Data {
+    /**
+     * Approval ID
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export 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;
+    }
+
+    export namespace Attributes {
+      export 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
+       */
+      export interface Target {
+        /**
+         * Product execution ID
+         */
+        id: string;
+
+        /**
+         * Product execution type under approval
+         */
+        type: 'payment' | 'paymentRequestFulfillment' | 'deposit' | 'withdrawal';
+      }
+    }
+  }
+}
+
+export interface ApprovalDenyResponse {
+  data: ApprovalDenyResponse.Data;
+}
+
+export namespace ApprovalDenyResponse {
+  export interface Data {
+    /**
+     * Approval ID
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export 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;
+    }
+
+    export namespace Attributes {
+      export 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
+       */
+      export interface Target {
+        /**
+         * Product execution ID
+         */
+        id: string;
+
+        /**
+         * Product execution type under approval
+         */
+        type: 'payment' | 'paymentRequestFulfillment' | 'deposit' | 'withdrawal';
+      }
+    }
+  }
+}
+
+export interface ApprovalGetResponse {
+  data: ApprovalGetResponse.Data;
+}
+
+export namespace ApprovalGetResponse {
+  export interface Data {
+    /**
+     * Approval ID
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export 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;
+    }
+
+    export namespace Attributes {
+      export 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
+       */
+      export 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,
+  };
+}

package/src/resources/customers.ts

@@ -185,7 +185,7 @@ export namespace CustomerListResponse {
              */
             export interface Limits {
               /**
-               * Positive per-transaction limit in cents. null means no per-payment limit.
+               * Positive per-transaction limit in cents. null means no per-transaction limit.
                */
               perTransaction?: number | null;
             }
@@ -395,7 +395,7 @@ export namespace CustomerGetResponse {
              */
             export interface Limits {
               /**
-               * Positive per-transaction limit in cents. null means no per-payment limit.
+               * Positive per-transaction limit in cents. null means no per-transaction limit.
                */
               perTransaction?: number | null;
             }

package/src/resources/index.ts

@@ -32,6 +32,17 @@ export {
   type AgentRemoveParams,
   type AgentRemoveCustomerParams,
 } from './agents';
+export {
+  Approvals,
+  type ApprovalListResponse,
+  type ApprovalApproveResponse,
+  type ApprovalDenyResponse,
+  type ApprovalGetResponse,
+  type ApprovalListParams,
+  type ApprovalApproveParams,
+  type ApprovalDenyParams,
+  type ApprovalGetParams,
+} from './approvals';
 export { Counterparties, type CounterpartyListResponse, type CounterpartyListParams } from './counterparties';
 export {
   Customers,

package/src/resources/payment-requests.ts

@@ -150,7 +150,7 @@ export class PaymentRequests extends APIResource {
   }
 
   /**
-   * Get a single payment request visible to the authenticated requester party.
+   * Get a single payment request visible to the authenticated participant party.
    *
    * @example
    * ```ts

package/src/resources/transfers.ts

@@ -71,7 +71,7 @@ export class Transfers extends APIResource {
    * @example
    * ```ts
    * const response = await client.transfers.initiateDeposit({
-   *   amount: 1,
+   *   amount: 100,
    *   externalAccountId: 'eac_ecc2efdd09bd231a9ad9bd2aada37aa7',
    *   'Idempotency-Key': 'Idempotency-Key',
    * });

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.7.0'; // x-release-please-version
+export const VERSION = '0.9.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.7.0";
+export declare const VERSION = "0.9.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.7.0";
+export declare const VERSION = "0.9.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.7.0'; // x-release-please-version
+exports.VERSION = '0.9.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.7.0'; // x-release-please-version
+export const VERSION = '0.9.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map