@payabli/sdk-node 0.0.147 → 1.0.1

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

@@ -16,15 +16,18 @@ 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";
+/**
+ * The Query service provides advanced search and reporting capabilities across all transactional and operational data in the platform. It offers flexible query endpoints for transactions, bills, invoices, customers, vendors, boarding applications, vcards, and subscriptions with support for complex filtering using comparison operators, date ranges, text matching, and array operations. The service provides configurable pagination, sorting, and field selection with options to export results in multiple formats including JSON, CSV, Excel, and PDF. Queries can be scoped to specific entrypoints or organizations and support summary statistics alongside detailed record sets.
+ */
 export class QueryClient {
-    constructor(options = {}) {
+    constructor(options) {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
      * Retrieve a list of batches and their details, including settled and
      * unsettled 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListBatchDetailsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -172,7 +175,7 @@ export class QueryClient {
     /**
      * Retrieve a list of batches 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListBatchesRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -320,7 +323,7 @@ export class QueryClient {
     /**
      * Retrieve a list of MoneyOut batches 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListBatchesOutRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -468,7 +471,7 @@ export class QueryClient {
     /**
      * Retrieves a list of chargebacks and returned 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListChargebacksRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -616,7 +619,7 @@ export class QueryClient {
     /**
      * Retrieves a list of customers 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListCustomersRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -764,7 +767,7 @@ export class QueryClient {
     /**
      * Returns a list of cloud devices 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListDevicesRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -848,7 +851,7 @@ export class QueryClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.query.listDevicesOrg(100, {
+     *     await client.query.listDevicesOrg(123, {
      *         fromRecord: 0,
      *         limitRecord: 20,
      *         sortBy: "desc(createdAt)"
@@ -912,7 +915,7 @@ export class QueryClient {
     /**
      * Returns a list of all reports generated in the last 60 days for a single entrypoint. Use filters to limit results.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListNotificationReportsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -1064,7 +1067,7 @@ export class QueryClient {
     /**
      * Returns a list of notifications for an entrypoint. Use filters to limit results.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListNotificationsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -1284,7 +1287,7 @@ export class QueryClient {
     /**
      * Retrieves a list of money out transactions (payouts) 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListPayoutRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -1506,7 +1509,7 @@ export class QueryClient {
     /**
      * Retrieve a list of settled 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListSettlementsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -1654,7 +1657,7 @@ export class QueryClient {
     /**
      * Returns a list of 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListSubscriptionsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -1802,7 +1805,7 @@ export class QueryClient {
     /**
      * 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.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListPayoutSubscriptionsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -1955,14 +1958,17 @@ export class QueryClient {
     }
     /**
      * 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 -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>'
      *
-     *   ```
+     * These request parameters filter for transactions between April 1, 2024 and April 9, 2024.
+     *
+     * ```bash
+     * curl -X GET https://api-sandbox.payabli.com/api/Query/transactions/8cfec329267?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59 \
+     *   -H 'requestToken: <API TOKEN>'
+     * ```
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListTransactionsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -2042,20 +2048,16 @@ export class QueryClient {
         });
     }
     /**
-     *
-     * Retrieve a list of transactions for an organization. Use filters to
-     * limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
-     *
+     * Retrieve a list of transactions for an organization. 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.
+     * These request parameters filter for transactions between April 1, 2024 and April 9, 2024.
      *
-     * ```
-     * 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"\
+     * ```bash
+     * curl -X GET "https://api-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>'
-     *
-     *   ```
+     * ```
      *
      * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
      * @param {Payabli.ListTransactionsOrgRequest} request
@@ -2139,7 +2141,7 @@ export class QueryClient {
     /**
      * Retrieve a list of transfer details records 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {number} transferId - The numeric identifier for the transfer, assigned by Payabli.
      * @param {Payabli.ListTransfersPaypointRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -2150,7 +2152,7 @@ export class QueryClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.query.listTransferDetails("47862acd", 123456)
+     *     await client.query.listTransferDetails("8cfec329267", 4521)
      */
     listTransferDetails(entry, transferId, request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__listTransferDetails(entry, transferId, request, requestOptions));
@@ -2210,7 +2212,7 @@ export class QueryClient {
     /**
      * Retrieve a list of transfers 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.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListTransfersRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -2220,7 +2222,7 @@ export class QueryClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.query.listTransfers("47862acd", {
+     *     await client.query.listTransfers("8cfec329267", {
      *         fromRecord: 0,
      *         limitRecord: 20
      *     })
@@ -2239,7 +2241,8 @@ export class QueryClient {
                 parameters: parameters != null ? toJson(parameters) : undefined,
                 sortBy,
             };
-            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            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/transfers/${core.url.encodePathParam(entry)}`),
                 method: "GET",
@@ -2282,6 +2285,7 @@ export class QueryClient {
     /**
      * Retrieve a list of transfers for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      *
+     * @param {Payabli.Orgid} orgId - Organization ID. Unique identifier assigned to an org by Payabli.
      * @param {Payabli.ListTransfersRequestOrg} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -2291,19 +2295,18 @@ export class QueryClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.query.listTransfersOrg({
-     *         orgId: 123,
+     *     await client.query.listTransfersOrg(123, {
      *         fromRecord: 0,
      *         limitRecord: 20
      *     })
      */
-    listTransfersOrg(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listTransfersOrg(request, requestOptions));
+    listTransfersOrg(orgId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listTransfersOrg(orgId, request, requestOptions));
     }
-    __listTransfersOrg(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __listTransfersOrg(orgId_1) {
+        return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { orgId, exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
+            const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
             const _queryParams = {
                 exportFormat: exportFormat != null ? exportFormat : undefined,
                 fromRecord,
@@ -2311,7 +2314,8 @@ export class QueryClient {
                 parameters: parameters != null ? toJson(parameters) : undefined,
                 sortBy,
             };
-            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            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/transfers/org/${core.url.encodePathParam(orgId)}`),
                 method: "GET",
@@ -2364,7 +2368,7 @@ export class QueryClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.query.listTransfersOutOrg(77, {
+     *     await client.query.listTransfersOutOrg(123, {
      *         fromRecord: 0,
      *         limitRecord: 20
      *     })
@@ -2382,7 +2386,8 @@ export class QueryClient {
                 parameters: parameters != null ? toJson(parameters) : undefined,
                 sortBy,
             };
-            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            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/transfersOut/org/${core.url.encodePathParam(orgId)}`),
                 method: "GET",
@@ -2425,7 +2430,7 @@ export class QueryClient {
     /**
      * Retrieve a list of outbound transfers for a paypoint. Use filters to limit results.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListTransfersOutPaypointRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -2435,7 +2440,7 @@ export class QueryClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.query.listTransfersOutPaypoint("47cade237", {
+     *     await client.query.listTransfersOutPaypoint("8cfec329267", {
      *         fromRecord: 0,
      *         limitRecord: 20
      *     })
@@ -2453,7 +2458,8 @@ export class QueryClient {
                 parameters: parameters != null ? toJson(parameters) : undefined,
                 sortBy,
             };
-            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            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/transfersOut/${core.url.encodePathParam(entry)}`),
                 method: "GET",
@@ -2496,7 +2502,7 @@ export class QueryClient {
     /**
      * Retrieve details for a specific outbound transfer. Use filters to limit results.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {number} transferId - The numeric identifier for the transfer, assigned by Payabli.
      * @param {Payabli.ListTransferDetailsOutRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -2507,7 +2513,7 @@ export class QueryClient {
      * @throws {@link Payabli.ServiceUnavailableError}
      *
      * @example
-     *     await client.query.listTransferDetailsOut("47ace2b25", 4521, {
+     *     await client.query.listTransferDetailsOut("8cfec329267", 4521, {
      *         fromRecord: 0,
      *         limitRecord: 20
      *     })
@@ -2525,7 +2531,8 @@ export class QueryClient {
                 parameters: parameters != null ? toJson(parameters) : undefined,
                 sortBy,
             };
-            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            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/transferDetailsOut/${core.url.encodePathParam(entry)}/${core.url.encodePathParam(transferId)}`),
                 method: "GET",
@@ -2865,7 +2872,7 @@ export class QueryClient {
     /**
      * Retrieve a list of vcards (virtual credit cards) issued for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListVcardsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -2939,7 +2946,7 @@ export class QueryClient {
     /**
      * Retrieve a list of virtual card transactions for an entrypoint. Use filters to limit results.
      *
-     * @param {Payabli.Entry} entry
+     * @param {Payabli.Entry} entry - The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
      * @param {Payabli.ListVcardsTransactionsRequest} request
      * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListBatchDetailsOrgRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -89,7 +90,7 @@ export interface ListBatchDetailsOrgRequest {
      *
      * Example: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListBatchDetailsRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListBatchDetailsRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -90,7 +91,7 @@ export interface ListBatchDetailsRequest {
      *
      * Example: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListBatchesOrgRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListBatchesOrgRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -69,7 +70,7 @@ export interface ListBatchesOrgRequest {
      *
      * Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListBatchesOutOrgRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListBatchesOutOrgRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -45,7 +46,7 @@ export interface ListBatchesOutOrgRequest {
      * - `paypointId` (ne, eq)
      * - `externalPaypointID` (ct, nct, eq, ne)
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListBatchesOutRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListBatchesOutRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -30,7 +31,7 @@ export interface ListBatchesOutRequest {
      * - `paypointId` (ne, eq)
      * - `externalPaypointID` (ct, nct, eq, ne)
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListBatchesRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListBatchesRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -69,7 +70,7 @@ export interface ListBatchesRequest {
      *
      * Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListChargebacksOrgRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListChargebacksOrgRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -88,7 +89,7 @@ export interface ListChargebacksOrgRequest {
      *
      * Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListChargebacksRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListChargebacksRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -86,7 +87,7 @@ export interface ListChargebacksRequest {
      *
      * Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListCustomersOrgRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListCustomersOrgRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -80,7 +81,7 @@ export interface ListCustomersOrgRequest {
      * **Example Usage:**
      * `balance(gt)=20` will return all records with a balance greater than 20.00.
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListCustomersRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListCustomersRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -80,7 +81,7 @@ export interface ListCustomersRequest {
      * **Example Usage:**
      * `balance(gt)=20` will return all records with a balance greater than 20.00.
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListDevicesOrgRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListDevicesOrgRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -107,7 +108,7 @@ export interface ListDevicesOrgRequest {
      *
      * - `nin` => not inside array
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListDevicesRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListDevicesRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -107,7 +108,7 @@ export interface ListDevicesRequest {
      *
      * - `nin` => not inside array
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListNotificationReportsOrgRequest.d.mts

@@ -49,7 +49,7 @@ export interface ListNotificationReportsOrgRequest {
      *
      * Example: reportName(ct)=tr  return all records containing the string "tr"
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListNotificationReportsRequest.d.mts

@@ -51,7 +51,7 @@ export interface ListNotificationReportsRequest {
      *
      * Example: reportName(ct)=tr  return all records containing the string "tr"
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListNotificationsOrgRequest.d.mts

@@ -53,7 +53,7 @@ export interface ListNotificationsOrgRequest {
      *
      * Example: totalAmount(gt)=20  return all records with totalAmount greater than 20.00
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListNotificationsRequest.d.mts

@@ -53,7 +53,7 @@ export interface ListNotificationsRequest {
      *
      * Example: totalAmount(gt)=20  return all records with totalAmount greater than 20.00
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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/ListOrganizationsRequest.d.mts

@@ -8,6 +8,7 @@ import type * as Payabli from "../../../../index.mjs";
  *     }
  */
 export interface ListOrganizationsRequest {
+    /** Export format for file downloads. When specified, returns data as a file instead of JSON. */
     exportFormat?: Payabli.ExportFormat;
     /** The number of records to skip before starting to collect the result set. */
     fromRecord?: number;
@@ -67,7 +68,7 @@ export interface ListOrganizationsRequest {
      *
      * Example: `dbaname(ct)=hoa` returns all records with a `dbaname` containing "hoa"
      */
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | null>;
     /** 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;
 }