@payabli/sdk-node 0.0.141 → 0.0.143

package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Detailed bank account verification results from the verification network.
+ */
+export interface BankAccountVerificationDetailsResponse {
+    /** The ABA routing number that was verified. */
+    aba?: string | undefined;
+    /** The account number that was verified. */
+    accountNumber?: string | undefined;
+    /** Whether the bank account passed verification. */
+    isValid: boolean;
+    /** Error message if the verification request failed. */
+    errorMessage?: string | undefined;
+    /** Overall verification outcome. Possible values include `Pass`, `Verified`, `Declined`, `NoData`, `Bypassed`, and `Error`. */
+    verificationResponse?: string | undefined;
+    /** Response code returned by the verification network. */
+    responseCode?: string | undefined;
+    /** Response value associated with the verification outcome. */
+    responseValue?: string | undefined;
+    /** Human-readable description of the verification outcome. */
+    responseDescription?: string | undefined;
+    /** Name of the bank associated with the routing number. */
+    bankName?: string | undefined;
+    /** Account type as reported by the verification network, such as `Checking` or `Savings`. */
+    reportedAccountType?: string | undefined;
+    /** Date the account was first seen by the verification network (ISO 8601 format). */
+    accountAddedDate?: string | undefined;
+    /** Date the account record was last updated in the verification network (ISO 8601 format). */
+    accountLastUpdatedDate?: string | undefined;
+    /** Date the account was closed, if applicable (ISO 8601 format). */
+    accountClosedDate?: string | undefined;
+}

package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.d.ts

@@ -0,0 +1,9 @@
+import type * as Payabli from "../../../index.js";
+/**
+ * Response wrapper for the bank account verification details endpoint.
+ */
+export interface VerifyAccountDetailsResponse {
+    isSuccess?: Payabli.IsSuccess | undefined;
+    responseText: Payabli.ResponseText;
+    responseData?: Payabli.BankAccountVerificationDetailsResponse | undefined;
+}

package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,2 @@
+export * from "./BankAccountVerificationDetailsResponse.js";
+export * from "./VerifyAccountDetailsResponse.js";

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

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BankAccountVerificationDetailsResponse.js"), exports);
+__exportStar(require("./VerifyAccountDetailsResponse.js"), exports);

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

