@payabli/sdk-node 0.0.134 → 0.0.136

package/dist/esm/api/resources/payoutSubscription/client/Client.mjs

@@ -0,0 +1,348 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as Payabli from "../../../index.mjs";
+export class PayoutSubscriptionClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Creates a payout subscription to automatically send payouts to a vendor on a recurring schedule. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for a step-by-step guide.
+     *
+     * @param {Payabli.RequestPayoutSchedule} request
+     * @param {PayoutSubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.payoutSubscription.createPayoutSubscription({
+     *         body: {
+     *             entryPoint: "d193cf9a46",
+     *             paymentMethod: {
+     *                 method: "ach",
+     *                 achHolder: "Herman Coatings",
+     *                 achRouting: "021000021",
+     *                 achAccount: "3453445666",
+     *                 achAccountType: "checking"
+     *             },
+     *             paymentDetails: {
+     *                 totalAmount: 500,
+     *                 serviceFee: 0,
+     *                 currency: "USD"
+     *             },
+     *             vendorData: {
+     *                 vendorId: 1501
+     *             },
+     *             billData: [{
+     *                     invoiceNumber: "INV-5001",
+     *                     netAmount: "500",
+     *                     invoiceDate: "2025-08-01",
+     *                     dueDate: "2025-08-15"
+     *                 }],
+     *             scheduleDetails: {
+     *                 startDate: "09/01/2025",
+     *                 endDate: "09/01/2026",
+     *                 frequency: "monthly"
+     *             }
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.payoutSubscription.createPayoutSubscription({
+     *         body: {
+     *             entryPoint: "d193cf9a46",
+     *             paymentMethod: {
+     *                 method: "vcard"
+     *             },
+     *             paymentDetails: {
+     *                 totalAmount: 250,
+     *                 serviceFee: 0
+     *             },
+     *             vendorData: {
+     *                 vendorId: 1501
+     *             },
+     *             billData: [{
+     *                     invoiceNumber: "INV-7820",
+     *                     netAmount: "250",
+     *                     invoiceDate: "2025-08-15",
+     *                     dueDate: "2025-09-01"
+     *                 }],
+     *             scheduleDetails: {
+     *                 startDate: "09/01/2025",
+     *                 frequency: "weekly",
+     *                 endDate: "untilcancelled"
+     *             }
+     *         }
+     *     })
+     */
+    createPayoutSubscription(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createPayoutSubscription(request, requestOptions));
+    }
+    __createPayoutSubscription(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { idempotencyKey, body: _body } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ idempotencyKey: idempotencyKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, "PayoutSubscription"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: _body,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PayabliError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/PayoutSubscription");
+        });
+    }
+    /**
+     * Retrieves a single payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {number} id - The payout subscription ID.
+     * @param {PayoutSubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.payoutSubscription.getPayoutSubscription(42)
+     */
+    getPayoutSubscription(id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getPayoutSubscription(id, requestOptions));
+    }
+    __getPayoutSubscription(id, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `PayoutSubscription/${core.url.encodePathParam(id)}`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PayabliError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/PayoutSubscription/{id}");
+        });
+    }
+    /**
+     * Updates a payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {number} id - The payout subscription ID.
+     * @param {Payabli.UpdatePayoutSubscriptionBody} request
+     * @param {PayoutSubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.payoutSubscription.updatePayoutSubscription(42, {
+     *         setPause: true
+     *     })
+     *
+     * @example
+     *     await client.payoutSubscription.updatePayoutSubscription(42, {
+     *         setPause: false
+     *     })
+     *
+     * @example
+     *     await client.payoutSubscription.updatePayoutSubscription(42, {
+     *         paymentDetails: {
+     *             serviceFee: 0,
+     *             totalAmount: 750
+     *         },
+     *         scheduleDetails: {
+     *             endDate: "12/31/2026",
+     *             frequency: "monthly",
+     *             startDate: "01/01/2026"
+     *         }
+     *     })
+     */
+    updatePayoutSubscription(id, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updatePayoutSubscription(id, request, requestOptions));
+    }
+    __updatePayoutSubscription(id, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `PayoutSubscription/${core.url.encodePathParam(id)}`),
+                method: "PUT",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PayabliError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/PayoutSubscription/{id}");
+        });
+    }
+    /**
+     * Deletes a payout subscription and prevents future payouts. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {number} id - The payout subscription ID.
+     * @param {PayoutSubscriptionClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.payoutSubscription.deletePayoutSubscription(42)
+     */
+    deletePayoutSubscription(id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deletePayoutSubscription(id, requestOptions));
+    }
+    __deletePayoutSubscription(id, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `PayoutSubscription/${core.url.encodePathParam(id)}`),
+                method: "DELETE",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PayabliError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/PayoutSubscription/{id}");
+        });
+    }
+}

package/dist/esm/api/resources/payoutSubscription/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/payoutSubscription/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.mts

