@naturalpay/sdk 1.6.10 → 1.6.12

package/dist/cjs/api/resources/simulations/types/index.d.ts

@@ -90,6 +90,11 @@ export * from "./FailRealtimeSimulationsResponseData.js";
 export * from "./FailRealtimeSimulationsResponseDataAttributes.js";
 export * from "./FailRealtimeSimulationsResponseDataAttributesAction.js";
 export * from "./FailRealtimeSimulationsResponseDataType.js";
+export * from "./FailWireSimulationsResponse.js";
+export * from "./FailWireSimulationsResponseData.js";
+export * from "./FailWireSimulationsResponseDataAttributes.js";
+export * from "./FailWireSimulationsResponseDataAttributesAction.js";
+export * from "./FailWireSimulationsResponseDataType.js";
 export * from "./FulfillPaymentRequestSimulationsResponse.js";
 export * from "./FulfillPaymentRequestSimulationsResponseData.js";
 export * from "./FulfillPaymentRequestSimulationsResponseDataAttributes.js";
@@ -198,3 +203,8 @@ export * from "./SettleRealtimeSimulationsResponseData.js";
 export * from "./SettleRealtimeSimulationsResponseDataAttributes.js";
 export * from "./SettleRealtimeSimulationsResponseDataAttributesAction.js";
 export * from "./SettleRealtimeSimulationsResponseDataType.js";
+export * from "./SettleWireSimulationsResponse.js";
+export * from "./SettleWireSimulationsResponseData.js";
+export * from "./SettleWireSimulationsResponseDataAttributes.js";
+export * from "./SettleWireSimulationsResponseDataAttributesAction.js";
+export * from "./SettleWireSimulationsResponseDataType.js";

package/dist/cjs/api/resources/simulations/types/index.js

@@ -106,6 +106,11 @@ __exportStar(require("./FailRealtimeSimulationsResponseData.js"), exports);
 __exportStar(require("./FailRealtimeSimulationsResponseDataAttributes.js"), exports);
 __exportStar(require("./FailRealtimeSimulationsResponseDataAttributesAction.js"), exports);
 __exportStar(require("./FailRealtimeSimulationsResponseDataType.js"), exports);
+__exportStar(require("./FailWireSimulationsResponse.js"), exports);
+__exportStar(require("./FailWireSimulationsResponseData.js"), exports);
+__exportStar(require("./FailWireSimulationsResponseDataAttributes.js"), exports);
+__exportStar(require("./FailWireSimulationsResponseDataAttributesAction.js"), exports);
+__exportStar(require("./FailWireSimulationsResponseDataType.js"), exports);
 __exportStar(require("./FulfillPaymentRequestSimulationsResponse.js"), exports);
 __exportStar(require("./FulfillPaymentRequestSimulationsResponseData.js"), exports);
 __exportStar(require("./FulfillPaymentRequestSimulationsResponseDataAttributes.js"), exports);
@@ -214,3 +219,8 @@ __exportStar(require("./SettleRealtimeSimulationsResponseData.js"), exports);
 __exportStar(require("./SettleRealtimeSimulationsResponseDataAttributes.js"), exports);
 __exportStar(require("./SettleRealtimeSimulationsResponseDataAttributesAction.js"), exports);
 __exportStar(require("./SettleRealtimeSimulationsResponseDataType.js"), exports);
+__exportStar(require("./SettleWireSimulationsResponse.js"), exports);
+__exportStar(require("./SettleWireSimulationsResponseData.js"), exports);
+__exportStar(require("./SettleWireSimulationsResponseDataAttributes.js"), exports);
+__exportStar(require("./SettleWireSimulationsResponseDataAttributesAction.js"), exports);
+__exportStar(require("./SettleWireSimulationsResponseDataType.js"), exports);

package/dist/cjs/api/resources/transactions/types/ListTransactionsRequestType.d.ts

@@ -2,6 +2,7 @@
 export declare const ListTransactionsRequestType: {
     readonly Payment: "payment";
     readonly Transfer: "transfer";
+    readonly Refund: "refund";
     readonly All: "all";
 };
 export type ListTransactionsRequestType = (typeof ListTransactionsRequestType)[keyof typeof ListTransactionsRequestType];

package/dist/cjs/api/resources/transactions/types/ListTransactionsRequestType.js

@@ -6,5 +6,6 @@ exports.ListTransactionsRequestType = void 0;
 exports.ListTransactionsRequestType = {
     Payment: "payment",
     Transfer: "transfer",
+    Refund: "refund",
     All: "all",
 };

package/dist/cjs/api/resources/transactions/types/TxnDetailTransactionType.d.ts

@@ -2,5 +2,6 @@
 export declare const TxnDetailTransactionType: {
     readonly Payment: "payment";
     readonly Transfer: "transfer";
+    readonly Refund: "refund";
 };
 export type TxnDetailTransactionType = (typeof TxnDetailTransactionType)[keyof typeof TxnDetailTransactionType];

package/dist/cjs/api/resources/transactions/types/TxnDetailTransactionType.js

@@ -6,4 +6,5 @@ exports.TxnDetailTransactionType = void 0;
 exports.TxnDetailTransactionType = {
     Payment: "payment",
     Transfer: "transfer",
+    Refund: "refund",
 };

package/dist/cjs/api/resources/transactions/types/TxnTransactionType.d.ts

@@ -2,5 +2,6 @@
 export declare const TxnTransactionType: {
     readonly Payment: "payment";
     readonly Transfer: "transfer";
+    readonly Refund: "refund";
 };
 export type TxnTransactionType = (typeof TxnTransactionType)[keyof typeof TxnTransactionType];

