@payabli/sdk-node 0.0.140 → 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/bill/types/BillOutData.d.ts +5 -1
- 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 +4 -0
- package/dist/cjs/api/resources/index.js +5 -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/moneyOut/client/Client.d.ts +5 -2
- package/dist/cjs/api/resources/moneyOut/client/Client.js +5 -2
- package/dist/cjs/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.ts +3 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.ts +1 -0
- package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.ts +7 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.ts +7 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.ts +7 -0
- package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.ts +7 -0
- 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/resources/vendor/client/Client.d.ts +44 -1
- package/dist/cjs/api/resources/vendor/client/Client.js +88 -1
- package/dist/cjs/api/resources/vendor/index.d.ts +1 -0
- package/dist/cjs/api/resources/vendor/index.js +1 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichRequest.d.ts +20 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichRequest.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichResponse.d.ts +12 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichResponse.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichResponseData.d.ts +16 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichResponseData.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentData.d.ts +10 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentData.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentInvoiceScan.d.ts +35 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentInvoiceScan.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentWebSearch.d.ts +35 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentWebSearch.js +3 -0
- package/dist/cjs/api/resources/vendor/types/index.d.ts +6 -0
- package/dist/cjs/api/resources/vendor/types/index.js +22 -0
- package/dist/cjs/api/types/AutoCapture.d.ts +4 -0
- package/dist/cjs/api/types/AutoCapture.js +3 -0
- package/dist/cjs/api/types/BinData.d.ts +4 -1
- package/dist/cjs/api/types/NotificationContent.d.ts +0 -1
- package/dist/cjs/api/types/NotificationContent.js +0 -1
- package/dist/cjs/api/types/NotificationStandardRequest.d.ts +0 -1
- package/dist/cjs/api/types/NotificationStandardRequest.js +0 -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/VendorData.d.ts +12 -0
- package/dist/cjs/api/types/VendorQueryRecord.d.ts +21 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -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/bill/types/BillOutData.d.mts +5 -1
- 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 +4 -0
- package/dist/esm/api/resources/index.mjs +4 -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/moneyOut/client/Client.d.mts +5 -2
- package/dist/esm/api/resources/moneyOut/client/Client.mjs +5 -2
- package/dist/esm/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.mts +3 -0
- package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.mts +1 -0
- package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.mts +7 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.mts +7 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.mts +7 -0
- package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.mts +7 -0
- 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/resources/vendor/client/Client.d.mts +44 -1
- package/dist/esm/api/resources/vendor/client/Client.mjs +88 -1
- package/dist/esm/api/resources/vendor/index.d.mts +1 -0
- package/dist/esm/api/resources/vendor/index.mjs +1 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichRequest.d.mts +20 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichRequest.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichResponse.d.mts +12 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichResponse.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichResponseData.d.mts +16 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichResponseData.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentData.d.mts +10 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentData.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentInvoiceScan.d.mts +35 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentInvoiceScan.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentWebSearch.d.mts +35 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentWebSearch.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/index.d.mts +6 -0
- package/dist/esm/api/resources/vendor/types/index.mjs +6 -0
- package/dist/esm/api/types/AutoCapture.d.mts +4 -0
- package/dist/esm/api/types/AutoCapture.mjs +2 -0
- package/dist/esm/api/types/BinData.d.mts +4 -1
- package/dist/esm/api/types/NotificationContent.d.mts +0 -1
- package/dist/esm/api/types/NotificationContent.mjs +0 -1
- package/dist/esm/api/types/NotificationStandardRequest.d.mts +0 -1
- package/dist/esm/api/types/NotificationStandardRequest.mjs +0 -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/VendorData.d.mts +12 -0
- package/dist/esm/api/types/VendorQueryRecord.d.mts +21 -0
- package/dist/esm/api/types/index.d.mts +2 -0
- package/dist/esm/api/types/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +12 -1
- package/reference.md +321 -4
|
@@ -389,7 +389,7 @@ export declare class MoneyInClient {
|
|
|
389
389
|
getpaid(request: Payabli.RequestPayment, requestOptions?: MoneyInClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponseGetPaid>;
|
|
390
390
|
private __getpaid;
|
|
391
391
|
/**
|
|
392
|
-
* 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.
|
|
392
|
+
* 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.
|
|
393
393
|
*
|
|
394
394
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
395
395
|
* @param {number} amount -
|
|
@@ -684,7 +684,7 @@ export class MoneyInClient {
|
|
|
684
684
|
});
|
|
685
685
|
}
|
|
686
686
|
/**
|
|
687
|
-
* 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.
|
|
687
|
+
* 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.
|
|
688
688
|
*
|
|
689
689
|
* @param {string} transId - ReferenceId for the transaction (PaymentId).
|
|
690
690
|
* @param {number} amount -
|
|
@@ -11,7 +11,7 @@ export interface TransactionDetailPaymentData {
|
|
|
11
11
|
initiator: Payabli.Initiator | null;
|
|
12
12
|
storedMethodUsageType: Payabli.StoredMethodUsageType | null;
|
|
13
13
|
sequence: Payabli.Sequence | null;
|
|
14
|
-
orderDescription: Payabli.Orderdescription;
|
|
14
|
+
orderDescription: Payabli.Orderdescription | null;
|
|
15
15
|
accountId: Payabli.AccountId | null;
|
|
16
16
|
signatureData: Payabli.Signaturedata | null;
|
|
17
17
|
binData: Payabli.BinData | null;
|
|
@@ -11,7 +11,7 @@ export declare class MoneyOutClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<MoneyOutClient.Options>;
|
|
12
12
|
constructor(options?: MoneyOutClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Authorizes transaction for payout.
|
|
14
|
+
* Authorizes transaction for payout. If you don't pass the `autoCapture` field with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction.
|
|
15
15
|
*
|
|
16
16
|
* @param {Payabli.MoneyOutTypesRequestOutAuthorize} request
|
|
17
17
|
* @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -25,6 +25,7 @@ export declare class MoneyOutClient {
|
|
|
25
25
|
* await client.moneyOut.authorizeOut({
|
|
26
26
|
* body: {
|
|
27
27
|
* entryPoint: "48acde49",
|
|
28
|
+
* autoCapture: true,
|
|
28
29
|
* invoiceData: [{
|
|
29
30
|
* billId: 54323
|
|
30
31
|
* }],
|
|
@@ -46,6 +47,7 @@ export declare class MoneyOutClient {
|
|
|
46
47
|
* await client.moneyOut.authorizeOut({
|
|
47
48
|
* body: {
|
|
48
49
|
* entryPoint: "48acde49",
|
|
50
|
+
* autoCapture: true,
|
|
49
51
|
* invoiceData: [{
|
|
50
52
|
* billId: 123,
|
|
51
53
|
* attachments: [{
|
|
@@ -71,6 +73,7 @@ export declare class MoneyOutClient {
|
|
|
71
73
|
* await client.moneyOut.authorizeOut({
|
|
72
74
|
* body: {
|
|
73
75
|
* entryPoint: "48acde49",
|
|
76
|
+
* autoCapture: true,
|
|
74
77
|
* source: "api",
|
|
75
78
|
* invoiceData: [{
|
|
76
79
|
* billId: 54323
|
|
@@ -233,7 +236,7 @@ export declare class MoneyOutClient {
|
|
|
233
236
|
captureAllOut(request: Payabli.CaptureAllOutRequest, requestOptions?: MoneyOutClient.RequestOptions): core.HttpResponsePromise<Payabli.CaptureAllOutResponse>;
|
|
234
237
|
private __captureAllOut;
|
|
235
238
|
/**
|
|
236
|
-
* Captures a single authorized payout transaction by ID.
|
|
239
|
+
* Captures a single authorized payout transaction by ID. If the transaction was authorized with `autoCapture` set to `true`, you don't need to call this endpoint to capture the transaction for processing.
|
|
237
240
|
*
|
|
238
241
|
* @param {string} referenceId - The ID for the payout transaction.
|
|
239
242
|
* @param {Payabli.CaptureOutRequest} request
|
|
@@ -20,7 +20,7 @@ export class MoneyOutClient {
|
|
|
20
20
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Authorizes transaction for payout.
|
|
23
|
+
* Authorizes transaction for payout. If you don't pass the `autoCapture` field with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction.
|
|
24
24
|
*
|
|
25
25
|
* @param {Payabli.MoneyOutTypesRequestOutAuthorize} request
|
|
26
26
|
* @param {MoneyOutClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -34,6 +34,7 @@ export class MoneyOutClient {
|
|
|
34
34
|
* await client.moneyOut.authorizeOut({
|
|
35
35
|
* body: {
|
|
36
36
|
* entryPoint: "48acde49",
|
|
37
|
+
* autoCapture: true,
|
|
37
38
|
* invoiceData: [{
|
|
38
39
|
* billId: 54323
|
|
39
40
|
* }],
|
|
@@ -55,6 +56,7 @@ export class MoneyOutClient {
|
|
|
55
56
|
* await client.moneyOut.authorizeOut({
|
|
56
57
|
* body: {
|
|
57
58
|
* entryPoint: "48acde49",
|
|
59
|
+
* autoCapture: true,
|
|
58
60
|
* invoiceData: [{
|
|
59
61
|
* billId: 123,
|
|
60
62
|
* attachments: [{
|
|
@@ -80,6 +82,7 @@ export class MoneyOutClient {
|
|
|
80
82
|
* await client.moneyOut.authorizeOut({
|
|
81
83
|
* body: {
|
|
82
84
|
* entryPoint: "48acde49",
|
|
85
|
+
* autoCapture: true,
|
|
83
86
|
* source: "api",
|
|
84
87
|
* invoiceData: [{
|
|
85
88
|
* billId: 54323
|
|
@@ -463,7 +466,7 @@ export class MoneyOutClient {
|
|
|
463
466
|
});
|
|
464
467
|
}
|
|
465
468
|
/**
|
|
466
|
-
* Captures a single authorized payout transaction by ID.
|
|
469
|
+
* Captures a single authorized payout transaction by ID. If the transaction was authorized with `autoCapture` set to `true`, you don't need to call this endpoint to capture the transaction for processing.
|
|
467
470
|
*
|
|
468
471
|
* @param {string} referenceId - The ID for the payout transaction.
|
|
469
472
|
* @param {Payabli.CaptureOutRequest} request
|
package/dist/esm/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.mts
CHANGED
|
@@ -4,6 +4,7 @@ import type * as Payabli from "../../../../index.mjs";
|
|
|
4
4
|
* {
|
|
5
5
|
* body: {
|
|
6
6
|
* entryPoint: "48acde49",
|
|
7
|
+
* autoCapture: true,
|
|
7
8
|
* invoiceData: [{
|
|
8
9
|
* billId: 54323
|
|
9
10
|
* }],
|
|
@@ -25,6 +26,7 @@ import type * as Payabli from "../../../../index.mjs";
|
|
|
25
26
|
* {
|
|
26
27
|
* body: {
|
|
27
28
|
* entryPoint: "48acde49",
|
|
29
|
+
* autoCapture: true,
|
|
28
30
|
* invoiceData: [{
|
|
29
31
|
* billId: 123,
|
|
30
32
|
* attachments: [{
|
|
@@ -50,6 +52,7 @@ import type * as Payabli from "../../../../index.mjs";
|
|
|
50
52
|
* {
|
|
51
53
|
* body: {
|
|
52
54
|
* entryPoint: "48acde49",
|
|
55
|
+
* autoCapture: true,
|
|
53
56
|
* source: "api",
|
|
54
57
|
* invoiceData: [{
|
|
55
58
|
* billId: 54323
|
|
@@ -14,6 +14,7 @@ export interface AuthorizePayoutBody {
|
|
|
14
14
|
accountId?: Payabli.AccountId | undefined;
|
|
15
15
|
subdomain?: Payabli.Subdomain | undefined;
|
|
16
16
|
subscriptionId?: Payabli.Subscriptionid | undefined;
|
|
17
|
+
autoCapture?: Payabli.AutoCapture | undefined;
|
|
17
18
|
}
|
|
18
19
|
export declare namespace AuthorizePayoutBody {
|
|
19
20
|
/**
|
|
@@ -94,6 +94,13 @@ import type * as Payabli from "../../../index.mjs";
|
|
|
94
94
|
* customField2: "",
|
|
95
95
|
* customerVendorAccount: "123-456",
|
|
96
96
|
* InternalReferenceId: 1000000,
|
|
97
|
+
* PaymentPortalUrl: "https://greenfield-landscaping.com/pay",
|
|
98
|
+
* CardAccepted: "yes",
|
|
99
|
+
* AchAccepted: "unable to determine",
|
|
100
|
+
* EnrichmentStatus: "fully_enriched",
|
|
101
|
+
* EnrichedBy: "web_search",
|
|
102
|
+
* EnrichedAt: "2026-03-05T14:22:10Z",
|
|
103
|
+
* EnrichmentId: "enrich-3890-a1b2c3d4",
|
|
97
104
|
* externalPaypointID: "Paypoint-100",
|
|
98
105
|
* StoredMethods: []
|
|
99
106
|
* },
|
|
@@ -89,6 +89,13 @@ import type * as Payabli from "../../../index.mjs";
|
|
|
89
89
|
* customField2: "",
|
|
90
90
|
* customerVendorAccount: "123-456",
|
|
91
91
|
* InternalReferenceId: 1000000,
|
|
92
|
+
* PaymentPortalUrl: "https://greenfield-landscaping.com/pay",
|
|
93
|
+
* CardAccepted: "yes",
|
|
94
|
+
* AchAccepted: "unable to determine",
|
|
95
|
+
* EnrichmentStatus: "fully_enriched",
|
|
96
|
+
* EnrichedBy: "web_search",
|
|
97
|
+
* EnrichedAt: "2026-03-05T14:22:10Z",
|
|
98
|
+
* EnrichmentId: "enrich-3890-a1b2c3d4",
|
|
92
99
|
* externalPaypointID: "Paypoint-100",
|
|
93
100
|
* StoredMethods: []
|
|
94
101
|
* },
|
package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.mts
CHANGED
|
@@ -89,6 +89,13 @@ import type * as Payabli from "../../../index.mjs";
|
|
|
89
89
|
* customField2: "",
|
|
90
90
|
* customerVendorAccount: "123-456",
|
|
91
91
|
* InternalReferenceId: 1000000,
|
|
92
|
+
* PaymentPortalUrl: "https://greenfield-landscaping.com/pay",
|
|
93
|
+
* CardAccepted: "yes",
|
|
94
|
+
* AchAccepted: "unable to determine",
|
|
95
|
+
* EnrichmentStatus: "fully_enriched",
|
|
96
|
+
* EnrichedBy: "web_search",
|
|
97
|
+
* EnrichedAt: "2026-03-05T14:22:10Z",
|
|
98
|
+
* EnrichmentId: "enrich-3890-a1b2c3d4",
|
|
92
99
|
* externalPaypointID: "Paypoint-100",
|
|
93
100
|
* StoredMethods: []
|
|
94
101
|
* },
|
package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.mts
CHANGED
|
@@ -100,6 +100,13 @@ import type * as Payabli from "../../../index.mjs";
|
|
|
100
100
|
* customField2: "",
|
|
101
101
|
* customerVendorAccount: "123-456",
|
|
102
102
|
* InternalReferenceId: 1000000,
|
|
103
|
+
* PaymentPortalUrl: "https://greenfield-landscaping.com/pay",
|
|
104
|
+
* CardAccepted: "yes",
|
|
105
|
+
* AchAccepted: "unable to determine",
|
|
106
|
+
* EnrichmentStatus: "fully_enriched",
|
|
107
|
+
* EnrichedBy: "web_search",
|
|
108
|
+
* EnrichedAt: "2026-03-05T14:22:10Z",
|
|
109
|
+
* EnrichmentId: "enrich-3890-a1b2c3d4",
|
|
103
110
|
* externalPaypointID: "Paypoint-100",
|
|
104
111
|
* StoredMethods: []
|
|
105
112
|
* },
|
|
@@ -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
|
+
}
|