@@ -0,0 +1,67 @@
+import type * as Payabli from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         body: {
+ *             entryPoint: "d193cf9a46",
+ *             paymentMethod: {
+ *                 method: "ach",
+ *                 achHolder: "Herman Coatings",
+ *                 achRouting: "021000021",
+ *                 achAccount: "3453445666",
+ *                 achAccountType: "checking"
+ *             },
+ *             paymentDetails: {
+ *                 totalAmount: 500,
+ *                 serviceFee: 0,
+ *                 currency: "USD"
+ *             },
+ *             vendorData: {
+ *                 vendorId: 1501
+ *             },
+ *             billData: [{
+ *                     invoiceNumber: "INV-5001",
+ *                     netAmount: "500",
+ *                     invoiceDate: "2025-08-01",
+ *                     dueDate: "2025-08-15"
+ *                 }],
+ *             scheduleDetails: {
+ *                 startDate: "09/01/2025",
+ *                 endDate: "09/01/2026",
+ *                 frequency: "monthly"
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         body: {
+ *             entryPoint: "d193cf9a46",
+ *             paymentMethod: {
+ *                 method: "vcard"
+ *             },
+ *             paymentDetails: {
+ *                 totalAmount: 250,
+ *                 serviceFee: 0
+ *             },
+ *             vendorData: {
+ *                 vendorId: 1501
+ *             },
+ *             billData: [{
+ *                     invoiceNumber: "INV-7820",
+ *                     netAmount: "250",
+ *                     invoiceDate: "2025-08-15",
+ *                     dueDate: "2025-09-01"
+ *                 }],
+ *             scheduleDetails: {
+ *                 startDate: "09/01/2025",
+ *                 frequency: "weekly",
+ *                 endDate: "untilcancelled"
+ *             }
+ *         }
+ *     }
+ */
+export interface RequestPayoutSchedule {
+    idempotencyKey?: Payabli.IdempotencyKey;
+    body: Payabli.PayoutSubscriptionRequestBody;
+}

package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/payoutSubscription/client/requests/index.d.mts

@@ -0,0 +1 @@
+export type { RequestPayoutSchedule } from "./RequestPayoutSchedule.mjs";

package/dist/esm/api/resources/payoutSubscription/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/payoutSubscription/exports.d.mts

@@ -0,0 +1,2 @@
+export { PayoutSubscriptionClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/payoutSubscription/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { PayoutSubscriptionClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/payoutSubscription/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/payoutSubscription/index.mjs

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.mts

@@ -0,0 +1,20 @@
+import type * as Payabli from "../../../index.mjs";
+/**
+ * Success response
+ *
+ * @example
+ *     {
+ *         responseText: "Success",
+ *         isSuccess: true,
+ *         responseData: 42,
+ *         customerId: 1501
+ *     }
+ */
+export interface AddPayoutSubscriptionResponse {
+    isSuccess?: Payabli.IsSuccess | undefined;
+    responseText: Payabli.ResponseText;
+    /** The identifier of the newly created payout subscription. */
+    responseData: number;
+    /** The identifier of the vendor associated with the payout subscription. */
+    customerId?: Payabli.CustomerId | undefined;
+}

package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.mts

@@ -0,0 +1,14 @@
+import type * as Payabli from "../../../index.mjs";
+/**
+ * Success response
+ */
+export interface DeletePayoutSubscriptionResponse {
+    isSuccess?: Payabli.IsSuccess | undefined;
+    /**
+     * If `isSuccess` = true, this contains the identifier of the payout subscription.
+     *
+     * If `isSuccess` = false, this contains the reason for the failure.
+     */
+    responseData?: string | undefined;
+    responseText: Payabli.ResponseText;
+}

package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.mts

@@ -0,0 +1,151 @@
+import type * as Payabli from "../../../index.mjs";
+/**
+ * Success response
+ *
+ * @example
+ *     {
+ *         responseText: "Success",
+ *         isSuccess: true,
+ *         responseData: {
+ *             idOutSubscription: 42,
+ *             status: 1,
+ *             events: [{
+ *                     description: "TransferCreated",
+ *                     eventTime: "2025-09-01T06:00:00Z",
+ *                     extraData: {
+ *                         "key": "value"
+ *                     },
+ *                     refData: "refData",
+ *                     source: "api"
+ *                 }],
+ *             vendor: {
+ *                 VendorNumber: "1234",
+ *                 Name1: "Herman's Coatings",
+ *                 Name2: "Herman's Coating Supply Company, LLC",
+ *                 EIN: "123456789",
+ *                 Phone: "2125551234",
+ *                 Email: "example@email.com",
+ *                 Address1: "123 Ocean Drive",
+ *                 Address2: "Suite 400",
+ *                 City: "Bristol",
+ *                 State: "GA",
+ *                 Zip: "31113",
+ *                 Country: "US",
+ *                 Mcc: "7777",
+ *                 LocationCode: "LOC123",
+ *                 Contacts: {
+ *                     ContactEmail: "eric@martinezcoatings.com",
+ *                     ContactName: "Eric Martinez",
+ *                     ContactPhone: "5555555555",
+ *                     ContactTitle: "Owner"
+ *                 },
+ *                 BillingData: {
+ *                     id: 123456,
+ *                     accountId: "bank-account-001",
+ *                     nickname: "Main Checking Account",
+ *                     bankName: "Example Bank",
+ *                     routingAccount: "123456789",
+ *                     accountNumber: "9876543210",
+ *                     typeAccount: Payabli.TypeAccount.Checking,
+ *                     bankAccountHolderName: "John Doe",
+ *                     bankAccountHolderType: Payabli.BankAccountHolderType.Business,
+ *                     bankAccountFunction: 2,
+ *                     verified: true,
+ *                     status: 1,
+ *                     services: [],
+ *                     "default": true
+ *                 },
+ *                 VendorStatus: 1,
+ *                 VendorId: 1,
+ *                 Summary: {
+ *                     ActiveBills: 2,
+ *                     PendingBills: 4,
+ *                     InTransitBills: 3,
+ *                     PaidBills: 18,
+ *                     OverdueBills: 1,
+ *                     ApprovedBills: 5,
+ *                     DisapprovedBills: 1,
+ *                     TotalBills: 34,
+ *                     ActiveBillsAmount: 1250.75,
+ *                     PendingBillsAmount: 2890.5,
+ *                     InTransitBillsAmount: 1675.25,
+ *                     PaidBillsAmount: 15420.8,
+ *                     OverdueBillsAmount: 425,
+ *                     ApprovedBillsAmount: 3240.9,
+ *                     DisapprovedBillsAmount: 180,
+ *                     TotalBillsAmount: 25083.2
+ *                 },
+ *                 PaypointLegalname: "Sunshine Services, LLC",
+ *                 PaypointDbaname: "Sunshine Gutters",
+ *                 PaypointEntryname: "d193cf9a46",
+ *                 ParentOrgName: "PropertyManager Pro",
+ *                 ParentOrgId: 1000,
+ *                 CreatedDate: "2022-07-01T15:00:01Z",
+ *                 LastUpdated: "2022-07-01T15:00:01Z",
+ *                 remitAddress1: "123 Walnut Street",
+ *                 remitAddress2: "Suite 900",
+ *                 remitCity: "Miami",
+ *                 remitState: "FL",
+ *                 remitZip: "31113",
+ *                 remitCountry: "US",
+ *                 payeeName1: "payeeName1",
+ *                 payeeName2: "payeeName2",
+ *                 customField1: "",
+ *                 customField2: "",
+ *                 customerVendorAccount: "123-456",
+ *                 InternalReferenceId: 1000000,
+ *                 externalPaypointID: "Paypoint-100",
+ *                 StoredMethods: []
+ *             },
+ *             billData: [{
+ *                     billId: 3001,
+ *                     invoiceNumber: "INV-5001",
+ *                     netAmount: "500",
+ *                     invoiceDate: "2025-08-01",
+ *                     dueDate: "2025-08-15"
+ *                 }],
+ *             externalPaypointID: "d193cf9a46-10",
+ *             method: "ach",
+ *             paypointId: 255,
+ *             totalAmount: 500,
+ *             netAmount: 500,
+ *             feeAmount: 0,
+ *             paymentData: {
+ *                 AccountType: "checking",
+ *                 HolderName: "Herman Coatings",
+ *                 Initiator: "merchant",
+ *                 MaskedAccount: "XXXXXX5666",
+ *                 paymentDetails: {
+ *                     currency: "USD",
+ *                     serviceFee: 0,
+ *                     totalAmount: 500
+ *                 },
+ *                 Sequence: "subsequent",
+ *                 StoredMethodUsageType: "recurring"
+ *             },
+ *             startDate: "2025-09-01T00:00:00Z",
+ *             endDate: "2026-09-01T00:00:00Z",
+ *             nextDate: "2025-10-01T00:00:00Z",
+ *             frequency: "monthly",
+ *             totalCycles: 12,
+ *             leftCycles: 11,
+ *             lastRun: "2025-09-01T06:00:00Z",
+ *             entrypageId: 0,
+ *             untilCancelled: false,
+ *             lastUpdated: "2025-08-01T12:00:00Z",
+ *             createdAt: "2025-08-01T12:00:00Z",
+ *             paypointLegalname: "Sunshine Services, LLC",
+ *             paypointDbaname: "Sunshine Gutters",
+ *             paypointEntryname: "d193cf9a46",
+ *             parentOrgName: "PropertyManager Pro",
+ *             parentOrgId: 236,
+ *             source: "api"
+ *         }
+ *     }
+ */
+export interface GetPayoutSubscriptionResponse {
+    isSuccess?: Payabli.IsSuccess | undefined;
+    responseText: Payabli.ResponseText;
+    /** The payout subscription record. */
+    responseData?: Payabli.PayoutSubscriptionQueryRecord | undefined;
+}

package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};