package/dist/cjs/api/resources/transactions/types/TxnTransactionType.js

@@ -6,4 +6,5 @@ exports.TxnTransactionType = void 0;
 exports.TxnTransactionType = {
     Payment: "payment",
     Transfer: "transfer",
+    Refund: "refund",
 };

package/dist/cjs/api/resources/webhooks/types/CreateWebhooksRequestEnabledEventsItem.d.ts

@@ -43,6 +43,11 @@ export declare const CreateWebhooksRequestEnabledEventsItem: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/cjs/api/resources/webhooks/types/CreateWebhooksRequestEnabledEventsItem.js

@@ -47,6 +47,11 @@ exports.CreateWebhooksRequestEnabledEventsItem = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/cjs/api/resources/webhooks/types/CreateWebhooksResponseDataAttributesEnabledEventsItem.d.ts

@@ -43,6 +43,11 @@ export declare const CreateWebhooksResponseDataAttributesEnabledEventsItem: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/cjs/api/resources/webhooks/types/CreateWebhooksResponseDataAttributesEnabledEventsItem.js

@@ -47,6 +47,11 @@ exports.CreateWebhooksResponseDataAttributesEnabledEventsItem = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/cjs/api/resources/webhooks/types/GetWebhooksResponseDataAttributesEnabledEventsItem.d.ts

@@ -43,6 +43,11 @@ export declare const GetWebhooksResponseDataAttributesEnabledEventsItem: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/cjs/api/resources/webhooks/types/GetWebhooksResponseDataAttributesEnabledEventsItem.js

@@ -47,6 +47,11 @@ exports.GetWebhooksResponseDataAttributesEnabledEventsItem = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/cjs/api/resources/webhooks/types/RemoveWebhooksResponseDataAttributesEnabledEventsItem.d.ts

@@ -43,6 +43,11 @@ export declare const RemoveWebhooksResponseDataAttributesEnabledEventsItem: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/cjs/api/resources/webhooks/types/RemoveWebhooksResponseDataAttributesEnabledEventsItem.js

@@ -47,6 +47,11 @@ exports.RemoveWebhooksResponseDataAttributesEnabledEventsItem = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/cjs/api/resources/webhooks/types/UpdateWebhooksRequestEnabledEventsItem.d.ts

@@ -43,6 +43,11 @@ export declare const UpdateWebhooksRequestEnabledEventsItem: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/cjs/api/resources/webhooks/types/UpdateWebhooksRequestEnabledEventsItem.js

@@ -47,6 +47,11 @@ exports.UpdateWebhooksRequestEnabledEventsItem = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/cjs/api/resources/webhooks/types/UpdateWebhooksResponseDataAttributesEnabledEventsItem.d.ts

@@ -43,6 +43,11 @@ export declare const UpdateWebhooksResponseDataAttributesEnabledEventsItem: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/cjs/api/resources/webhooks/types/UpdateWebhooksResponseDataAttributesEnabledEventsItem.js

@@ -47,6 +47,11 @@ exports.UpdateWebhooksResponseDataAttributesEnabledEventsItem = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/cjs/api/resources/webhooks/types/WebhookEnabledEventsItem.d.ts

@@ -43,6 +43,11 @@ export declare const WebhookEnabledEventsItem: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/cjs/api/resources/webhooks/types/WebhookEnabledEventsItem.js

@@ -47,6 +47,11 @@ exports.WebhookEnabledEventsItem = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/cjs/api/resources/wire/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 WireClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Send domestic wires to external party accounts
+ */
+export declare class WireClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<WireClient.Options>;
+    constructor(options?: WireClient.Options);
+    /**
+     * List your wire payments
+     *
+     * @param {Natural.ListWireRequest} request
+     * @param {WireClient.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.wire.list()
+     */
+    list(request?: Natural.ListWireRequest, requestOptions?: WireClient.RequestOptions): core.HttpResponsePromise<Natural.ListWireResponse>;
+    private __list;
+    /**
+     * Create a wire payment to an external party account
+     *
+     * @param {Natural.CreateWireRequest} request
+     * @param {WireClient.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.wire.create({
+     *         idempotencyKey: "Idempotency-Key",
+     *         amount: 25000,
+     *         currency: "USD",
+     *         externalPartyAccountId: "epa_550e8400e29b41d4a716446655440000",
+     *         description: "Invoice 1042 settlement"
+     *     })
+     */
+    create(request: Natural.CreateWireRequest, requestOptions?: WireClient.RequestOptions): core.HttpResponsePromise<Natural.CreateWireResponse>;
+    private __create;
+    /**
+     * Get a wire payment
+     *
+     * @param {Natural.GetWireRequest} request
+     * @param {WireClient.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.wire.get({
+     *         wireId: "wireId"
+     *     })
+     */
+    get(request: Natural.GetWireRequest, requestOptions?: WireClient.RequestOptions): core.HttpResponsePromise<Natural.GetWireResponse>;
+    private __get;
+    /**
+     * Cancel a wire payment before submission
+     *
+     * @param {Natural.CancelWireRequest} request
+     * @param {WireClient.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.wire.cancel({
+     *         idempotencyKey: "Idempotency-Key",
+     *         wireId: "wireId",
+     *         reason: "Duplicate payment"
+     *     })
+     */
+    cancel(request: Natural.CancelWireRequest, requestOptions?: WireClient.RequestOptions): core.HttpResponsePromise<Natural.CancelWireResponse>;
+    private __cancel;
+}