@payabli/sdk-node 0.0.141 → 0.0.142
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -15
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +41 -36
- package/dist/cjs/api/resources/cloud/client/Client.d.ts +4 -0
- package/dist/cjs/api/resources/cloud/client/Client.js +4 -0
- package/dist/cjs/api/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/index.js +4 -1
- package/dist/cjs/api/resources/management/client/Client.d.ts +41 -0
- package/dist/cjs/api/resources/management/client/Client.js +131 -0
- package/dist/cjs/api/resources/management/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/management/client/index.js +17 -0
- package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.ts +25 -0
- package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.js +3 -0
- package/dist/cjs/api/resources/management/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/management/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/management/exports.d.ts +2 -0
- package/dist/cjs/api/resources/management/exports.js +21 -0
- package/dist/cjs/api/resources/management/index.d.ts +2 -0
- package/dist/cjs/api/resources/management/index.js +18 -0
- package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.d.ts +31 -0
- package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.js +3 -0
- package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.d.ts +9 -0
- package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.js +3 -0
- package/dist/cjs/api/resources/management/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/management/types/index.js +18 -0
- package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/moneyIn/client/Client.js +1 -1
- package/dist/cjs/api/resources/moneyIn/types/TransactionDetailPaymentData.d.ts +1 -1
- package/dist/cjs/api/resources/query/client/Client.d.ts +42 -0
- package/dist/cjs/api/resources/query/client/Client.js +140 -0
- package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.d.ts +113 -0
- package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.d.ts +113 -0
- package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.d.ts +50 -0
- package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.d.ts +45 -0
- package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/queryTypes/types/index.js +2 -0
- package/dist/cjs/api/types/BinData.d.ts +4 -1
- package/dist/cjs/api/types/ProcessingSection.d.ts +5 -0
- package/dist/cjs/api/types/QueryChargebacksResponse.d.ts +10 -1
- package/dist/cjs/api/types/TemplateElement.d.ts +1 -0
- package/dist/cjs/api/types/VCardCardType.d.ts +6 -0
- package/dist/cjs/api/types/VCardCardType.js +3 -0
- package/dist/cjs/api/types/VCardRecord.d.ts +2 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +5 -0
- package/dist/esm/api/resources/cloud/client/Client.d.mts +4 -0
- package/dist/esm/api/resources/cloud/client/Client.mjs +4 -0
- package/dist/esm/api/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/index.mjs +3 -0
- package/dist/esm/api/resources/management/client/Client.d.mts +41 -0
- package/dist/esm/api/resources/management/client/Client.mjs +94 -0
- package/dist/esm/api/resources/management/client/index.d.mts +1 -0
- package/dist/esm/api/resources/management/client/index.mjs +1 -0
- package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.mts +25 -0
- package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.mjs +2 -0
- package/dist/esm/api/resources/management/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/management/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/management/exports.d.mts +2 -0
- package/dist/esm/api/resources/management/exports.mjs +3 -0
- package/dist/esm/api/resources/management/index.d.mts +2 -0
- package/dist/esm/api/resources/management/index.mjs +2 -0
- package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.d.mts +31 -0
- package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.mjs +2 -0
- package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.d.mts +9 -0
- package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.mjs +2 -0
- package/dist/esm/api/resources/management/types/index.d.mts +2 -0
- package/dist/esm/api/resources/management/types/index.mjs +2 -0
- package/dist/esm/api/resources/moneyIn/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/moneyIn/client/Client.mjs +1 -1
- package/dist/esm/api/resources/moneyIn/types/TransactionDetailPaymentData.d.mts +1 -1
- package/dist/esm/api/resources/query/client/Client.d.mts +42 -0
- package/dist/esm/api/resources/query/client/Client.mjs +140 -0
- package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.d.mts +113 -0
- package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.d.mts +113 -0
- package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.d.mts +50 -0
- package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.d.mts +45 -0
- package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/index.d.mts +2 -0
- package/dist/esm/api/resources/queryTypes/types/index.mjs +2 -0
- package/dist/esm/api/types/BinData.d.mts +4 -1
- package/dist/esm/api/types/ProcessingSection.d.mts +5 -0
- package/dist/esm/api/types/QueryChargebacksResponse.d.mts +10 -1
- package/dist/esm/api/types/TemplateElement.d.mts +1 -0
- package/dist/esm/api/types/VCardCardType.d.mts +6 -0
- package/dist/esm/api/types/VCardCardType.mjs +2 -0
- package/dist/esm/api/types/VCardRecord.d.mts +2 -0
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +12 -1
- package/reference.md +236 -1
|
@@ -221,6 +221,48 @@ export declare class QueryClient {
|
|
|
221
221
|
*/
|
|
222
222
|
listCustomersOrg(orgId: number, request?: Payabli.ListCustomersOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryCustomerResponse>;
|
|
223
223
|
private __listCustomersOrg;
|
|
224
|
+
/**
|
|
225
|
+
* 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.
|
|
226
|
+
*
|
|
227
|
+
* @param {Payabli.Entry} entry
|
|
228
|
+
* @param {Payabli.ListDevicesRequest} request
|
|
229
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
230
|
+
*
|
|
231
|
+
* @throws {@link Payabli.BadRequestError}
|
|
232
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
233
|
+
* @throws {@link Payabli.InternalServerError}
|
|
234
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
235
|
+
*
|
|
236
|
+
* @example
|
|
237
|
+
* await client.query.listDevices("8cfec329267", {
|
|
238
|
+
* fromRecord: 0,
|
|
239
|
+
* limitRecord: 20,
|
|
240
|
+
* sortBy: "desc(createdAt)"
|
|
241
|
+
* })
|
|
242
|
+
*/
|
|
243
|
+
listDevices(entry: Payabli.Entry, request?: Payabli.ListDevicesRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryDeviceResponse>;
|
|
244
|
+
private __listDevices;
|
|
245
|
+
/**
|
|
246
|
+
* 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.
|
|
247
|
+
*
|
|
248
|
+
* @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
|
|
249
|
+
* @param {Payabli.ListDevicesOrgRequest} request
|
|
250
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
251
|
+
*
|
|
252
|
+
* @throws {@link Payabli.BadRequestError}
|
|
253
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
254
|
+
* @throws {@link Payabli.InternalServerError}
|
|
255
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
256
|
+
*
|
|
257
|
+
* @example
|
|
258
|
+
* await client.query.listDevicesOrg(100, {
|
|
259
|
+
* fromRecord: 0,
|
|
260
|
+
* limitRecord: 20,
|
|
261
|
+
* sortBy: "desc(createdAt)"
|
|
262
|
+
* })
|
|
263
|
+
*/
|
|
264
|
+
listDevicesOrg(orgId: number, request?: Payabli.ListDevicesOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryDeviceResponse>;
|
|
265
|
+
private __listDevicesOrg;
|
|
224
266
|
/**
|
|
225
267
|
* Returns a list of all reports generated in the last 60 days for a single entrypoint. Use filters to limit results.
|
|
226
268
|
*
|
|
@@ -721,6 +721,146 @@ export class QueryClient {
|
|
|
721
721
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/customers/org/{orgId}");
|
|
722
722
|
});
|
|
723
723
|
}
|
|
724
|
+
/**
|
|
725
|
+
* 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.
|
|
726
|
+
*
|
|
727
|
+
* @param {Payabli.Entry} entry
|
|
728
|
+
* @param {Payabli.ListDevicesRequest} request
|
|
729
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
730
|
+
*
|
|
731
|
+
* @throws {@link Payabli.BadRequestError}
|
|
732
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
733
|
+
* @throws {@link Payabli.InternalServerError}
|
|
734
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
735
|
+
*
|
|
736
|
+
* @example
|
|
737
|
+
* await client.query.listDevices("8cfec329267", {
|
|
738
|
+
* fromRecord: 0,
|
|
739
|
+
* limitRecord: 20,
|
|
740
|
+
* sortBy: "desc(createdAt)"
|
|
741
|
+
* })
|
|
742
|
+
*/
|
|
743
|
+
listDevices(entry, request = {}, requestOptions) {
|
|
744
|
+
return core.HttpResponsePromise.fromPromise(this.__listDevices(entry, request, requestOptions));
|
|
745
|
+
}
|
|
746
|
+
__listDevices(entry_1) {
|
|
747
|
+
return __awaiter(this, arguments, void 0, function* (entry, request = {}, requestOptions) {
|
|
748
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
749
|
+
const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
|
|
750
|
+
const _queryParams = {
|
|
751
|
+
exportFormat: exportFormat != null ? exportFormat : undefined,
|
|
752
|
+
fromRecord,
|
|
753
|
+
limitRecord,
|
|
754
|
+
parameters: parameters != null ? toJson(parameters) : undefined,
|
|
755
|
+
sortBy,
|
|
756
|
+
};
|
|
757
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
758
|
+
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);
|
|
759
|
+
const _response = yield core.fetcher({
|
|
760
|
+
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)}`),
|
|
761
|
+
method: "GET",
|
|
762
|
+
headers: _headers,
|
|
763
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
764
|
+
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,
|
|
765
|
+
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,
|
|
766
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
767
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
768
|
+
logging: this._options.logging,
|
|
769
|
+
});
|
|
770
|
+
if (_response.ok) {
|
|
771
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
772
|
+
}
|
|
773
|
+
if (_response.error.reason === "status-code") {
|
|
774
|
+
switch (_response.error.statusCode) {
|
|
775
|
+
case 400:
|
|
776
|
+
throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
|
|
777
|
+
case 401:
|
|
778
|
+
throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
779
|
+
case 500:
|
|
780
|
+
throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
|
|
781
|
+
case 503:
|
|
782
|
+
throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
783
|
+
default:
|
|
784
|
+
throw new errors.PayabliError({
|
|
785
|
+
statusCode: _response.error.statusCode,
|
|
786
|
+
body: _response.error.body,
|
|
787
|
+
rawResponse: _response.rawResponse,
|
|
788
|
+
});
|
|
789
|
+
}
|
|
790
|
+
}
|
|
791
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/devices/{entry}");
|
|
792
|
+
});
|
|
793
|
+
}
|
|
794
|
+
/**
|
|
795
|
+
* 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.
|
|
796
|
+
*
|
|
797
|
+
* @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
|
|
798
|
+
* @param {Payabli.ListDevicesOrgRequest} request
|
|
799
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
800
|
+
*
|
|
801
|
+
* @throws {@link Payabli.BadRequestError}
|
|
802
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
803
|
+
* @throws {@link Payabli.InternalServerError}
|
|
804
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
805
|
+
*
|
|
806
|
+
* @example
|
|
807
|
+
* await client.query.listDevicesOrg(100, {
|
|
808
|
+
* fromRecord: 0,
|
|
809
|
+
* limitRecord: 20,
|
|
810
|
+
* sortBy: "desc(createdAt)"
|
|
811
|
+
* })
|
|
812
|
+
*/
|
|
813
|
+
listDevicesOrg(orgId, request = {}, requestOptions) {
|
|
814
|
+
return core.HttpResponsePromise.fromPromise(this.__listDevicesOrg(orgId, request, requestOptions));
|
|
815
|
+
}
|
|
816
|
+
__listDevicesOrg(orgId_1) {
|
|
817
|
+
return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
|
|
818
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
819
|
+
const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
|
|
820
|
+
const _queryParams = {
|
|
821
|
+
exportFormat: exportFormat != null ? exportFormat : undefined,
|
|
822
|
+
fromRecord,
|
|
823
|
+
limitRecord,
|
|
824
|
+
parameters: parameters != null ? toJson(parameters) : undefined,
|
|
825
|
+
sortBy,
|
|
826
|
+
};
|
|
827
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
828
|
+
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);
|
|
829
|
+
const _response = yield core.fetcher({
|
|
830
|
+
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)}`),
|
|
831
|
+
method: "GET",
|
|
832
|
+
headers: _headers,
|
|
833
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
834
|
+
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,
|
|
835
|
+
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,
|
|
836
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
837
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
838
|
+
logging: this._options.logging,
|
|
839
|
+
});
|
|
840
|
+
if (_response.ok) {
|
|
841
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
842
|
+
}
|
|
843
|
+
if (_response.error.reason === "status-code") {
|
|
844
|
+
switch (_response.error.statusCode) {
|
|
845
|
+
case 400:
|
|
846
|
+
throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
|
|
847
|
+
case 401:
|
|
848
|
+
throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
849
|
+
case 500:
|
|
850
|
+
throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
|
|
851
|
+
case 503:
|
|
852
|
+
throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
853
|
+
default:
|
|
854
|
+
throw new errors.PayabliError({
|
|
855
|
+
statusCode: _response.error.statusCode,
|
|
856
|
+
body: _response.error.body,
|
|
857
|
+
rawResponse: _response.rawResponse,
|
|
858
|
+
});
|
|
859
|
+
}
|
|
860
|
+
}
|
|
861
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/devices/org/{orgId}");
|
|
862
|
+
});
|
|
863
|
+
}
|
|
724
864
|
/**
|
|
725
865
|
* Returns a list of all reports generated in the last 60 days for a single entrypoint. Use filters to limit results.
|
|
726
866
|
*
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import type * as Payabli from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* fromRecord: 0,
|
|
6
|
+
* limitRecord: 20,
|
|
7
|
+
* sortBy: "desc(createdAt)"
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface ListDevicesOrgRequest {
|
|
11
|
+
exportFormat?: Payabli.ExportFormat;
|
|
12
|
+
/** The number of records to skip before starting to collect the result set. */
|
|
13
|
+
fromRecord?: number;
|
|
14
|
+
/** Max number of records to return for the query. Use `0` or negative value to return all records. */
|
|
15
|
+
limitRecord?: number;
|
|
16
|
+
/**
|
|
17
|
+
* Collection of field names, conditions, and values used to filter
|
|
18
|
+
* the query.
|
|
19
|
+
*
|
|
20
|
+
* <Info>
|
|
21
|
+
* **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22
|
+
*
|
|
23
|
+
* 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.
|
|
24
|
+
*
|
|
25
|
+
* For example:
|
|
26
|
+
*
|
|
27
|
+
* --url https://api-sandbox.payabli.com/api/Query/devices/org/236?parameters=status=1&limitRecord=20
|
|
28
|
+
*
|
|
29
|
+
* should become:
|
|
30
|
+
*
|
|
31
|
+
* --url https://api-sandbox.payabli.com/api/Query/devices/org/236?status=1&limitRecord=20
|
|
32
|
+
* </Info>
|
|
33
|
+
*
|
|
34
|
+
* See [Filters and Conditions
|
|
35
|
+
* Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
|
|
36
|
+
* for more information.
|
|
37
|
+
*
|
|
38
|
+
* **List of field names accepted:**
|
|
39
|
+
*
|
|
40
|
+
*
|
|
41
|
+
* - `deviceId` (eq, ne, ct, nct)
|
|
42
|
+
*
|
|
43
|
+
* - `serialNumber` (eq, ne, ct, nct)
|
|
44
|
+
*
|
|
45
|
+
* - `friendlyName` (eq, ne, ct, nct)
|
|
46
|
+
*
|
|
47
|
+
* - `description` (eq, ne, ct, nct)
|
|
48
|
+
*
|
|
49
|
+
* - `model` (eq, ne, ct, nct)
|
|
50
|
+
*
|
|
51
|
+
* - `make` (eq, ne, ct, nct)
|
|
52
|
+
*
|
|
53
|
+
* - `macAddress` (eq, ne, ct, nct)
|
|
54
|
+
*
|
|
55
|
+
* - `registrationCode` (eq, ne, ct, nct)
|
|
56
|
+
*
|
|
57
|
+
* - `status` (eq, ne, in, nin)
|
|
58
|
+
*
|
|
59
|
+
* - `deviceType` (eq, ne, in, nin)
|
|
60
|
+
*
|
|
61
|
+
* - `deviceOs` (eq, ne, in, nin)
|
|
62
|
+
*
|
|
63
|
+
* - `activationAttempts` (eq, ne, gt, ge, lt, le)
|
|
64
|
+
*
|
|
65
|
+
* - `createdDate` (gt, ge, lt, le, eq, ne)
|
|
66
|
+
*
|
|
67
|
+
* - `updatedDate` (gt, ge, lt, le, eq, ne)
|
|
68
|
+
*
|
|
69
|
+
* - `lastHealthCheck` (gt, ge, lt, le, eq, ne)
|
|
70
|
+
*
|
|
71
|
+
* - `activationExpiry` (gt, ge, lt, le, eq, ne). This filter corresponds to the `activationCodeExpiry` response field.
|
|
72
|
+
*
|
|
73
|
+
* - `paypointId` (eq, ne)
|
|
74
|
+
*
|
|
75
|
+
* - `paypointDba` (eq, ne, ct, nct)
|
|
76
|
+
*
|
|
77
|
+
* - `paypointLegal` (eq, ne, ct, nct)
|
|
78
|
+
*
|
|
79
|
+
* - `paypointEntry` (eq, ne, ct, nct)
|
|
80
|
+
*
|
|
81
|
+
* - `externalPaypointId` (eq, ne, ct, nct)
|
|
82
|
+
*
|
|
83
|
+
* - `parentOrgId` (eq, ne)
|
|
84
|
+
*
|
|
85
|
+
* - `parentOrgName` (eq, ne, ct, nct)
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* **List of comparison operators accepted:**
|
|
89
|
+
*
|
|
90
|
+
* - `eq` or empty => equal
|
|
91
|
+
*
|
|
92
|
+
* - `gt` => greater than
|
|
93
|
+
*
|
|
94
|
+
* - `ge` => greater or equal
|
|
95
|
+
*
|
|
96
|
+
* - `lt` => less than
|
|
97
|
+
*
|
|
98
|
+
* - `le` => less or equal
|
|
99
|
+
*
|
|
100
|
+
* - `ne` => not equal
|
|
101
|
+
*
|
|
102
|
+
* - `ct` => contains
|
|
103
|
+
*
|
|
104
|
+
* - `nct` => not contains
|
|
105
|
+
*
|
|
106
|
+
* - `in` => inside array
|
|
107
|
+
*
|
|
108
|
+
* - `nin` => not inside array
|
|
109
|
+
*/
|
|
110
|
+
parameters?: Record<string, string>;
|
|
111
|
+
/** 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`. */
|
|
112
|
+
sortBy?: string;
|
|
113
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import type * as Payabli from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* fromRecord: 0,
|
|
6
|
+
* limitRecord: 20,
|
|
7
|
+
* sortBy: "desc(createdAt)"
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface ListDevicesRequest {
|
|
11
|
+
exportFormat?: Payabli.ExportFormat;
|
|
12
|
+
/** The number of records to skip before starting to collect the result set. */
|
|
13
|
+
fromRecord?: number;
|
|
14
|
+
/** Max number of records to return for the query. Use `0` or negative value to return all records. */
|
|
15
|
+
limitRecord?: number;
|
|
16
|
+
/**
|
|
17
|
+
* Collection of field names, conditions, and values used to filter
|
|
18
|
+
* the query.
|
|
19
|
+
*
|
|
20
|
+
* <Info>
|
|
21
|
+
* **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22
|
+
*
|
|
23
|
+
* 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.
|
|
24
|
+
*
|
|
25
|
+
* For example:
|
|
26
|
+
*
|
|
27
|
+
* --url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?parameters=status=1&limitRecord=20
|
|
28
|
+
*
|
|
29
|
+
* should become:
|
|
30
|
+
*
|
|
31
|
+
* --url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?status=1&limitRecord=20
|
|
32
|
+
* </Info>
|
|
33
|
+
*
|
|
34
|
+
* See [Filters and Conditions
|
|
35
|
+
* Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
|
|
36
|
+
* for more information.
|
|
37
|
+
*
|
|
38
|
+
* **List of field names accepted:**
|
|
39
|
+
*
|
|
40
|
+
*
|
|
41
|
+
* - `deviceId` (eq, ne, ct, nct)
|
|
42
|
+
*
|
|
43
|
+
* - `serialNumber` (eq, ne, ct, nct)
|
|
44
|
+
*
|
|
45
|
+
* - `friendlyName` (eq, ne, ct, nct)
|
|
46
|
+
*
|
|
47
|
+
* - `description` (eq, ne, ct, nct)
|
|
48
|
+
*
|
|
49
|
+
* - `model` (eq, ne, ct, nct)
|
|
50
|
+
*
|
|
51
|
+
* - `make` (eq, ne, ct, nct)
|
|
52
|
+
*
|
|
53
|
+
* - `macAddress` (eq, ne, ct, nct)
|
|
54
|
+
*
|
|
55
|
+
* - `registrationCode` (eq, ne, ct, nct)
|
|
56
|
+
*
|
|
57
|
+
* - `status` (eq, ne, in, nin)
|
|
58
|
+
*
|
|
59
|
+
* - `deviceType` (eq, ne, in, nin)
|
|
60
|
+
*
|
|
61
|
+
* - `deviceOs` (eq, ne, in, nin)
|
|
62
|
+
*
|
|
63
|
+
* - `activationAttempts` (eq, ne, gt, ge, lt, le)
|
|
64
|
+
*
|
|
65
|
+
* - `createdDate` (gt, ge, lt, le, eq, ne)
|
|
66
|
+
*
|
|
67
|
+
* - `updatedDate` (gt, ge, lt, le, eq, ne)
|
|
68
|
+
*
|
|
69
|
+
* - `lastHealthCheck` (gt, ge, lt, le, eq, ne)
|
|
70
|
+
*
|
|
71
|
+
* - `activationExpiry` (gt, ge, lt, le, eq, ne). This filter corresponds to the `activationCodeExpiry` response field.
|
|
72
|
+
*
|
|
73
|
+
* - `paypointId` (eq, ne)
|
|
74
|
+
*
|
|
75
|
+
* - `paypointDba` (eq, ne, ct, nct)
|
|
76
|
+
*
|
|
77
|
+
* - `paypointLegal` (eq, ne, ct, nct)
|
|
78
|
+
*
|
|
79
|
+
* - `paypointEntry` (eq, ne, ct, nct)
|
|
80
|
+
*
|
|
81
|
+
* - `externalPaypointId` (eq, ne, ct, nct)
|
|
82
|
+
*
|
|
83
|
+
* - `parentOrgId` (eq, ne)
|
|
84
|
+
*
|
|
85
|
+
* - `parentOrgName` (eq, ne, ct, nct)
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* **List of comparison operators accepted:**
|
|
89
|
+
*
|
|
90
|
+
* - `eq` or empty => equal
|
|
91
|
+
*
|
|
92
|
+
* - `gt` => greater than
|
|
93
|
+
*
|
|
94
|
+
* - `ge` => greater or equal
|
|
95
|
+
*
|
|
96
|
+
* - `lt` => less than
|
|
97
|
+
*
|
|
98
|
+
* - `le` => less or equal
|
|
99
|
+
*
|
|
100
|
+
* - `ne` => not equal
|
|
101
|
+
*
|
|
102
|
+
* - `ct` => contains
|
|
103
|
+
*
|
|
104
|
+
* - `nct` => not contains
|
|
105
|
+
*
|
|
106
|
+
* - `in` => inside array
|
|
107
|
+
*
|
|
108
|
+
* - `nin` => not inside array
|
|
109
|
+
*/
|
|
110
|
+
parameters?: Record<string, string>;
|
|
111
|
+
/** 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`. */
|
|
112
|
+
sortBy?: string;
|
|
113
|
+
}
|
|
@@ -8,6 +8,8 @@ export type { ListChargebacksOrgRequest } from "./ListChargebacksOrgRequest.mjs"
|
|
|
8
8
|
export type { ListChargebacksRequest } from "./ListChargebacksRequest.mjs";
|
|
9
9
|
export type { ListCustomersOrgRequest } from "./ListCustomersOrgRequest.mjs";
|
|
10
10
|
export type { ListCustomersRequest } from "./ListCustomersRequest.mjs";
|
|
11
|
+
export type { ListDevicesOrgRequest } from "./ListDevicesOrgRequest.mjs";
|
|
12
|
+
export type { ListDevicesRequest } from "./ListDevicesRequest.mjs";
|
|
11
13
|
export type { ListNotificationReportsOrgRequest } from "./ListNotificationReportsOrgRequest.mjs";
|
|
12
14
|
export type { ListNotificationReportsRequest } from "./ListNotificationReportsRequest.mjs";
|
|
13
15
|
export type { ListNotificationsOrgRequest } from "./ListNotificationsOrgRequest.mjs";
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
export interface DeviceQueryRecord {
|
|
2
|
+
/** Unique identifier for the cloud device. */
|
|
3
|
+
deviceId: string | null;
|
|
4
|
+
/** Internal cloud device record ID. */
|
|
5
|
+
idCloud: number | null;
|
|
6
|
+
/** Description of the device. */
|
|
7
|
+
description: string | null;
|
|
8
|
+
/** Serial number of the device. */
|
|
9
|
+
serialNumber: string | null;
|
|
10
|
+
/** Human-readable name for the device. */
|
|
11
|
+
friendlyName: string | null;
|
|
12
|
+
/** Manufacturer of the device. */
|
|
13
|
+
make: string | null;
|
|
14
|
+
/** Model name of the device. */
|
|
15
|
+
model: string | null;
|
|
16
|
+
/** Type of device. */
|
|
17
|
+
deviceType: number | null;
|
|
18
|
+
/** Current status of the device. */
|
|
19
|
+
deviceStatus: number | null;
|
|
20
|
+
/** Operating system of the device. */
|
|
21
|
+
deviceOs: number | null;
|
|
22
|
+
/** MAC address of the device. */
|
|
23
|
+
macAddress: string | null;
|
|
24
|
+
/** Timestamp of the last health check from the device. */
|
|
25
|
+
lastHealthCheck: string | null;
|
|
26
|
+
/** Registration code used to activate the device. */
|
|
27
|
+
registrationCode: string | null;
|
|
28
|
+
/** Number of activation attempts for the device. */
|
|
29
|
+
activationAttempts: number | null;
|
|
30
|
+
/** Expiration timestamp for the device activation code. */
|
|
31
|
+
activationCodeExpiry: string | null;
|
|
32
|
+
/** Timestamp when the device record was created. */
|
|
33
|
+
createdAt: string | null;
|
|
34
|
+
/** Timestamp when the device record was last updated. */
|
|
35
|
+
updatedAt: string | null;
|
|
36
|
+
/** Numeric identifier for the paypoint. */
|
|
37
|
+
paypointId: number | null;
|
|
38
|
+
/** DBA name for the paypoint. */
|
|
39
|
+
paypointDba: string | null;
|
|
40
|
+
/** Legal name for the paypoint. */
|
|
41
|
+
paypointLegal: string | null;
|
|
42
|
+
/** Entry identifier for the paypoint. */
|
|
43
|
+
paypointEntry: string | null;
|
|
44
|
+
/** External identifier for the paypoint. */
|
|
45
|
+
externalPaypointId: string | null;
|
|
46
|
+
/** Numeric identifier for the parent organization. */
|
|
47
|
+
parentOrgId: number | null;
|
|
48
|
+
/** Name of the parent organization. */
|
|
49
|
+
parentOrgName: string | null;
|
|
50
|
+
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Response body for queries about cloud devices.
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* Summary: {
|
|
8
|
+
* pageSize: 20,
|
|
9
|
+
* totalAmount: 0,
|
|
10
|
+
* totalNetAmount: 0,
|
|
11
|
+
* totalPages: 2,
|
|
12
|
+
* totalRecords: 28
|
|
13
|
+
* },
|
|
14
|
+
* Records: [{
|
|
15
|
+
* deviceId: "DEV-A1B2C3D4",
|
|
16
|
+
* idCloud: 142,
|
|
17
|
+
* description: "Front Counter Terminal",
|
|
18
|
+
* serialNumber: "SN-90210-XR",
|
|
19
|
+
* friendlyName: "Front Counter Terminal",
|
|
20
|
+
* make: "Ingenico",
|
|
21
|
+
* model: "LK2500",
|
|
22
|
+
* deviceType: 1,
|
|
23
|
+
* deviceStatus: 1,
|
|
24
|
+
* deviceOs: null,
|
|
25
|
+
* macAddress: "1A2B3C4D5E6F",
|
|
26
|
+
* lastHealthCheck: "2026-04-09T14:49:42Z",
|
|
27
|
+
* registrationCode: "REG-A1B2C3D4",
|
|
28
|
+
* activationAttempts: 0,
|
|
29
|
+
* activationCodeExpiry: "2026-04-09T14:49:42Z",
|
|
30
|
+
* createdAt: "2026-04-09T01:14:37Z",
|
|
31
|
+
* updatedAt: "2026-04-09T14:49:42Z",
|
|
32
|
+
* paypointId: 12345,
|
|
33
|
+
* paypointDba: "Gruzya Adventure Outfitters",
|
|
34
|
+
* paypointLegal: "Gruzya Adventure Outfitters, LLC",
|
|
35
|
+
* paypointEntry: "8cfec329267",
|
|
36
|
+
* externalPaypointId: "GRUZYA-01",
|
|
37
|
+
* parentOrgId: 100,
|
|
38
|
+
* parentOrgName: "Example Corp"
|
|
39
|
+
* }]
|
|
40
|
+
* }
|
|
41
|
+
*/
|
|
42
|
+
export interface QueryDeviceResponse {
|
|
43
|
+
Summary: Payabli.QuerySummary;
|
|
44
|
+
Records: Payabli.DeviceQueryRecord[];
|
|
45
|
+
}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
export * from "./DeviceQueryRecord.mjs";
|
|
1
2
|
export * from "./LimitRecord.mjs";
|
|
2
3
|
export * from "./ListOrganizationsResponse.mjs";
|
|
3
4
|
export * from "./QueryBatchesDetailResponse.mjs";
|
|
4
5
|
export * from "./QueryBatchesResponse.mjs";
|
|
5
6
|
export * from "./QueryBatchesTransfer.mjs";
|
|
7
|
+
export * from "./QueryDeviceResponse.mjs";
|
|
6
8
|
export * from "./QueryTransferDetailResponse.mjs";
|
|
7
9
|
export * from "./QueryTransferResponse.mjs";
|
|
8
10
|
export * from "./QueryTransferSummary.mjs";
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
export * from "./DeviceQueryRecord.mjs";
|
|
1
2
|
export * from "./LimitRecord.mjs";
|
|
2
3
|
export * from "./ListOrganizationsResponse.mjs";
|
|
3
4
|
export * from "./QueryBatchesDetailResponse.mjs";
|
|
4
5
|
export * from "./QueryBatchesResponse.mjs";
|
|
5
6
|
export * from "./QueryBatchesTransfer.mjs";
|
|
7
|
+
export * from "./QueryDeviceResponse.mjs";
|
|
6
8
|
export * from "./QueryTransferDetailResponse.mjs";
|
|
7
9
|
export * from "./QueryTransferResponse.mjs";
|
|
8
10
|
export * from "./QueryTransferSummary.mjs";
|
|
@@ -46,7 +46,10 @@ export interface BinData {
|
|
|
46
46
|
* Discover.
|
|
47
47
|
*/
|
|
48
48
|
binCardBrand?: string | undefined;
|
|
49
|
-
/**
|
|
49
|
+
/**
|
|
50
|
+
* The type of card: `Credit` or `Debit`. Case can vary between
|
|
51
|
+
* processors, so compare this value case-insensitively.
|
|
52
|
+
*/
|
|
50
53
|
binCardType?: string | undefined;
|
|
51
54
|
/** The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked `PREPAID`. */
|
|
52
55
|
binCardCategory?: string | undefined;
|
|
@@ -15,4 +15,9 @@ export interface ProcessingSection {
|
|
|
15
15
|
whenDelivered?: Payabli.TemplateElement | undefined;
|
|
16
16
|
whenProvided?: Payabli.TemplateElement | undefined;
|
|
17
17
|
whenRefunded?: Payabli.TemplateElement | undefined;
|
|
18
|
+
CombinedBatches?: Payabli.TemplateElement | undefined;
|
|
19
|
+
payoutAverageMonthlyVolume?: Payabli.TemplateElement | undefined;
|
|
20
|
+
payoutHighTicketAmount?: Payabli.TemplateElement | undefined;
|
|
21
|
+
payoutAverageTicketAmount?: Payabli.TemplateElement | undefined;
|
|
22
|
+
payoutCreditLimit?: Payabli.TemplateElement | undefined;
|
|
18
23
|
}
|
|
@@ -51,7 +51,16 @@ export declare namespace QueryChargebacksResponse {
|
|
|
51
51
|
Responses?: string | undefined;
|
|
52
52
|
/** Reference for any scheduled transactions. */
|
|
53
53
|
ScheduleReference?: number | undefined;
|
|
54
|
-
/**
|
|
54
|
+
/**
|
|
55
|
+
* Status of the chargeback or ACH return.
|
|
56
|
+
*
|
|
57
|
+
* - 0: Open (chargebacks only)
|
|
58
|
+
* - 1: Pending (chargebacks only)
|
|
59
|
+
* - 2: ClosedWon (chargebacks only)
|
|
60
|
+
* - 3: ClosedLost (chargebacks only)
|
|
61
|
+
* - 4: ACH return (any Nacha return code except R29)
|
|
62
|
+
* - 5: AchDispute (R29 only — debit block)
|
|
63
|
+
*/
|
|
55
64
|
Status?: number | undefined;
|
|
56
65
|
Transaction?: Payabli.TransactionQueryRecords | undefined;
|
|
57
66
|
TransactionTime?: Payabli.TransactionTime | undefined;
|
|
@@ -3,6 +3,7 @@ import type * as Payabli from "../index.mjs";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* vcardSent: true,
|
|
6
|
+
* cardType: 0,
|
|
6
7
|
* cardToken: "vcrd_5Ty8NrBzXjKuqHm9DwElfP",
|
|
7
8
|
* cardNumber: "44XX XXXX XXXX 1234",
|
|
8
9
|
* cvc: "XXX",
|
|
@@ -43,6 +44,7 @@ import type * as Payabli from "../index.mjs";
|
|
|
43
44
|
export interface VCardRecord {
|
|
44
45
|
/** When `true`, the vCard has been sent. */
|
|
45
46
|
vcardSent?: boolean | undefined;
|
|
47
|
+
cardType?: Payabli.VCardCardType | undefined;
|
|
46
48
|
cardToken?: string | undefined;
|
|
47
49
|
/** The vCard number. */
|
|
48
50
|
cardNumber?: string | undefined;
|