@payabli/sdk-node 0.0.135 → 0.0.137

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

@@ -0,0 +1,155 @@
+import type * as Payabli from "../../../index.mjs";
+/**
+ * Payout subscription query response body.
+ *
+ * @example
+ *     {
+ *         Summary: {
+ *             totalRecords: 1,
+ *             totalAmount: 500,
+ *             totalNetAmount: 500,
+ *             totalPages: 1,
+ *             pageSize: 20,
+ *             pageIdentifier: "XXXXXXXXXXXXXXXXXXX"
+ *         },
+ *         Records: [{
+ *                 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 QueryPayoutSubscriptionResponse {
+    Summary?: Payabli.QuerySummary | undefined;
+    Records?: Payabli.PayoutSubscriptionQueryRecordPascal[] | undefined;
+}

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

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

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

@@ -0,0 +1,9 @@
+import type * as Payabli from "../../../index.mjs";
+export interface UpdatePayoutSubscriptionBody {
+    setPause?: Payabli.PayoutSetPause | undefined;
+    /** Object describing details of the payout. */
+    paymentDetails?: Payabli.PayoutPaymentDetail | undefined;
+    paymentMethod?: Payabli.AuthorizePaymentMethod | undefined;
+    /** Object describing the schedule for the payout subscription. */
+    scheduleDetails?: Payabli.PayoutScheduleDetail | undefined;
+}

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

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

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

@@ -0,0 +1,15 @@
+import type * as Payabli from "../../../index.mjs";
+/**
+ * Success response
+ */
+export interface UpdatePayoutSubscriptionResponse {
+    isSuccess?: Payabli.IsSuccess | undefined;
+    responseText: Payabli.ResponseText;
+    /**
+     * If `isSuccess` = true, this contains the payout subscription ID. When the subscription is paused, it also includes a description (for example, "42 paused").
+     *
+     * If `isSuccess` = false, this contains the reason for the failure.
+     */
+    responseData?: string | undefined;
+    customerId?: Payabli.CustomerId | undefined;
+}

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

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

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

@@ -0,0 +1,12 @@
+export * from "./AddPayoutSubscriptionResponse.mjs";
+export * from "./DeletePayoutSubscriptionResponse.mjs";
+export * from "./GetPayoutSubscriptionResponse.mjs";
+export * from "./PayoutPaymentDetail.mjs";
+export * from "./PayoutScheduleDetail.mjs";
+export * from "./PayoutSetPause.mjs";
+export * from "./PayoutSubscriptionQueryRecord.mjs";
+export * from "./PayoutSubscriptionQueryRecordPascal.mjs";
+export * from "./PayoutSubscriptionRequestBody.mjs";
+export * from "./QueryPayoutSubscriptionResponse.mjs";
+export * from "./UpdatePayoutSubscriptionBody.mjs";
+export * from "./UpdatePayoutSubscriptionResponse.mjs";

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

@@ -0,0 +1,12 @@
+export * from "./AddPayoutSubscriptionResponse.mjs";
+export * from "./DeletePayoutSubscriptionResponse.mjs";
+export * from "./GetPayoutSubscriptionResponse.mjs";
+export * from "./PayoutPaymentDetail.mjs";
+export * from "./PayoutScheduleDetail.mjs";
+export * from "./PayoutSetPause.mjs";
+export * from "./PayoutSubscriptionQueryRecord.mjs";
+export * from "./PayoutSubscriptionQueryRecordPascal.mjs";
+export * from "./PayoutSubscriptionRequestBody.mjs";
+export * from "./QueryPayoutSubscriptionResponse.mjs";
+export * from "./UpdatePayoutSubscriptionBody.mjs";
+export * from "./UpdatePayoutSubscriptionResponse.mjs";

package/dist/esm/api/resources/query/client/Client.d.mts