@@ -389,7 +389,7 @@ export declare class MoneyInClient {
     getpaid(request: Payabli.RequestPayment, requestOptions?: MoneyInClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseGetPaid>;
     private __getpaid;
     /**
-     * A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not.
+     * A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not. This endpoint only works on transactions made with the v1 API. For v2 transactions, check the transaction's settlement status and call v2 void or v2 refund based on the result.
      *
      * @param {string} transId - ReferenceId for the transaction (PaymentId).
      * @param {number} amount -

package/dist/cjs/api/resources/moneyIn/client/Client.js

@@ -720,7 +720,7 @@ class MoneyInClient {
         });
     }
     /**
-     * A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not.
+     * A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not. This endpoint only works on transactions made with the v1 API. For v2 transactions, check the transaction's settlement status and call v2 void or v2 refund based on the result.
      *
      * @param {string} transId - ReferenceId for the transaction (PaymentId).
      * @param {number} amount -

package/dist/cjs/api/resources/moneyIn/types/TransactionDetailCustomer.d.ts

@@ -6,22 +6,22 @@ export interface TransactionDetailCustomer {
     identifiers: Payabli.Identifierfields | null;
     firstName: string;
     lastName: string;
-    companyName: string;
-    billingAddress1: Payabli.BillingAddressNullable;
-    billingAddress2: Payabli.BillingAddressAddtlNullable;
-    billingCity: Payabli.BillingCityNullable;
-    billingState: Payabli.BillingStateNullable;
-    billingZip: Payabli.BillingZip;
-    billingCountry: Payabli.BillingCountryNullable;
-    billingPhone: Payabli.PhoneNumber;
-    billingEmail: Payabli.Email;
-    customerNumber: Payabli.CustomerNumberNullable;
-    shippingAddress1: Payabli.Shippingaddress;
-    shippingAddress2: Payabli.Shippingaddressadditional;
-    shippingCity: Payabli.Shippingcity;
-    shippingState: Payabli.Shippingstate;
-    shippingZip: Payabli.Shippingzip;
-    shippingCountry: Payabli.Shippingcountry;
+    companyName: string | null;
+    billingAddress1: Payabli.BillingAddressNullable | null;
+    billingAddress2: Payabli.BillingAddressAddtlNullable | null;
+    billingCity: Payabli.BillingCityNullable | null;
+    billingState: Payabli.BillingStateNullable | null;
+    billingZip: Payabli.BillingZip | null;
+    billingCountry: Payabli.BillingCountryNullable | null;
+    billingPhone: Payabli.PhoneNumber | null;
+    billingEmail: Payabli.Email | null;
+    customerNumber: Payabli.CustomerNumberNullable | null;
+    shippingAddress1: Payabli.Shippingaddress | null;
+    shippingAddress2: Payabli.Shippingaddressadditional | null;
+    shippingCity: Payabli.Shippingcity | null;
+    shippingState: Payabli.Shippingstate | null;
+    shippingZip: Payabli.Shippingzip | null;
+    shippingCountry: Payabli.Shippingcountry | null;
     customerId: Payabli.CustomerId;
     customerStatus: Payabli.CustomerStatus;
     additionalData: Payabli.AdditionalDataMap | null;

package/dist/cjs/api/resources/moneyIn/types/TransactionDetailPaymentData.d.ts

@@ -11,7 +11,7 @@ export interface TransactionDetailPaymentData {
     initiator: Payabli.Initiator | null;
     storedMethodUsageType: Payabli.StoredMethodUsageType | null;
     sequence: Payabli.Sequence | null;
-    orderDescription: Payabli.Orderdescription;
+    orderDescription: Payabli.Orderdescription | null;
     accountId: Payabli.AccountId | null;
     signatureData: Payabli.Signaturedata | null;
     binData: Payabli.BinData | null;

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

@@ -221,6 +221,48 @@ export declare class QueryClient {
      */
     listCustomersOrg(orgId: number, request?: Payabli.ListCustomersOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryCustomerResponse>;
     private __listCustomersOrg;
+    /**
+     * 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.ListDevicesRequest} 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.listDevices("8cfec329267", {
+     *         fromRecord: 0,
+     *         limitRecord: 20,
+     *         sortBy: "desc(createdAt)"
+     *     })
+     */
+    listDevices(entry: Payabli.Entry, request?: Payabli.ListDevicesRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryDeviceResponse>;
+    private __listDevices;
+    /**
+     * Returns a list of cloud devices for a single organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
+     *
+     * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
+     * @param {Payabli.ListDevicesOrgRequest} 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.listDevicesOrg(100, {
+     *         fromRecord: 0,
+     *         limitRecord: 20,
+     *         sortBy: "desc(createdAt)"
+     *     })
+     */
+    listDevicesOrg(orgId: number, request?: Payabli.ListDevicesOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryDeviceResponse>;
+    private __listDevicesOrg;
     /**
      * Returns a list of all reports generated in the last 60 days for a single entrypoint. Use filters to limit results.
      *

package/dist/cjs/api/resources/query/client/Client.js

@@ -757,6 +757,146 @@ class QueryClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/customers/org/{orgId}");
         });
     }
+    /**
+     * 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.ListDevicesRequest} 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.listDevices("8cfec329267", {
+     *         fromRecord: 0,
+     *         limitRecord: 20,
+     *         sortBy: "desc(createdAt)"
+     *     })
+     */
+    listDevices(entry, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listDevices(entry, request, requestOptions));
+    }
+    __listDevices(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 ? (0, json_js_1.toJson)(parameters) : undefined,
+                sortBy,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.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/devices/${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 (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/devices/{entry}");
+        });
+    }
+    /**
+     * Returns a list of cloud devices for a single organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
+     *
+     * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
+     * @param {Payabli.ListDevicesOrgRequest} 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.listDevicesOrg(100, {
+     *         fromRecord: 0,
+     *         limitRecord: 20,
+     *         sortBy: "desc(createdAt)"
+     *     })
+     */
+    listDevicesOrg(orgId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listDevicesOrg(orgId, request, requestOptions));
+    }
+    __listDevicesOrg(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 ? (0, json_js_1.toJson)(parameters) : undefined,
+                sortBy,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.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/devices/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 (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/devices/org/{orgId}");
+        });
+    }
     /**
      * Returns a list of all reports generated in the last 60 days for a single entrypoint. Use filters to limit results.
      *

package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.d.ts

@@ -0,0 +1,113 @@
+import type * as Payabli from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         fromRecord: 0,
+ *         limitRecord: 20,
+ *         sortBy: "desc(createdAt)"
+ *     }
+ */
+export interface ListDevicesOrgRequest {
+    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/devices/org/236?parameters=status=1&limitRecord=20
+     *
+     *   should become:
+     *
+     *   --url https://api-sandbox.payabli.com/api/Query/devices/org/236?status=1&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:**
+     *
+     *
+     * - `deviceId` (eq, ne, ct, nct)
+     *
+     * - `serialNumber` (eq, ne, ct, nct)
+     *
+     * - `friendlyName` (eq, ne, ct, nct)
+     *
+     * - `description` (eq, ne, ct, nct)
+     *
+     * - `model` (eq, ne, ct, nct)
+     *
+     * - `make` (eq, ne, ct, nct)
+     *
+     * - `macAddress` (eq, ne, ct, nct)
+     *
+     * - `registrationCode` (eq, ne, ct, nct)
+     *
+     * - `status` (eq, ne, in, nin)
+     *
+     * - `deviceType` (eq, ne, in, nin)
+     *
+     * - `deviceOs` (eq, ne, in, nin)
+     *
+     * - `activationAttempts` (eq, ne, gt, ge, lt, le)
+     *
+     * - `createdDate` (gt, ge, lt, le, eq, ne)
+     *
+     * - `updatedDate` (gt, ge, lt, le, eq, ne)
+     *
+     * - `lastHealthCheck` (gt, ge, lt, le, eq, ne)
+     *
+     * - `activationExpiry` (gt, ge, lt, le, eq, ne). This filter corresponds to the `activationCodeExpiry` response field.
+     *
+     * - `paypointId` (eq, ne)
+     *
+     * - `paypointDba` (eq, ne, ct, nct)
+     *
+     * - `paypointLegal` (eq, ne, ct, nct)
+     *
+     * - `paypointEntry` (eq, ne, ct, nct)
+     *
+     * - `externalPaypointId` (eq, ne, ct, nct)
+     *
+     * - `parentOrgId` (eq, ne)
+     *
+     * - `parentOrgName` (eq, ne, 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/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.d.ts

@@ -0,0 +1,113 @@
+import type * as Payabli from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         fromRecord: 0,
+ *         limitRecord: 20,
+ *         sortBy: "desc(createdAt)"
+ *     }
+ */
+export interface ListDevicesRequest {
+    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/devices/8cfec329267?parameters=status=1&limitRecord=20
+     *
+     *   should become:
+     *
+     *   --url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?status=1&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:**
+     *
+     *
+     * - `deviceId` (eq, ne, ct, nct)
+     *
+     * - `serialNumber` (eq, ne, ct, nct)
+     *
+     * - `friendlyName` (eq, ne, ct, nct)
+     *
+     * - `description` (eq, ne, ct, nct)
+     *
+     * - `model` (eq, ne, ct, nct)
+     *
+     * - `make` (eq, ne, ct, nct)
+     *
+     * - `macAddress` (eq, ne, ct, nct)
+     *
+     * - `registrationCode` (eq, ne, ct, nct)
+     *
+     * - `status` (eq, ne, in, nin)
+     *
+     * - `deviceType` (eq, ne, in, nin)
+     *
+     * - `deviceOs` (eq, ne, in, nin)
+     *
+     * - `activationAttempts` (eq, ne, gt, ge, lt, le)
+     *
+     * - `createdDate` (gt, ge, lt, le, eq, ne)
+     *
+     * - `updatedDate` (gt, ge, lt, le, eq, ne)
+     *
+     * - `lastHealthCheck` (gt, ge, lt, le, eq, ne)
+     *
+     * - `activationExpiry` (gt, ge, lt, le, eq, ne). This filter corresponds to the `activationCodeExpiry` response field.
+     *
+     * - `paypointId` (eq, ne)
+     *
+     * - `paypointDba` (eq, ne, ct, nct)
+     *
+     * - `paypointLegal` (eq, ne, ct, nct)
+     *
+     * - `paypointEntry` (eq, ne, ct, nct)
+     *
+     * - `externalPaypointId` (eq, ne, ct, nct)
+     *
+     * - `parentOrgId` (eq, ne)
+     *
+     * - `parentOrgName` (eq, ne, 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/cjs/api/resources/query/client/requests/ListDevicesRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts

@@ -47,6 +47,7 @@ export interface ListVcardsOrgRequest {
      *   - `orgName` (ne, eq, ct, nct)
      *   - `externalPaypointId` (ct, nct, eq, ne)
      *   - `paypointId` (in, nin, eq, ne)
+     *   - `cardType` (eq)
      *
      * List of comparison accepted - enclosed between parentheses:
      *

package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts

@@ -47,6 +47,7 @@ export interface ListVcardsRequest {
      *   - `orgName` (ne, eq, ct, nct)
      *   - `externalPaypointId` (ct, nct, eq, ne)
      *   - `paypointId` (in, nin, eq, ne)
+     *   - `cardType` (eq)
      *
      * List of comparison accepted - enclosed between parentheses:
      *

package/dist/cjs/api/resources/query/client/requests/index.d.ts

@@ -8,6 +8,8 @@ export type { ListChargebacksOrgRequest } from "./ListChargebacksOrgRequest.js";
 export type { ListChargebacksRequest } from "./ListChargebacksRequest.js";
 export type { ListCustomersOrgRequest } from "./ListCustomersOrgRequest.js";
 export type { ListCustomersRequest } from "./ListCustomersRequest.js";
+export type { ListDevicesOrgRequest } from "./ListDevicesOrgRequest.js";
+export type { ListDevicesRequest } from "./ListDevicesRequest.js";
 export type { ListNotificationReportsOrgRequest } from "./ListNotificationReportsOrgRequest.js";
 export type { ListNotificationReportsRequest } from "./ListNotificationReportsRequest.js";
 export type { ListNotificationsOrgRequest } from "./ListNotificationsOrgRequest.js";

package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.d.ts

@@ -0,0 +1,50 @@
+export interface DeviceQueryRecord {
+    /** Unique identifier for the cloud device. */
+    deviceId: string | null;
+    /** Internal cloud device record ID. */
+    idCloud: number | null;
+    /** Description of the device. */
+    description: string | null;
+    /** Serial number of the device. */
+    serialNumber: string | null;
+    /** Human-readable name for the device. */
+    friendlyName: string | null;
+    /** Manufacturer of the device. */
+    make: string | null;
+    /** Model name of the device. */
+    model: string | null;
+    /** Type of device. */
+    deviceType: number | null;
+    /** Current status of the device. */
+    deviceStatus: number | null;
+    /** Operating system of the device. */
+    deviceOs: number | null;
+    /** MAC address of the device. */
+    macAddress: string | null;
+    /** Timestamp of the last health check from the device. */
+    lastHealthCheck: string | null;
+    /** Registration code used to activate the device. */
+    registrationCode: string | null;
+    /** Number of activation attempts for the device. */
+    activationAttempts: number | null;
+    /** Expiration timestamp for the device activation code. */
+    activationCodeExpiry: string | null;
+    /** Timestamp when the device record was created. */
+    createdAt: string | null;
+    /** Timestamp when the device record was last updated. */
+    updatedAt: string | null;
+    /** Numeric identifier for the paypoint. */
+    paypointId: number | null;
+    /** DBA name for the paypoint. */
+    paypointDba: string | null;
+    /** Legal name for the paypoint. */
+    paypointLegal: string | null;
+    /** Entry identifier for the paypoint. */
+    paypointEntry: string | null;
+    /** External identifier for the paypoint. */
+    externalPaypointId: string | null;
+    /** Numeric identifier for the parent organization. */
+    parentOrgId: number | null;
+    /** Name of the parent organization. */
+    parentOrgName: string | null;
+}