@naturalpay/sdk 1.3.0 → 1.6.0

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@naturalpay/sdk",
-        "X-Fern-SDK-Version": "1.3.0",
-        "User-Agent": "@naturalpay/sdk/1.3.0",
+        "X-Fern-SDK-Version": "1.6.0",
+        "User-Agent": "@naturalpay/sdk/1.6.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Agent-ID": options === null || options === void 0 ? void 0 : options.agentId,

package/dist/cjs/Client.d.ts

@@ -1,3 +1,4 @@
+import { AchClient } from "./api/resources/ach/client/Client.js";
 import { AgentKeysClient } from "./api/resources/agentKeys/client/Client.js";
 import { AgentsClient } from "./api/resources/agents/client/Client.js";
 import { ApiKeysClient } from "./api/resources/apiKeys/client/Client.js";
@@ -5,6 +6,8 @@ import { ApprovalsClient } from "./api/resources/approvals/client/Client.js";
 import { CustomersClient } from "./api/resources/customers/client/Client.js";
 import { EventsClient } from "./api/resources/events/client/Client.js";
 import { ExternalAccountsClient } from "./api/resources/externalAccounts/client/Client.js";
+import { ExternalPartiesClient } from "./api/resources/externalParties/client/Client.js";
+import { ExternalPartyAccountsClient } from "./api/resources/externalPartyAccounts/client/Client.js";
 import { InvitationLinksClient } from "./api/resources/invitationLinks/client/Client.js";
 import { InvitationsClient } from "./api/resources/invitations/client/Client.js";
 import { PartiesClient } from "./api/resources/parties/client/Client.js";