@@ -473,13 +473,54 @@ export declare class QueryClient {
      */
     listSubscriptionsOrg(orgId: number, request?: Payabli.ListSubscriptionsOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QuerySubscriptionResponse>;
     private __listSubscriptionsOrg;
+    /**
+     * Returns a list of payout subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {Payabli.Entry} entry
+     * @param {Payabli.ListPayoutSubscriptionsRequest} request
+     * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.query.listPayoutSubscriptions("8cfec329267", {
+     *         fromRecord: 0,
+     *         limitRecord: 20,
+     *         sortBy: "desc(field_name)"
+     *     })
+     */
+    listPayoutSubscriptions(entry: Payabli.Entry, request?: Payabli.ListPayoutSubscriptionsRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryPayoutSubscriptionResponse>;
+    private __listPayoutSubscriptions;
+    /**
+     * Returns a list of payout subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
+     * @param {Payabli.ListPayoutSubscriptionsOrgRequest} request
+     * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.query.listPayoutSubscriptionsOrg(123, {
+     *         fromRecord: 0,
+     *         limitRecord: 20,
+     *         sortBy: "desc(field_name)"
+     *     })
+     */
+    listPayoutSubscriptionsOrg(orgId: number, request?: Payabli.ListPayoutSubscriptionsOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryPayoutSubscriptionResponse>;
+    private __listPayoutSubscriptionsOrg;
     /**
      * Retrieve a list of transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      * By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.
      * For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
-     * ``` curl --request GET \
-     *   --url https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
-     *   --header 'requestToken: <api-key>'
+     * ``` curl -X GET https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
+     *   -H 'requestToken: <API TOKEN>'
      *
      *   ```
      *
@@ -512,9 +553,8 @@ export declare class QueryClient {
      * For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
      *
      * ```
-     * curl --request GET \
-     *   --url https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
-     *   --header 'requestToken: <api-key>'
+     * curl -X GET "https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59"\
+     *   -H 'requestToken: <API TOKEN>'
      *
      *   ```
      *

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

@@ -1563,13 +1563,158 @@ export class QueryClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/subscriptions/org/{orgId}");
         });
     }
+    /**
+     * Returns a list of payout subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {Payabli.Entry} entry
+     * @param {Payabli.ListPayoutSubscriptionsRequest} request
+     * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.query.listPayoutSubscriptions("8cfec329267", {
+     *         fromRecord: 0,
+     *         limitRecord: 20,
+     *         sortBy: "desc(field_name)"
+     *     })
+     */
+    listPayoutSubscriptions(entry, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listPayoutSubscriptions(entry, request, requestOptions));
+    }
+    __listPayoutSubscriptions(entry_1) {
+        return __awaiter(this, arguments, void 0, function* (entry, request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
+            const _queryParams = {
+                exportFormat: exportFormat != null ? exportFormat : undefined,
+                fromRecord,
+                limitRecord,
+                parameters: parameters != null ? toJson(parameters) : undefined,
+                sortBy,
+            };
+            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, `Query/payoutsubscriptions/${core.url.encodePathParam(entry)}`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), 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", "/Query/payoutsubscriptions/{entry}");
+        });
+    }
+    /**
+     * Returns a list of payout subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
+     *
+     * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
+     * @param {Payabli.ListPayoutSubscriptionsOrgRequest} request
+     * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Payabli.BadRequestError}
+     * @throws {@link Payabli.UnauthorizedError}
+     * @throws {@link Payabli.InternalServerError}
+     * @throws {@link Payabli.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.query.listPayoutSubscriptionsOrg(123, {
+     *         fromRecord: 0,
+     *         limitRecord: 20,
+     *         sortBy: "desc(field_name)"
+     *     })
+     */
+    listPayoutSubscriptionsOrg(orgId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listPayoutSubscriptionsOrg(orgId, request, requestOptions));
+    }
+    __listPayoutSubscriptionsOrg(orgId_1) {
+        return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
+            const _queryParams = {
+                exportFormat: exportFormat != null ? exportFormat : undefined,
+                fromRecord,
+                limitRecord,
+                parameters: parameters != null ? toJson(parameters) : undefined,
+                sortBy,
+            };
+            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, `Query/payoutsubscriptions/org/${core.url.encodePathParam(orgId)}`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), 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", "/Query/payoutsubscriptions/org/{orgId}");
+        });
+    }
     /**
      * Retrieve a list of transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      * By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.
      * For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
-     * ``` curl --request GET \
-     *   --url https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
-     *   --header 'requestToken: <api-key>'
+     * ``` curl -X GET https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
+     *   -H 'requestToken: <API TOKEN>'
      *
      *   ```
      *
@@ -1651,9 +1796,8 @@ export class QueryClient {
      * For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
      *
      * ```
-     * curl --request GET \
-     *   --url https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
-     *   --header 'requestToken: <api-key>'
+     * curl -X GET "https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59"\
+     *   -H 'requestToken: <API TOKEN>'
      *
      *   ```
      *

package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.mts

@@ -0,0 +1,84 @@
+import type * as Payabli from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         fromRecord: 0,
+ *         limitRecord: 20,
+ *         sortBy: "desc(field_name)"
+ *     }
+ */
+export interface ListPayoutSubscriptionsOrgRequest {
+    exportFormat?: Payabli.ExportFormat;
+    /** The number of records to skip before starting to collect the result set. */
+    fromRecord?: number;
+    /** Max number of records to return for the query. Use `0` or negative value to return all records. */
+    limitRecord?: number;
+    /**
+     * Collection of field names, conditions, and values used to filter the query.
+     * <Info>
+     *   **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
+     *
+     *   Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
+     *
+     *   For example:
+     *
+     *   --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
+     *
+     *   should become:
+     *
+     *   --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?totalAmount(gt)=1000&limitRecord=20
+     * </Info>
+     * See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
+     * **List of field names accepted:**
+     *
+     * - `startDate` (gt, ge, lt, le, eq, ne)
+     * - `endDate` (gt, ge, lt, le, eq, ne)
+     * - `nextDate` (gt, ge, lt, le, eq, ne)
+     * - `frequency` (in, nin, ne, eq)
+     * - `method` (in, nin, eq, ne)
+     * - `totalAmount` (gt, ge, lt, le, eq, ne)
+     * - `netAmount` (gt, ge, lt, le, eq, ne)
+     * - `feeAmount` (gt, ge, lt, le, eq, ne)
+     * - `status` (in, nin, eq, ne)
+     * - `untilcancelled` (eq, ne)
+     * - `payaccountLastfour` (ct, nct)
+     * - `payaccountType` (ne, eq, in, nin)
+     * - `payaccountCurrency` (ne, eq, in, nin)
+     * - `paypointId` (ne, eq)
+     * - `paypointLegal` (ne, eq, ct, nct)
+     * - `paypointDba` (ne, eq, ct, nct)
+     * - `orgName` (ne, eq, ct, nct, nin, in)
+     * - `parentOrgId` (ne, eq, nin, in)
+     * - `subscriptionId` (eq, ne)
+     * - `orderDescription` (ct, nct)
+     * - `cycles` (eq, ne, gt, ge, lt, le)
+     * - `leftcycles` (eq, ne, gt, ge, lt, le)
+     * - `createdAt` (eq, ne, gt, ge, lt, le)
+     * - `updatedOn` (eq, ne, gt, ge, lt, le)
+     * - `vendorNumber` (ne, eq, ct, nct)
+     * - `name` (ne, eq, ct, nct)
+     * - `phone` (ne, eq, ct, nct)
+     * - `email` (ne, eq, ct, nct)
+     * - `address` (ne, eq, ct, nct)
+     * - `remitAddress` (ct, nct)
+     * - `city` (ne, eq, ct, nct)
+     * - `state` (ne, eq, ct, nct)
+     * - `country` (ne, eq, ct, nct)
+     * - `zip` (ne, eq, ct, nct)
+     *
+     * **List of comparison operators accepted:**
+     * - `eq` or empty => equal
+     * - `gt` => greater than
+     * - `ge` => greater or equal
+     * - `lt` => less than
+     * - `le` => less or equal
+     * - `ne` => not equal
+     * - `ct` => contains
+     * - `nct` => not contains
+     * - `in` => inside array
+     * - `nin` => not inside array
+     */
+    parameters?: Record<string, string>;
+    /** The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. */
+    sortBy?: string;
+}

package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.mjs

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

package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.mts

@@ -0,0 +1,84 @@
+import type * as Payabli from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         fromRecord: 0,
+ *         limitRecord: 20,
+ *         sortBy: "desc(field_name)"
+ *     }
+ */
+export interface ListPayoutSubscriptionsRequest {
+    exportFormat?: Payabli.ExportFormat;
+    /** The number of records to skip before starting to collect the result set. */
+    fromRecord?: number;
+    /** Max number of records to return for the query. Use `0` or negative value to return all records. */
+    limitRecord?: number;
+    /**
+     * Collection of field names, conditions, and values used to filter the query.
+     * <Info>
+     *   **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
+     *
+     *   Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
+     *
+     *   For example:
+     *
+     *   --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?parameters=totalAmount(gt)=1000&limitRecord=20
+     *
+     *   should become:
+     *
+     *   --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?totalAmount(gt)=1000&limitRecord=20
+     * </Info>
+     * See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
+     * **List of field names accepted:**
+     *
+     * - `startDate` (gt, ge, lt, le, eq, ne)
+     * - `endDate` (gt, ge, lt, le, eq, ne)
+     * - `nextDate` (gt, ge, lt, le, eq, ne)
+     * - `frequency` (in, nin, ne, eq)
+     * - `method` (in, nin, eq, ne)
+     * - `totalAmount` (gt, ge, lt, le, eq, ne)
+     * - `netAmount` (gt, ge, lt, le, eq, ne)
+     * - `feeAmount` (gt, ge, lt, le, eq, ne)
+     * - `status` (in, nin, eq, ne)
+     * - `untilcancelled` (eq, ne)
+     * - `payaccountLastfour` (ct, nct)
+     * - `payaccountType` (ne, eq, in, nin)
+     * - `payaccountCurrency` (ne, eq, in, nin)
+     * - `paypointId` (ne, eq)
+     * - `paypointLegal` (ne, eq, ct, nct)
+     * - `paypointDba` (ne, eq, ct, nct)
+     * - `orgName` (ne, eq, ct, nct, nin, in)
+     * - `parentOrgId` (ne, eq, nin, in)
+     * - `subscriptionId` (eq, ne)
+     * - `orderDescription` (ct, nct)
+     * - `cycles` (eq, ne, gt, ge, lt, le)
+     * - `leftcycles` (eq, ne, gt, ge, lt, le)
+     * - `createdAt` (eq, ne, gt, ge, lt, le)
+     * - `updatedOn` (eq, ne, gt, ge, lt, le)
+     * - `vendorNumber` (ne, eq, ct, nct)
+     * - `name` (ne, eq, ct, nct)
+     * - `phone` (ne, eq, ct, nct)
+     * - `email` (ne, eq, ct, nct)
+     * - `address` (ne, eq, ct, nct)
+     * - `remitAddress` (ct, nct)
+     * - `city` (ne, eq, ct, nct)
+     * - `state` (ne, eq, ct, nct)
+     * - `country` (ne, eq, ct, nct)
+     * - `zip` (ne, eq, ct, nct)
+     *
+     * **List of comparison operators accepted:**
+     * - `eq` or empty => equal
+     * - `gt` => greater than
+     * - `ge` => greater or equal
+     * - `lt` => less than
+     * - `le` => less or equal
+     * - `ne` => not equal
+     * - `ct` => contains
+     * - `nct` => not contains
+     * - `in` => inside array
+     * - `nin` => not inside array
+     */
+    parameters?: Record<string, string>;
+    /** The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. */
+    sortBy?: string;
+}

package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.mjs

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

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

@@ -15,6 +15,8 @@ export type { ListNotificationsRequest } from "./ListNotificationsRequest.mjs";
 export type { ListOrganizationsRequest } from "./ListOrganizationsRequest.mjs";
 export type { ListPayoutOrgRequest } from "./ListPayoutOrgRequest.mjs";
 export type { ListPayoutRequest } from "./ListPayoutRequest.mjs";
+export type { ListPayoutSubscriptionsOrgRequest } from "./ListPayoutSubscriptionsOrgRequest.mjs";
+export type { ListPayoutSubscriptionsRequest } from "./ListPayoutSubscriptionsRequest.mjs";
 export type { ListPaypointsRequest } from "./ListPaypointsRequest.mjs";
 export type { ListSettlementsOrgRequest } from "./ListSettlementsOrgRequest.mjs";
 export type { ListSettlementsRequest } from "./ListSettlementsRequest.mjs";