@@ -37,6 +40,9 @@ export declare class NaturalClient {
     protected _parties: PartiesClient | undefined;
     protected _wallets: WalletsClient | undefined;
     protected _externalAccounts: ExternalAccountsClient | undefined;
+    protected _externalParties: ExternalPartiesClient | undefined;
+    protected _externalPartyAccounts: ExternalPartyAccountsClient | undefined;
+    protected _ach: AchClient | undefined;
     protected _apiKeys: ApiKeysClient | undefined;
     protected _agentKeys: AgentKeysClient | undefined;
     protected _webhooks: WebhooksClient | undefined;
@@ -55,6 +61,9 @@ export declare class NaturalClient {
     get parties(): PartiesClient;
     get wallets(): WalletsClient;
     get externalAccounts(): ExternalAccountsClient;
+    get externalParties(): ExternalPartiesClient;
+    get externalPartyAccounts(): ExternalPartyAccountsClient;
+    get ach(): AchClient;
     get apiKeys(): ApiKeysClient;
     get agentKeys(): AgentKeysClient;
     get webhooks(): WebhooksClient;

package/dist/cjs/Client.js

@@ -44,23 +44,26 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NaturalClient = void 0;
-const Client_js_1 = require("./api/resources/agentKeys/client/Client.js");
-const Client_js_2 = require("./api/resources/agents/client/Client.js");
-const Client_js_3 = require("./api/resources/apiKeys/client/Client.js");
-const Client_js_4 = require("./api/resources/approvals/client/Client.js");
-const Client_js_5 = require("./api/resources/customers/client/Client.js");
-const Client_js_6 = require("./api/resources/events/client/Client.js");
-const Client_js_7 = require("./api/resources/externalAccounts/client/Client.js");
-const Client_js_8 = require("./api/resources/invitationLinks/client/Client.js");
-const Client_js_9 = require("./api/resources/invitations/client/Client.js");
-const Client_js_10 = require("./api/resources/parties/client/Client.js");
-const Client_js_11 = require("./api/resources/paymentRequests/client/Client.js");
-const Client_js_12 = require("./api/resources/payments/client/Client.js");
-const Client_js_13 = require("./api/resources/simulations/client/Client.js");
-const Client_js_14 = require("./api/resources/transactions/client/Client.js");
-const Client_js_15 = require("./api/resources/transfers/client/Client.js");
-const Client_js_16 = require("./api/resources/wallets/client/Client.js");
-const Client_js_17 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_1 = require("./api/resources/ach/client/Client.js");
+const Client_js_2 = require("./api/resources/agentKeys/client/Client.js");
+const Client_js_3 = require("./api/resources/agents/client/Client.js");
+const Client_js_4 = require("./api/resources/apiKeys/client/Client.js");
+const Client_js_5 = require("./api/resources/approvals/client/Client.js");
+const Client_js_6 = require("./api/resources/customers/client/Client.js");
+const Client_js_7 = require("./api/resources/events/client/Client.js");
+const Client_js_8 = require("./api/resources/externalAccounts/client/Client.js");
+const Client_js_9 = require("./api/resources/externalParties/client/Client.js");
+const Client_js_10 = require("./api/resources/externalPartyAccounts/client/Client.js");
+const Client_js_11 = require("./api/resources/invitationLinks/client/Client.js");
+const Client_js_12 = require("./api/resources/invitations/client/Client.js");
+const Client_js_13 = require("./api/resources/parties/client/Client.js");
+const Client_js_14 = require("./api/resources/paymentRequests/client/Client.js");
+const Client_js_15 = require("./api/resources/payments/client/Client.js");
+const Client_js_16 = require("./api/resources/simulations/client/Client.js");
+const Client_js_17 = require("./api/resources/transactions/client/Client.js");
+const Client_js_18 = require("./api/resources/transfers/client/Client.js");
+const Client_js_19 = require("./api/resources/wallets/client/Client.js");
+const Client_js_20 = require("./api/resources/webhooks/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 class NaturalClient {
@@ -69,71 +72,83 @@ class NaturalClient {
     }
     get agents() {
         var _a;
-        return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_js_2.AgentsClient(this._options)));
+        return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_js_3.AgentsClient(this._options)));
     }
     get customers() {
         var _a;
-        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_js_5.CustomersClient(this._options)));
+        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_js_6.CustomersClient(this._options)));
     }
     get invitationLinks() {
         var _a;
-        return ((_a = this._invitationLinks) !== null && _a !== void 0 ? _a : (this._invitationLinks = new Client_js_8.InvitationLinksClient(this._options)));
+        return ((_a = this._invitationLinks) !== null && _a !== void 0 ? _a : (this._invitationLinks = new Client_js_11.InvitationLinksClient(this._options)));
     }
     get payments() {
         var _a;
-        return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_js_12.PaymentsClient(this._options)));
+        return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_js_15.PaymentsClient(this._options)));
     }
     get transactions() {
         var _a;
-        return ((_a = this._transactions) !== null && _a !== void 0 ? _a : (this._transactions = new Client_js_14.TransactionsClient(this._options)));
+        return ((_a = this._transactions) !== null && _a !== void 0 ? _a : (this._transactions = new Client_js_17.TransactionsClient(this._options)));
     }
     get transfers() {
         var _a;
-        return ((_a = this._transfers) !== null && _a !== void 0 ? _a : (this._transfers = new Client_js_15.TransfersClient(this._options)));
+        return ((_a = this._transfers) !== null && _a !== void 0 ? _a : (this._transfers = new Client_js_18.TransfersClient(this._options)));
     }
     get paymentRequests() {
         var _a;
-        return ((_a = this._paymentRequests) !== null && _a !== void 0 ? _a : (this._paymentRequests = new Client_js_11.PaymentRequestsClient(this._options)));
+        return ((_a = this._paymentRequests) !== null && _a !== void 0 ? _a : (this._paymentRequests = new Client_js_14.PaymentRequestsClient(this._options)));
     }
     get approvals() {
         var _a;
-        return ((_a = this._approvals) !== null && _a !== void 0 ? _a : (this._approvals = new Client_js_4.ApprovalsClient(this._options)));
+        return ((_a = this._approvals) !== null && _a !== void 0 ? _a : (this._approvals = new Client_js_5.ApprovalsClient(this._options)));
     }
     get invitations() {
         var _a;
-        return ((_a = this._invitations) !== null && _a !== void 0 ? _a : (this._invitations = new Client_js_9.InvitationsClient(this._options)));
+        return ((_a = this._invitations) !== null && _a !== void 0 ? _a : (this._invitations = new Client_js_12.InvitationsClient(this._options)));
     }
     get parties() {
         var _a;
-        return ((_a = this._parties) !== null && _a !== void 0 ? _a : (this._parties = new Client_js_10.PartiesClient(this._options)));
+        return ((_a = this._parties) !== null && _a !== void 0 ? _a : (this._parties = new Client_js_13.PartiesClient(this._options)));
     }
     get wallets() {
         var _a;
-        return ((_a = this._wallets) !== null && _a !== void 0 ? _a : (this._wallets = new Client_js_16.WalletsClient(this._options)));
+        return ((_a = this._wallets) !== null && _a !== void 0 ? _a : (this._wallets = new Client_js_19.WalletsClient(this._options)));
     }
     get externalAccounts() {
         var _a;
-        return ((_a = this._externalAccounts) !== null && _a !== void 0 ? _a : (this._externalAccounts = new Client_js_7.ExternalAccountsClient(this._options)));
+        return ((_a = this._externalAccounts) !== null && _a !== void 0 ? _a : (this._externalAccounts = new Client_js_8.ExternalAccountsClient(this._options)));
+    }
+    get externalParties() {
+        var _a;
+        return ((_a = this._externalParties) !== null && _a !== void 0 ? _a : (this._externalParties = new Client_js_9.ExternalPartiesClient(this._options)));
+    }
+    get externalPartyAccounts() {
+        var _a;
+        return ((_a = this._externalPartyAccounts) !== null && _a !== void 0 ? _a : (this._externalPartyAccounts = new Client_js_10.ExternalPartyAccountsClient(this._options)));
+    }
+    get ach() {
+        var _a;
+        return ((_a = this._ach) !== null && _a !== void 0 ? _a : (this._ach = new Client_js_1.AchClient(this._options)));
     }
     get apiKeys() {
         var _a;
-        return ((_a = this._apiKeys) !== null && _a !== void 0 ? _a : (this._apiKeys = new Client_js_3.ApiKeysClient(this._options)));
+        return ((_a = this._apiKeys) !== null && _a !== void 0 ? _a : (this._apiKeys = new Client_js_4.ApiKeysClient(this._options)));
     }
     get agentKeys() {
         var _a;
-        return ((_a = this._agentKeys) !== null && _a !== void 0 ? _a : (this._agentKeys = new Client_js_1.AgentKeysClient(this._options)));
+        return ((_a = this._agentKeys) !== null && _a !== void 0 ? _a : (this._agentKeys = new Client_js_2.AgentKeysClient(this._options)));
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_17.WebhooksClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_20.WebhooksClient(this._options)));
     }
     get events() {
         var _a;
-        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_js_6.EventsClient(this._options)));
+        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_js_7.EventsClient(this._options)));
     }
     get simulations() {
         var _a;
-        return ((_a = this._simulations) !== null && _a !== void 0 ? _a : (this._simulations = new Client_js_13.SimulationsClient(this._options)));
+        return ((_a = this._simulations) !== null && _a !== void 0 ? _a : (this._simulations = new Client_js_16.SimulationsClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/cjs/api/resources/ach/client/Client.d.ts

@@ -0,0 +1,132 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Natural from "../../../index.js";
+export declare namespace AchClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Make ACH payments to external party accounts
+ */
+export declare class AchClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AchClient.Options>;
+    constructor(options?: AchClient.Options);
+    /**
+     * List your ACH payments
+     *
+     * @param {Natural.ListAchRequest} request
+     * @param {AchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.ach.list()
+     */
+    list(request?: Natural.ListAchRequest, requestOptions?: AchClient.RequestOptions): Promise<core.Page<Natural.ListAchResponseDataItem, Natural.Ach>>;
+    /**
+     * Create an ACH payment to an external party account
+     *
+     * @param {Natural.NewAchParams} request
+     * @param {AchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.ach.create({
+     *         idempotencyKey: "Idempotency-Key",
+     *         direction: "credit",
+     *         amount: 25000,
+     *         currency: "USD",
+     *         externalPartyAccountId: "epa_550e8400e29b41d4a716446655440000",
+     *         companyEntryDescription: "PAYOUT"
+     *     })
+     */
+    create(request: Natural.NewAchParams, requestOptions?: AchClient.RequestOptions): core.HttpResponsePromise<Natural.NewAch>;
+    private __create;
+    /**
+     * Get an ACH payment
+     *
+     * @param {Natural.GetAchRequest} request
+     * @param {AchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.ach.get({
+     *         achId: "achId"
+     *     })
+     */
+    get(request: Natural.GetAchRequest, requestOptions?: AchClient.RequestOptions): core.HttpResponsePromise<Natural.AchDetail>;
+    private __get;
+    /**
+     * Cancel an ACH payment before submission
+     *
+     * @param {Natural.CancelAchParams} request
+     * @param {AchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.ach.cancel({
+     *         idempotencyKey: "Idempotency-Key",
+     *         achId: "achId",
+     *         reason: "Duplicate payout"
+     *     })
+     */
+    cancel(request: Natural.CancelAchParams, requestOptions?: AchClient.RequestOptions): core.HttpResponsePromise<Natural.CancelledAch>;
+    private __cancel;
+}