@payabli/sdk-node 0.0.116 → 0.0.117
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 +24 -7
- package/dist/cjs/BaseClient.d.ts +10 -1
- package/dist/cjs/BaseClient.js +57 -0
- package/dist/cjs/Client.d.ts +87 -86
- package/dist/cjs/Client.js +31 -72
- package/dist/cjs/api/resources/bill/client/Client.d.ts +33 -33
- package/dist/cjs/api/resources/bill/client/Client.js +69 -216
- package/dist/cjs/api/resources/boarding/client/Client.d.ts +27 -27
- package/dist/cjs/api/resources/boarding/client/Client.js +51 -198
- package/dist/cjs/api/resources/chargeBacks/client/Client.d.ts +17 -15
- package/dist/cjs/api/resources/chargeBacks/client/Client.js +38 -79
- package/dist/cjs/api/resources/checkCapture/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/checkCapture/client/Client.js +11 -28
- package/dist/cjs/api/resources/cloud/client/Client.d.ts +17 -17
- package/dist/cjs/api/resources/cloud/client/Client.js +33 -89
- package/dist/cjs/api/resources/customer/client/Client.d.ts +17 -17
- package/dist/cjs/api/resources/customer/client/Client.js +31 -113
- package/dist/cjs/api/resources/export/client/Client.d.ts +93 -89
- package/dist/cjs/api/resources/export/client/Client.js +205 -582
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.js +19 -62
- package/dist/cjs/api/resources/import/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/import/client/Client.js +19 -62
- package/dist/cjs/api/resources/invoice/client/Client.d.ts +31 -31
- package/dist/cjs/api/resources/invoice/client/Client.js +62 -209
- package/dist/cjs/api/resources/lineItem/client/Client.d.ts +15 -15
- package/dist/cjs/api/resources/lineItem/client/Client.js +27 -96
- package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +39 -39
- package/dist/cjs/api/resources/moneyIn/client/Client.js +79 -249
- package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +43 -26
- package/dist/cjs/api/resources/moneyOut/client/Client.js +105 -168
- package/dist/cjs/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.ts +2 -1
- package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.ts +3 -1
- package/dist/cjs/api/resources/notification/client/Client.d.ts +16 -16
- package/dist/cjs/api/resources/notification/client/Client.js +32 -101
- package/dist/cjs/api/resources/notificationlogs/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/notificationlogs/client/Client.js +23 -79
- package/dist/cjs/api/resources/ocr/client/Client.d.ts +13 -9
- package/dist/cjs/api/resources/ocr/client/Client.js +19 -45
- package/dist/cjs/api/resources/organization/client/Client.d.ts +19 -19
- package/dist/cjs/api/resources/organization/client/Client.js +35 -130
- package/dist/cjs/api/resources/paymentLink/client/Client.d.ts +23 -23
- package/dist/cjs/api/resources/paymentLink/client/Client.js +43 -164
- package/dist/cjs/api/resources/paymentMethodDomain/client/Client.d.ts +19 -19
- package/dist/cjs/api/resources/paymentMethodDomain/client/Client.js +35 -130
- package/dist/cjs/api/resources/paypoint/client/Client.d.ts +22 -22
- package/dist/cjs/api/resources/paypoint/client/Client.js +44 -152
- package/dist/cjs/api/resources/query/client/Client.d.ts +71 -71
- package/dist/cjs/api/resources/query/client/Client.js +137 -572
- package/dist/cjs/api/resources/query/client/requests/ListPayoutOrgRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransactionsRequest.d.ts +1 -0
- package/dist/cjs/api/resources/statistic/client/Client.d.ts +50 -50
- package/dist/cjs/api/resources/statistic/client/Client.js +80 -133
- package/dist/cjs/api/resources/statistic/client/requests/BasicStatsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/statistic/types/StatBasicExtendedQueryRecord.d.ts +76 -0
- package/dist/cjs/api/resources/statistic/types/StatBasicExtendedQueryRecord.js +3 -0
- package/dist/cjs/api/resources/statistic/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/statistic/types/index.js +1 -0
- package/dist/cjs/api/resources/subscription/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/subscription/client/Client.js +23 -79
- package/dist/cjs/api/resources/templates/client/Client.d.ts +15 -15
- package/dist/cjs/api/resources/templates/client/Client.js +28 -84
- package/dist/cjs/api/resources/tokenStorage/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/tokenStorage/client/Client.js +23 -79
- package/dist/cjs/api/resources/user/client/Client.d.ts +54 -32
- package/dist/cjs/api/resources/user/client/Client.js +84 -222
- package/dist/cjs/api/resources/vendor/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/vendor/client/Client.js +23 -79
- package/dist/cjs/api/resources/wallet/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/wallet/client/Client.js +23 -79
- package/dist/cjs/api/types/ApplicationDetailsRecord.d.ts +2 -2
- package/dist/cjs/api/types/NotificationContent.d.ts +1 -0
- package/dist/cjs/api/types/NotificationContent.js +1 -0
- package/dist/cjs/api/types/NotificationStandardRequest.d.ts +1 -0
- package/dist/cjs/api/types/NotificationStandardRequest.js +1 -0
- package/dist/cjs/api/types/QueryResponseSettlements.d.ts +1 -1
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +14 -0
- package/dist/cjs/auth/HeaderAuthProvider.js +71 -0
- package/dist/cjs/auth/index.d.ts +1 -0
- package/dist/cjs/auth/index.js +5 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +7 -0
- package/dist/cjs/{version.js → core/auth/AuthProvider.js} +0 -2
- package/dist/cjs/core/auth/AuthRequest.d.ts +9 -0
- package/dist/cjs/core/auth/AuthRequest.js +2 -0
- package/dist/cjs/core/auth/BasicAuth.d.ts +8 -0
- package/dist/cjs/core/auth/BasicAuth.js +27 -0
- package/dist/cjs/core/auth/BearerToken.d.ts +7 -0
- package/dist/cjs/core/auth/BearerToken.js +16 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
- package/dist/cjs/core/auth/index.d.ts +5 -0
- package/dist/cjs/core/auth/index.js +9 -0
- package/dist/cjs/core/base64.d.ts +2 -0
- package/dist/cjs/core/base64.js +26 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +6 -7
- package/dist/cjs/core/fetcher/Fetcher.d.ts +5 -1
- package/dist/cjs/core/fetcher/Fetcher.js +42 -24
- package/dist/cjs/core/fetcher/getResponseBody.js +18 -4
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
- package/dist/cjs/core/fetcher/makeRequest.js +0 -2
- package/dist/cjs/core/fetcher/requestWithRetries.js +0 -9
- package/dist/cjs/core/fetcher/signals.d.ts +1 -7
- package/dist/cjs/core/fetcher/signals.js +0 -12
- package/dist/cjs/core/index.d.ts +2 -0
- package/dist/cjs/core/index.js +2 -0
- package/dist/cjs/core/logging/logger.js +1 -1
- package/dist/cjs/core/runtime/runtime.js +11 -10
- package/dist/cjs/core/url/join.js +0 -1
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +65 -0
- package/dist/esm/BaseClient.d.mts +10 -1
- package/dist/esm/BaseClient.mjs +22 -1
- package/dist/esm/Client.d.mts +87 -86
- package/dist/esm/Client.mjs +59 -67
- package/dist/esm/api/resources/bill/client/Client.d.mts +33 -33
- package/dist/esm/api/resources/bill/client/Client.mjs +67 -214
- package/dist/esm/api/resources/boarding/client/Client.d.mts +27 -27
- package/dist/esm/api/resources/boarding/client/Client.mjs +50 -197
- package/dist/esm/api/resources/chargeBacks/client/Client.d.mts +17 -15
- package/dist/esm/api/resources/chargeBacks/client/Client.mjs +36 -77
- package/dist/esm/api/resources/checkCapture/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/checkCapture/client/Client.mjs +10 -27
- package/dist/esm/api/resources/cloud/client/Client.d.mts +17 -17
- package/dist/esm/api/resources/cloud/client/Client.mjs +31 -87
- package/dist/esm/api/resources/customer/client/Client.d.mts +17 -17
- package/dist/esm/api/resources/customer/client/Client.mjs +29 -111
- package/dist/esm/api/resources/export/client/Client.d.mts +93 -89
- package/dist/esm/api/resources/export/client/Client.mjs +204 -581
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.mjs +17 -60
- package/dist/esm/api/resources/import/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/import/client/Client.mjs +17 -60
- package/dist/esm/api/resources/invoice/client/Client.d.mts +31 -31
- package/dist/esm/api/resources/invoice/client/Client.mjs +60 -207
- package/dist/esm/api/resources/lineItem/client/Client.d.mts +15 -15
- package/dist/esm/api/resources/lineItem/client/Client.mjs +25 -94
- package/dist/esm/api/resources/moneyIn/client/Client.d.mts +39 -39
- package/dist/esm/api/resources/moneyIn/client/Client.mjs +77 -247
- package/dist/esm/api/resources/moneyOut/client/Client.d.mts +43 -26
- package/dist/esm/api/resources/moneyOut/client/Client.mjs +103 -166
- package/dist/esm/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.mts +2 -1
- package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.mts +3 -1
- package/dist/esm/api/resources/notification/client/Client.d.mts +16 -16
- package/dist/esm/api/resources/notification/client/Client.mjs +31 -100
- package/dist/esm/api/resources/notificationlogs/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/notificationlogs/client/Client.mjs +22 -78
- package/dist/esm/api/resources/ocr/client/Client.d.mts +13 -9
- package/dist/esm/api/resources/ocr/client/Client.mjs +18 -44
- package/dist/esm/api/resources/organization/client/Client.d.mts +19 -19
- package/dist/esm/api/resources/organization/client/Client.mjs +33 -128
- package/dist/esm/api/resources/paymentLink/client/Client.d.mts +23 -23
- package/dist/esm/api/resources/paymentLink/client/Client.mjs +41 -162
- package/dist/esm/api/resources/paymentMethodDomain/client/Client.d.mts +19 -19
- package/dist/esm/api/resources/paymentMethodDomain/client/Client.mjs +34 -129
- package/dist/esm/api/resources/paypoint/client/Client.d.mts +22 -22
- package/dist/esm/api/resources/paypoint/client/Client.mjs +43 -151
- package/dist/esm/api/resources/query/client/Client.d.mts +71 -71
- package/dist/esm/api/resources/query/client/Client.mjs +136 -571
- package/dist/esm/api/resources/query/client/requests/ListPayoutOrgRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListTransactionsRequest.d.mts +1 -0
- package/dist/esm/api/resources/statistic/client/Client.d.mts +50 -50
- package/dist/esm/api/resources/statistic/client/Client.mjs +79 -132
- package/dist/esm/api/resources/statistic/client/requests/BasicStatsRequest.d.mts +2 -2
- package/dist/esm/api/resources/statistic/types/StatBasicExtendedQueryRecord.d.mts +76 -0
- package/dist/esm/api/resources/statistic/types/StatBasicExtendedQueryRecord.mjs +2 -0
- package/dist/esm/api/resources/statistic/types/index.d.mts +1 -0
- package/dist/esm/api/resources/statistic/types/index.mjs +1 -0
- package/dist/esm/api/resources/subscription/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/subscription/client/Client.mjs +21 -77
- package/dist/esm/api/resources/templates/client/Client.d.mts +15 -15
- package/dist/esm/api/resources/templates/client/Client.mjs +27 -83
- package/dist/esm/api/resources/tokenStorage/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/tokenStorage/client/Client.mjs +21 -77
- package/dist/esm/api/resources/user/client/Client.d.mts +54 -32
- package/dist/esm/api/resources/user/client/Client.mjs +83 -221
- package/dist/esm/api/resources/vendor/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/vendor/client/Client.mjs +22 -78
- package/dist/esm/api/resources/wallet/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/wallet/client/Client.mjs +22 -78
- package/dist/esm/api/types/ApplicationDetailsRecord.d.mts +2 -2
- package/dist/esm/api/types/NotificationContent.d.mts +1 -0
- package/dist/esm/api/types/NotificationContent.mjs +1 -0
- package/dist/esm/api/types/NotificationStandardRequest.d.mts +1 -0
- package/dist/esm/api/types/NotificationStandardRequest.mjs +1 -0
- package/dist/esm/api/types/QueryResponseSettlements.d.mts +1 -1
- package/dist/esm/auth/HeaderAuthProvider.d.mts +14 -0
- package/dist/esm/auth/HeaderAuthProvider.mjs +34 -0
- package/dist/esm/auth/index.d.mts +1 -0
- package/dist/esm/auth/index.mjs +1 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +7 -0
- package/dist/esm/core/auth/AuthProvider.mjs +1 -0
- package/dist/esm/core/auth/AuthRequest.d.mts +9 -0
- package/dist/esm/core/auth/AuthRequest.mjs +1 -0
- package/dist/esm/core/auth/BasicAuth.d.mts +8 -0
- package/dist/esm/core/auth/BasicAuth.mjs +24 -0
- package/dist/esm/core/auth/BearerToken.d.mts +7 -0
- package/dist/esm/core/auth/BearerToken.mjs +13 -0
- package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
- package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
- package/dist/esm/core/auth/index.d.mts +5 -0
- package/dist/esm/core/auth/index.mjs +3 -0
- package/dist/esm/core/base64.d.mts +2 -0
- package/dist/esm/core/base64.mjs +22 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +6 -7
- package/dist/esm/core/fetcher/Fetcher.d.mts +5 -1
- package/dist/esm/core/fetcher/Fetcher.mjs +42 -24
- package/dist/esm/core/fetcher/getResponseBody.mjs +18 -4
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +0 -2
- package/dist/esm/core/fetcher/requestWithRetries.mjs +0 -9
- package/dist/esm/core/fetcher/signals.d.mts +1 -7
- package/dist/esm/core/fetcher/signals.mjs +0 -12
- package/dist/esm/core/index.d.mts +2 -0
- package/dist/esm/core/index.mjs +2 -0
- package/dist/esm/core/logging/logger.mjs +1 -1
- package/dist/esm/core/runtime/runtime.mjs +11 -10
- package/dist/esm/core/url/join.mjs +0 -1
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +29 -0
- package/package.json +4 -4
- package/reference.md +761 -473
- package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
- package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
- package/dist/cjs/version.d.ts +0 -1
- package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
- package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
- package/dist/esm/version.d.mts +0 -1
- package/dist/esm/version.mjs +0 -1
package/reference.md
CHANGED
|
@@ -95,7 +95,7 @@ await client.bill.addBill("8cfec329267", {
|
|
|
95
95
|
<dl>
|
|
96
96
|
<dd>
|
|
97
97
|
|
|
98
|
-
**requestOptions:** `
|
|
98
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
99
99
|
|
|
100
100
|
</dd>
|
|
101
101
|
</dl>
|
|
@@ -107,7 +107,7 @@ await client.bill.addBill("8cfec329267", {
|
|
|
107
107
|
</dl>
|
|
108
108
|
</details>
|
|
109
109
|
|
|
110
|
-
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">deleteAttachedFromBill</a>(
|
|
110
|
+
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">deleteAttachedFromBill</a>(idBill, filename, { ...params }) -> Payabli.BillResponse</code></summary>
|
|
111
111
|
<dl>
|
|
112
112
|
<dd>
|
|
113
113
|
|
|
@@ -134,7 +134,7 @@ Delete a file attached to a bill.
|
|
|
134
134
|
<dd>
|
|
135
135
|
|
|
136
136
|
```typescript
|
|
137
|
-
await client.bill.deleteAttachedFromBill("0_Bill.pdf"
|
|
137
|
+
await client.bill.deleteAttachedFromBill(285, "0_Bill.pdf");
|
|
138
138
|
|
|
139
139
|
```
|
|
140
140
|
</dd>
|
|
@@ -150,6 +150,14 @@ await client.bill.deleteAttachedFromBill("0_Bill.pdf", 285);
|
|
|
150
150
|
<dl>
|
|
151
151
|
<dd>
|
|
152
152
|
|
|
153
|
+
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
154
|
+
|
|
155
|
+
</dd>
|
|
156
|
+
</dl>
|
|
157
|
+
|
|
158
|
+
<dl>
|
|
159
|
+
<dd>
|
|
160
|
+
|
|
153
161
|
**filename:** `string`
|
|
154
162
|
|
|
155
163
|
The filename in Payabli. Filename is `zipName` in response to a
|
|
@@ -175,14 +183,6 @@ request to `/api/Invoice/{idInvoice}`. Here, the filename is
|
|
|
175
183
|
<dl>
|
|
176
184
|
<dd>
|
|
177
185
|
|
|
178
|
-
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
179
|
-
|
|
180
|
-
</dd>
|
|
181
|
-
</dl>
|
|
182
|
-
|
|
183
|
-
<dl>
|
|
184
|
-
<dd>
|
|
185
|
-
|
|
186
186
|
**request:** `Payabli.DeleteAttachedFromBillRequest`
|
|
187
187
|
|
|
188
188
|
</dd>
|
|
@@ -191,7 +191,7 @@ request to `/api/Invoice/{idInvoice}`. Here, the filename is
|
|
|
191
191
|
<dl>
|
|
192
192
|
<dd>
|
|
193
193
|
|
|
194
|
-
**requestOptions:** `
|
|
194
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
195
195
|
|
|
196
196
|
</dd>
|
|
197
197
|
</dl>
|
|
@@ -254,7 +254,7 @@ await client.bill.deleteBill(285);
|
|
|
254
254
|
<dl>
|
|
255
255
|
<dd>
|
|
256
256
|
|
|
257
|
-
**requestOptions:** `
|
|
257
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
258
258
|
|
|
259
259
|
</dd>
|
|
260
260
|
</dl>
|
|
@@ -328,7 +328,7 @@ await client.bill.editBill(285, {
|
|
|
328
328
|
<dl>
|
|
329
329
|
<dd>
|
|
330
330
|
|
|
331
|
-
**requestOptions:** `
|
|
331
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
332
332
|
|
|
333
333
|
</dd>
|
|
334
334
|
</dl>
|
|
@@ -340,7 +340,7 @@ await client.bill.editBill(285, {
|
|
|
340
340
|
</dl>
|
|
341
341
|
</details>
|
|
342
342
|
|
|
343
|
-
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">getAttachedFromBill</a>(
|
|
343
|
+
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">getAttachedFromBill</a>(idBill, filename, { ...params }) -> Payabli.FileContent</code></summary>
|
|
344
344
|
<dl>
|
|
345
345
|
<dd>
|
|
346
346
|
|
|
@@ -367,7 +367,7 @@ Retrieves a file attached to a bill, either as a binary file or as a Base64-enco
|
|
|
367
367
|
<dd>
|
|
368
368
|
|
|
369
369
|
```typescript
|
|
370
|
-
await client.bill.getAttachedFromBill("0_Bill.pdf",
|
|
370
|
+
await client.bill.getAttachedFromBill(285, "0_Bill.pdf", {
|
|
371
371
|
returnObject: true
|
|
372
372
|
});
|
|
373
373
|
|
|
@@ -385,6 +385,14 @@ await client.bill.getAttachedFromBill("0_Bill.pdf", 285, {
|
|
|
385
385
|
<dl>
|
|
386
386
|
<dd>
|
|
387
387
|
|
|
388
|
+
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
389
|
+
|
|
390
|
+
</dd>
|
|
391
|
+
</dl>
|
|
392
|
+
|
|
393
|
+
<dl>
|
|
394
|
+
<dd>
|
|
395
|
+
|
|
388
396
|
**filename:** `string`
|
|
389
397
|
|
|
390
398
|
The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
|
|
@@ -405,14 +413,6 @@ The filename in Payabli. Filename is `zipName` in response to a request to `/api
|
|
|
405
413
|
<dl>
|
|
406
414
|
<dd>
|
|
407
415
|
|
|
408
|
-
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
409
|
-
|
|
410
|
-
</dd>
|
|
411
|
-
</dl>
|
|
412
|
-
|
|
413
|
-
<dl>
|
|
414
|
-
<dd>
|
|
415
|
-
|
|
416
416
|
**request:** `Payabli.GetAttachedFromBillRequest`
|
|
417
417
|
|
|
418
418
|
</dd>
|
|
@@ -421,7 +421,7 @@ The filename in Payabli. Filename is `zipName` in response to a request to `/api
|
|
|
421
421
|
<dl>
|
|
422
422
|
<dd>
|
|
423
423
|
|
|
424
|
-
**requestOptions:** `
|
|
424
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
425
425
|
|
|
426
426
|
</dd>
|
|
427
427
|
</dl>
|
|
@@ -484,7 +484,7 @@ await client.bill.getBill(285);
|
|
|
484
484
|
<dl>
|
|
485
485
|
<dd>
|
|
486
486
|
|
|
487
|
-
**requestOptions:** `
|
|
487
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
488
488
|
|
|
489
489
|
</dd>
|
|
490
490
|
</dl>
|
|
@@ -559,7 +559,7 @@ await client.bill.listBills("8cfec329267", {
|
|
|
559
559
|
<dl>
|
|
560
560
|
<dd>
|
|
561
561
|
|
|
562
|
-
**requestOptions:** `
|
|
562
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
563
563
|
|
|
564
564
|
</dd>
|
|
565
565
|
</dl>
|
|
@@ -634,7 +634,7 @@ await client.bill.listBillsOrg(123, {
|
|
|
634
634
|
<dl>
|
|
635
635
|
<dd>
|
|
636
636
|
|
|
637
|
-
**requestOptions:** `
|
|
637
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
638
638
|
|
|
639
639
|
</dd>
|
|
640
640
|
</dl>
|
|
@@ -705,7 +705,7 @@ await client.bill.modifyApprovalBill(285, ["string"]);
|
|
|
705
705
|
<dl>
|
|
706
706
|
<dd>
|
|
707
707
|
|
|
708
|
-
**requestOptions:** `
|
|
708
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
709
709
|
|
|
710
710
|
</dd>
|
|
711
711
|
</dl>
|
|
@@ -779,7 +779,7 @@ await client.bill.sendToApprovalBill(285, {
|
|
|
779
779
|
<dl>
|
|
780
780
|
<dd>
|
|
781
781
|
|
|
782
|
-
**requestOptions:** `
|
|
782
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
783
783
|
|
|
784
784
|
</dd>
|
|
785
785
|
</dl>
|
|
@@ -791,7 +791,7 @@ await client.bill.sendToApprovalBill(285, {
|
|
|
791
791
|
</dl>
|
|
792
792
|
</details>
|
|
793
793
|
|
|
794
|
-
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">setApprovedBill</a>(
|
|
794
|
+
<details><summary><code>client.bill.<a href="/src/api/resources/bill/client/Client.ts">setApprovedBill</a>(idBill, approved, { ...params }) -> Payabli.SetApprovedBillResponse</code></summary>
|
|
795
795
|
<dl>
|
|
796
796
|
<dd>
|
|
797
797
|
|
|
@@ -818,7 +818,7 @@ Approve or disapprove a bill by ID.
|
|
|
818
818
|
<dd>
|
|
819
819
|
|
|
820
820
|
```typescript
|
|
821
|
-
await client.bill.setApprovedBill("true"
|
|
821
|
+
await client.bill.setApprovedBill(285, "true");
|
|
822
822
|
|
|
823
823
|
```
|
|
824
824
|
</dd>
|
|
@@ -834,7 +834,7 @@ await client.bill.setApprovedBill("true", 285);
|
|
|
834
834
|
<dl>
|
|
835
835
|
<dd>
|
|
836
836
|
|
|
837
|
-
**
|
|
837
|
+
**idBill:** `number` — Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
|
|
838
838
|
|
|
839
839
|
</dd>
|
|
840
840
|
</dl>
|
|
@@ -842,7 +842,7 @@ await client.bill.setApprovedBill("true", 285);
|
|
|
842
842
|
<dl>
|
|
843
843
|
<dd>
|
|
844
844
|
|
|
845
|
-
**
|
|
845
|
+
**approved:** `string` — String representing the approved status. Accepted values: 'true' or 'false'.
|
|
846
846
|
|
|
847
847
|
</dd>
|
|
848
848
|
</dl>
|
|
@@ -858,7 +858,7 @@ await client.bill.setApprovedBill("true", 285);
|
|
|
858
858
|
<dl>
|
|
859
859
|
<dd>
|
|
860
860
|
|
|
861
|
-
**requestOptions:** `
|
|
861
|
+
**requestOptions:** `BillClient.RequestOptions`
|
|
862
862
|
|
|
863
863
|
</dd>
|
|
864
864
|
</dl>
|
|
@@ -1019,7 +1019,7 @@ await client.boarding.addApplication({
|
|
|
1019
1019
|
<dl>
|
|
1020
1020
|
<dd>
|
|
1021
1021
|
|
|
1022
|
-
**requestOptions:** `
|
|
1022
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1023
1023
|
|
|
1024
1024
|
</dd>
|
|
1025
1025
|
</dl>
|
|
@@ -1082,7 +1082,7 @@ await client.boarding.deleteApplication(352);
|
|
|
1082
1082
|
<dl>
|
|
1083
1083
|
<dd>
|
|
1084
1084
|
|
|
1085
|
-
**requestOptions:** `
|
|
1085
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1086
1086
|
|
|
1087
1087
|
</dd>
|
|
1088
1088
|
</dl>
|
|
@@ -1145,7 +1145,7 @@ await client.boarding.getApplication(352);
|
|
|
1145
1145
|
<dl>
|
|
1146
1146
|
<dd>
|
|
1147
1147
|
|
|
1148
|
-
**requestOptions:** `
|
|
1148
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1149
1149
|
|
|
1150
1150
|
</dd>
|
|
1151
1151
|
</dl>
|
|
@@ -1219,7 +1219,7 @@ await client.boarding.getApplicationByAuth("17E", {
|
|
|
1219
1219
|
<dl>
|
|
1220
1220
|
<dd>
|
|
1221
1221
|
|
|
1222
|
-
**requestOptions:** `
|
|
1222
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1223
1223
|
|
|
1224
1224
|
</dd>
|
|
1225
1225
|
</dl>
|
|
@@ -1282,7 +1282,7 @@ await client.boarding.getByIdLinkApplication(91);
|
|
|
1282
1282
|
<dl>
|
|
1283
1283
|
<dd>
|
|
1284
1284
|
|
|
1285
|
-
**requestOptions:** `
|
|
1285
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1286
1286
|
|
|
1287
1287
|
</dd>
|
|
1288
1288
|
</dl>
|
|
@@ -1345,7 +1345,7 @@ await client.boarding.getByTemplateIdLinkApplication(80);
|
|
|
1345
1345
|
<dl>
|
|
1346
1346
|
<dd>
|
|
1347
1347
|
|
|
1348
|
-
**requestOptions:** `
|
|
1348
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1349
1349
|
|
|
1350
1350
|
</dd>
|
|
1351
1351
|
</dl>
|
|
@@ -1424,7 +1424,7 @@ await client.boarding.getExternalApplication(352, "mail2");
|
|
|
1424
1424
|
<dl>
|
|
1425
1425
|
<dd>
|
|
1426
1426
|
|
|
1427
|
-
**requestOptions:** `
|
|
1427
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1428
1428
|
|
|
1429
1429
|
</dd>
|
|
1430
1430
|
</dl>
|
|
@@ -1487,7 +1487,7 @@ await client.boarding.getLinkApplication("myorgaccountname-00091");
|
|
|
1487
1487
|
<dl>
|
|
1488
1488
|
<dd>
|
|
1489
1489
|
|
|
1490
|
-
**requestOptions:** `
|
|
1490
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1491
1491
|
|
|
1492
1492
|
</dd>
|
|
1493
1493
|
</dl>
|
|
@@ -1562,7 +1562,7 @@ await client.boarding.listApplications(123, {
|
|
|
1562
1562
|
<dl>
|
|
1563
1563
|
<dd>
|
|
1564
1564
|
|
|
1565
|
-
**requestOptions:** `
|
|
1565
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1566
1566
|
|
|
1567
1567
|
</dd>
|
|
1568
1568
|
</dl>
|
|
@@ -1637,7 +1637,7 @@ await client.boarding.listBoardingLinks(123, {
|
|
|
1637
1637
|
<dl>
|
|
1638
1638
|
<dd>
|
|
1639
1639
|
|
|
1640
|
-
**requestOptions:** `
|
|
1640
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1641
1641
|
|
|
1642
1642
|
</dd>
|
|
1643
1643
|
</dl>
|
|
@@ -1708,7 +1708,7 @@ await client.boarding.updateApplication(352, {});
|
|
|
1708
1708
|
<dl>
|
|
1709
1709
|
<dd>
|
|
1710
1710
|
|
|
1711
|
-
**requestOptions:** `
|
|
1711
|
+
**requestOptions:** `BoardingClient.RequestOptions`
|
|
1712
1712
|
|
|
1713
1713
|
</dd>
|
|
1714
1714
|
</dl>
|
|
@@ -1721,7 +1721,7 @@ await client.boarding.updateApplication(352, {});
|
|
|
1721
1721
|
</details>
|
|
1722
1722
|
|
|
1723
1723
|
## ChargeBacks
|
|
1724
|
-
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">addResponse</a>(
|
|
1724
|
+
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">addResponse</a>(Id, { ...params }) -> Payabli.AddResponseResponse</code></summary>
|
|
1725
1725
|
<dl>
|
|
1726
1726
|
<dd>
|
|
1727
1727
|
|
|
@@ -1766,7 +1766,7 @@ await client.chargeBacks.addResponse(1000000, {
|
|
|
1766
1766
|
<dl>
|
|
1767
1767
|
<dd>
|
|
1768
1768
|
|
|
1769
|
-
**
|
|
1769
|
+
**Id:** `number` — ID of the chargeback or return record.
|
|
1770
1770
|
|
|
1771
1771
|
</dd>
|
|
1772
1772
|
</dl>
|
|
@@ -1782,7 +1782,7 @@ await client.chargeBacks.addResponse(1000000, {
|
|
|
1782
1782
|
<dl>
|
|
1783
1783
|
<dd>
|
|
1784
1784
|
|
|
1785
|
-
**requestOptions:** `
|
|
1785
|
+
**requestOptions:** `ChargeBacksClient.RequestOptions`
|
|
1786
1786
|
|
|
1787
1787
|
</dd>
|
|
1788
1788
|
</dl>
|
|
@@ -1794,7 +1794,7 @@ await client.chargeBacks.addResponse(1000000, {
|
|
|
1794
1794
|
</dl>
|
|
1795
1795
|
</details>
|
|
1796
1796
|
|
|
1797
|
-
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">getChargeback</a>(
|
|
1797
|
+
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">getChargeback</a>(Id) -> Payabli.ChargebackQueryRecords</code></summary>
|
|
1798
1798
|
<dl>
|
|
1799
1799
|
<dd>
|
|
1800
1800
|
|
|
@@ -1837,7 +1837,7 @@ await client.chargeBacks.getChargeback(1000000);
|
|
|
1837
1837
|
<dl>
|
|
1838
1838
|
<dd>
|
|
1839
1839
|
|
|
1840
|
-
**
|
|
1840
|
+
**Id:** `number` — ID of the chargeback or return record. This is returned as `chargebackId` in the [RecievedChargeback](/developers/developer-guides/webhook-payloads#receivedChargeback) and [ReceivedAchReturn](/developers/developer-guides/webhook-payloads#receivedachreturn) webhook notifications.
|
|
1841
1841
|
|
|
1842
1842
|
</dd>
|
|
1843
1843
|
</dl>
|
|
@@ -1845,7 +1845,7 @@ await client.chargeBacks.getChargeback(1000000);
|
|
|
1845
1845
|
<dl>
|
|
1846
1846
|
<dd>
|
|
1847
1847
|
|
|
1848
|
-
**requestOptions:** `
|
|
1848
|
+
**requestOptions:** `ChargeBacksClient.RequestOptions`
|
|
1849
1849
|
|
|
1850
1850
|
</dd>
|
|
1851
1851
|
</dl>
|
|
@@ -1857,10 +1857,24 @@ await client.chargeBacks.getChargeback(1000000);
|
|
|
1857
1857
|
</dl>
|
|
1858
1858
|
</details>
|
|
1859
1859
|
|
|
1860
|
-
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">getChargebackAttachment</a>(
|
|
1860
|
+
<details><summary><code>client.chargeBacks.<a href="/src/api/resources/chargeBacks/client/Client.ts">getChargebackAttachment</a>(Id, fileName) -> string</code></summary>
|
|
1861
|
+
<dl>
|
|
1862
|
+
<dd>
|
|
1863
|
+
|
|
1864
|
+
#### 📝 Description
|
|
1865
|
+
|
|
1866
|
+
<dl>
|
|
1867
|
+
<dd>
|
|
1868
|
+
|
|
1861
1869
|
<dl>
|
|
1862
1870
|
<dd>
|
|
1863
1871
|
|
|
1872
|
+
Retrieves a chargeback attachment file by its file name.
|
|
1873
|
+
</dd>
|
|
1874
|
+
</dl>
|
|
1875
|
+
</dd>
|
|
1876
|
+
</dl>
|
|
1877
|
+
|
|
1864
1878
|
#### 🔌 Usage
|
|
1865
1879
|
|
|
1866
1880
|
<dl>
|
|
@@ -1870,7 +1884,7 @@ await client.chargeBacks.getChargeback(1000000);
|
|
|
1870
1884
|
<dd>
|
|
1871
1885
|
|
|
1872
1886
|
```typescript
|
|
1873
|
-
await client.chargeBacks.getChargebackAttachment("fileName"
|
|
1887
|
+
await client.chargeBacks.getChargebackAttachment(1000000, "fileName");
|
|
1874
1888
|
|
|
1875
1889
|
```
|
|
1876
1890
|
</dd>
|
|
@@ -1886,7 +1900,7 @@ await client.chargeBacks.getChargebackAttachment("fileName", 1000000);
|
|
|
1886
1900
|
<dl>
|
|
1887
1901
|
<dd>
|
|
1888
1902
|
|
|
1889
|
-
**
|
|
1903
|
+
**Id:** `number` — The ID of chargeback or return record.
|
|
1890
1904
|
|
|
1891
1905
|
</dd>
|
|
1892
1906
|
</dl>
|
|
@@ -1894,7 +1908,7 @@ await client.chargeBacks.getChargebackAttachment("fileName", 1000000);
|
|
|
1894
1908
|
<dl>
|
|
1895
1909
|
<dd>
|
|
1896
1910
|
|
|
1897
|
-
**
|
|
1911
|
+
**fileName:** `string` — The chargeback attachment's file name.
|
|
1898
1912
|
|
|
1899
1913
|
</dd>
|
|
1900
1914
|
</dl>
|
|
@@ -1902,7 +1916,7 @@ await client.chargeBacks.getChargebackAttachment("fileName", 1000000);
|
|
|
1902
1916
|
<dl>
|
|
1903
1917
|
<dd>
|
|
1904
1918
|
|
|
1905
|
-
**requestOptions:** `
|
|
1919
|
+
**requestOptions:** `ChargeBacksClient.RequestOptions`
|
|
1906
1920
|
|
|
1907
1921
|
</dd>
|
|
1908
1922
|
</dl>
|
|
@@ -1971,7 +1985,7 @@ await client.checkCapture.checkProcessing({
|
|
|
1971
1985
|
<dl>
|
|
1972
1986
|
<dd>
|
|
1973
1987
|
|
|
1974
|
-
**requestOptions:** `
|
|
1988
|
+
**requestOptions:** `CheckCaptureClient.RequestOptions`
|
|
1975
1989
|
|
|
1976
1990
|
</dd>
|
|
1977
1991
|
</dl>
|
|
@@ -2046,7 +2060,7 @@ await client.cloud.addDevice("8cfec329267", {
|
|
|
2046
2060
|
<dl>
|
|
2047
2061
|
<dd>
|
|
2048
2062
|
|
|
2049
|
-
**requestOptions:** `
|
|
2063
|
+
**requestOptions:** `CloudClient.RequestOptions`
|
|
2050
2064
|
|
|
2051
2065
|
</dd>
|
|
2052
2066
|
</dl>
|
|
@@ -2058,7 +2072,7 @@ await client.cloud.addDevice("8cfec329267", {
|
|
|
2058
2072
|
</dl>
|
|
2059
2073
|
</details>
|
|
2060
2074
|
|
|
2061
|
-
<details><summary><code>client.cloud.<a href="/src/api/resources/cloud/client/Client.ts">historyDevice</a>(
|
|
2075
|
+
<details><summary><code>client.cloud.<a href="/src/api/resources/cloud/client/Client.ts">historyDevice</a>(entry, deviceId) -> Payabli.CloudQueryApiResponse</code></summary>
|
|
2062
2076
|
<dl>
|
|
2063
2077
|
<dd>
|
|
2064
2078
|
|
|
@@ -2085,7 +2099,7 @@ Retrieve the registration history for a device.
|
|
|
2085
2099
|
<dd>
|
|
2086
2100
|
|
|
2087
2101
|
```typescript
|
|
2088
|
-
await client.cloud.historyDevice("
|
|
2102
|
+
await client.cloud.historyDevice("8cfec329267", "WXGDWB");
|
|
2089
2103
|
|
|
2090
2104
|
```
|
|
2091
2105
|
</dd>
|
|
@@ -2101,7 +2115,7 @@ await client.cloud.historyDevice("WXGDWB", "8cfec329267");
|
|
|
2101
2115
|
<dl>
|
|
2102
2116
|
<dd>
|
|
2103
2117
|
|
|
2104
|
-
**
|
|
2118
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2105
2119
|
|
|
2106
2120
|
</dd>
|
|
2107
2121
|
</dl>
|
|
@@ -2109,7 +2123,7 @@ await client.cloud.historyDevice("WXGDWB", "8cfec329267");
|
|
|
2109
2123
|
<dl>
|
|
2110
2124
|
<dd>
|
|
2111
2125
|
|
|
2112
|
-
**
|
|
2126
|
+
**deviceId:** `string` — ID of the cloud device.
|
|
2113
2127
|
|
|
2114
2128
|
</dd>
|
|
2115
2129
|
</dl>
|
|
@@ -2117,7 +2131,7 @@ await client.cloud.historyDevice("WXGDWB", "8cfec329267");
|
|
|
2117
2131
|
<dl>
|
|
2118
2132
|
<dd>
|
|
2119
2133
|
|
|
2120
|
-
**requestOptions:** `
|
|
2134
|
+
**requestOptions:** `CloudClient.RequestOptions`
|
|
2121
2135
|
|
|
2122
2136
|
</dd>
|
|
2123
2137
|
</dl>
|
|
@@ -2188,7 +2202,7 @@ await client.cloud.listDevice("8cfec329267");
|
|
|
2188
2202
|
<dl>
|
|
2189
2203
|
<dd>
|
|
2190
2204
|
|
|
2191
|
-
**requestOptions:** `
|
|
2205
|
+
**requestOptions:** `CloudClient.RequestOptions`
|
|
2192
2206
|
|
|
2193
2207
|
</dd>
|
|
2194
2208
|
</dl>
|
|
@@ -2200,7 +2214,7 @@ await client.cloud.listDevice("8cfec329267");
|
|
|
2200
2214
|
</dl>
|
|
2201
2215
|
</details>
|
|
2202
2216
|
|
|
2203
|
-
<details><summary><code>client.cloud.<a href="/src/api/resources/cloud/client/Client.ts">removeDevice</a>(
|
|
2217
|
+
<details><summary><code>client.cloud.<a href="/src/api/resources/cloud/client/Client.ts">removeDevice</a>(entry, deviceId) -> Payabli.RemoveDeviceResponse</code></summary>
|
|
2204
2218
|
<dl>
|
|
2205
2219
|
<dd>
|
|
2206
2220
|
|
|
@@ -2227,7 +2241,7 @@ Remove a cloud device from an entrypoint.
|
|
|
2227
2241
|
<dd>
|
|
2228
2242
|
|
|
2229
2243
|
```typescript
|
|
2230
|
-
await client.cloud.removeDevice("6c361c7d-674c-44cc-b790-382b75d1xxx"
|
|
2244
|
+
await client.cloud.removeDevice("8cfec329267", "6c361c7d-674c-44cc-b790-382b75d1xxx");
|
|
2231
2245
|
|
|
2232
2246
|
```
|
|
2233
2247
|
</dd>
|
|
@@ -2243,7 +2257,7 @@ await client.cloud.removeDevice("6c361c7d-674c-44cc-b790-382b75d1xxx", "8cfec329
|
|
|
2243
2257
|
<dl>
|
|
2244
2258
|
<dd>
|
|
2245
2259
|
|
|
2246
|
-
**
|
|
2260
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2247
2261
|
|
|
2248
2262
|
</dd>
|
|
2249
2263
|
</dl>
|
|
@@ -2251,7 +2265,7 @@ await client.cloud.removeDevice("6c361c7d-674c-44cc-b790-382b75d1xxx", "8cfec329
|
|
|
2251
2265
|
<dl>
|
|
2252
2266
|
<dd>
|
|
2253
2267
|
|
|
2254
|
-
**
|
|
2268
|
+
**deviceId:** `string` — ID of the cloud device.
|
|
2255
2269
|
|
|
2256
2270
|
</dd>
|
|
2257
2271
|
</dl>
|
|
@@ -2259,7 +2273,7 @@ await client.cloud.removeDevice("6c361c7d-674c-44cc-b790-382b75d1xxx", "8cfec329
|
|
|
2259
2273
|
<dl>
|
|
2260
2274
|
<dd>
|
|
2261
2275
|
|
|
2262
|
-
**requestOptions:** `
|
|
2276
|
+
**requestOptions:** `CloudClient.RequestOptions`
|
|
2263
2277
|
|
|
2264
2278
|
</dd>
|
|
2265
2279
|
</dl>
|
|
@@ -2346,7 +2360,7 @@ await client.customer.addCustomer("8cfec329267", {
|
|
|
2346
2360
|
<dl>
|
|
2347
2361
|
<dd>
|
|
2348
2362
|
|
|
2349
|
-
**requestOptions:** `
|
|
2363
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2350
2364
|
|
|
2351
2365
|
</dd>
|
|
2352
2366
|
</dl>
|
|
@@ -2409,7 +2423,7 @@ await client.customer.deleteCustomer(998);
|
|
|
2409
2423
|
<dl>
|
|
2410
2424
|
<dd>
|
|
2411
2425
|
|
|
2412
|
-
**requestOptions:** `
|
|
2426
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2413
2427
|
|
|
2414
2428
|
</dd>
|
|
2415
2429
|
</dl>
|
|
@@ -2472,7 +2486,7 @@ await client.customer.getCustomer(998);
|
|
|
2472
2486
|
<dl>
|
|
2473
2487
|
<dd>
|
|
2474
2488
|
|
|
2475
|
-
**requestOptions:** `
|
|
2489
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2476
2490
|
|
|
2477
2491
|
</dd>
|
|
2478
2492
|
</dl>
|
|
@@ -2543,7 +2557,7 @@ await client.customer.linkCustomerTransaction(998, "45-as456777hhhhhhhhhh7777777
|
|
|
2543
2557
|
<dl>
|
|
2544
2558
|
<dd>
|
|
2545
2559
|
|
|
2546
|
-
**requestOptions:** `
|
|
2560
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2547
2561
|
|
|
2548
2562
|
</dd>
|
|
2549
2563
|
</dl>
|
|
@@ -2606,7 +2620,7 @@ await client.customer.requestConsent(998);
|
|
|
2606
2620
|
<dl>
|
|
2607
2621
|
<dd>
|
|
2608
2622
|
|
|
2609
|
-
**requestOptions:** `
|
|
2623
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2610
2624
|
|
|
2611
2625
|
</dd>
|
|
2612
2626
|
</dl>
|
|
@@ -2685,7 +2699,7 @@ await client.customer.updateCustomer(998, {
|
|
|
2685
2699
|
<dl>
|
|
2686
2700
|
<dd>
|
|
2687
2701
|
|
|
2688
|
-
**requestOptions:** `
|
|
2702
|
+
**requestOptions:** `CustomerClient.RequestOptions`
|
|
2689
2703
|
|
|
2690
2704
|
</dd>
|
|
2691
2705
|
</dl>
|
|
@@ -2769,7 +2783,7 @@ await client.export.exportApplications("csv", 123, {
|
|
|
2769
2783
|
<dl>
|
|
2770
2784
|
<dd>
|
|
2771
2785
|
|
|
2772
|
-
**requestOptions:** `
|
|
2786
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
2773
2787
|
|
|
2774
2788
|
</dd>
|
|
2775
2789
|
</dl>
|
|
@@ -2781,10 +2795,24 @@ await client.export.exportApplications("csv", 123, {
|
|
|
2781
2795
|
</dl>
|
|
2782
2796
|
</details>
|
|
2783
2797
|
|
|
2784
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatchDetails</a>(
|
|
2798
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatchDetails</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
2799
|
+
<dl>
|
|
2800
|
+
<dd>
|
|
2801
|
+
|
|
2802
|
+
#### 📝 Description
|
|
2803
|
+
|
|
2785
2804
|
<dl>
|
|
2786
2805
|
<dd>
|
|
2787
2806
|
|
|
2807
|
+
<dl>
|
|
2808
|
+
<dd>
|
|
2809
|
+
|
|
2810
|
+
This endpoint is deprecated. Export batch details for a paypoint. Use filters to limit results.
|
|
2811
|
+
</dd>
|
|
2812
|
+
</dl>
|
|
2813
|
+
</dd>
|
|
2814
|
+
</dl>
|
|
2815
|
+
|
|
2788
2816
|
#### 🔌 Usage
|
|
2789
2817
|
|
|
2790
2818
|
<dl>
|
|
@@ -2794,7 +2822,7 @@ await client.export.exportApplications("csv", 123, {
|
|
|
2794
2822
|
<dd>
|
|
2795
2823
|
|
|
2796
2824
|
```typescript
|
|
2797
|
-
await client.export.exportBatchDetails("
|
|
2825
|
+
await client.export.exportBatchDetails("csv", "8cfec329267", {
|
|
2798
2826
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
2799
2827
|
fromRecord: 251,
|
|
2800
2828
|
limitRecord: 1000
|
|
@@ -2814,7 +2842,7 @@ await client.export.exportBatchDetails("8cfec329267", "csv", {
|
|
|
2814
2842
|
<dl>
|
|
2815
2843
|
<dd>
|
|
2816
2844
|
|
|
2817
|
-
**
|
|
2845
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
2818
2846
|
|
|
2819
2847
|
</dd>
|
|
2820
2848
|
</dl>
|
|
@@ -2822,7 +2850,7 @@ await client.export.exportBatchDetails("8cfec329267", "csv", {
|
|
|
2822
2850
|
<dl>
|
|
2823
2851
|
<dd>
|
|
2824
2852
|
|
|
2825
|
-
**
|
|
2853
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2826
2854
|
|
|
2827
2855
|
</dd>
|
|
2828
2856
|
</dl>
|
|
@@ -2838,7 +2866,7 @@ await client.export.exportBatchDetails("8cfec329267", "csv", {
|
|
|
2838
2866
|
<dl>
|
|
2839
2867
|
<dd>
|
|
2840
2868
|
|
|
2841
|
-
**requestOptions:** `
|
|
2869
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
2842
2870
|
|
|
2843
2871
|
</dd>
|
|
2844
2872
|
</dl>
|
|
@@ -2854,6 +2882,20 @@ await client.export.exportBatchDetails("8cfec329267", "csv", {
|
|
|
2854
2882
|
<dl>
|
|
2855
2883
|
<dd>
|
|
2856
2884
|
|
|
2885
|
+
#### 📝 Description
|
|
2886
|
+
|
|
2887
|
+
<dl>
|
|
2888
|
+
<dd>
|
|
2889
|
+
|
|
2890
|
+
<dl>
|
|
2891
|
+
<dd>
|
|
2892
|
+
|
|
2893
|
+
This endpoint is deprecated. Export batch details for an organization. Use filters to limit results.
|
|
2894
|
+
</dd>
|
|
2895
|
+
</dl>
|
|
2896
|
+
</dd>
|
|
2897
|
+
</dl>
|
|
2898
|
+
|
|
2857
2899
|
#### 🔌 Usage
|
|
2858
2900
|
|
|
2859
2901
|
<dl>
|
|
@@ -2907,7 +2949,7 @@ await client.export.exportBatchDetailsOrg("csv", 123, {
|
|
|
2907
2949
|
<dl>
|
|
2908
2950
|
<dd>
|
|
2909
2951
|
|
|
2910
|
-
**requestOptions:** `
|
|
2952
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
2911
2953
|
|
|
2912
2954
|
</dd>
|
|
2913
2955
|
</dl>
|
|
@@ -2919,7 +2961,7 @@ await client.export.exportBatchDetailsOrg("csv", 123, {
|
|
|
2919
2961
|
</dl>
|
|
2920
2962
|
</details>
|
|
2921
2963
|
|
|
2922
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatches</a>(
|
|
2964
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatches</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
2923
2965
|
<dl>
|
|
2924
2966
|
<dd>
|
|
2925
2967
|
|
|
@@ -2946,7 +2988,7 @@ Export a list of batches for an entrypoint. Use filters to limit results.
|
|
|
2946
2988
|
<dd>
|
|
2947
2989
|
|
|
2948
2990
|
```typescript
|
|
2949
|
-
await client.export.exportBatches("
|
|
2991
|
+
await client.export.exportBatches("csv", "8cfec329267", {
|
|
2950
2992
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
2951
2993
|
fromRecord: 251,
|
|
2952
2994
|
limitRecord: 1000
|
|
@@ -2966,7 +3008,7 @@ await client.export.exportBatches("8cfec329267", "csv", {
|
|
|
2966
3008
|
<dl>
|
|
2967
3009
|
<dd>
|
|
2968
3010
|
|
|
2969
|
-
**
|
|
3011
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
2970
3012
|
|
|
2971
3013
|
</dd>
|
|
2972
3014
|
</dl>
|
|
@@ -2974,7 +3016,7 @@ await client.export.exportBatches("8cfec329267", "csv", {
|
|
|
2974
3016
|
<dl>
|
|
2975
3017
|
<dd>
|
|
2976
3018
|
|
|
2977
|
-
**
|
|
3019
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
2978
3020
|
|
|
2979
3021
|
</dd>
|
|
2980
3022
|
</dl>
|
|
@@ -2990,7 +3032,7 @@ await client.export.exportBatches("8cfec329267", "csv", {
|
|
|
2990
3032
|
<dl>
|
|
2991
3033
|
<dd>
|
|
2992
3034
|
|
|
2993
|
-
**requestOptions:** `
|
|
3035
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
2994
3036
|
|
|
2995
3037
|
</dd>
|
|
2996
3038
|
</dl>
|
|
@@ -3073,7 +3115,7 @@ await client.export.exportBatchesOrg("csv", 123, {
|
|
|
3073
3115
|
<dl>
|
|
3074
3116
|
<dd>
|
|
3075
3117
|
|
|
3076
|
-
**requestOptions:** `
|
|
3118
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3077
3119
|
|
|
3078
3120
|
</dd>
|
|
3079
3121
|
</dl>
|
|
@@ -3085,7 +3127,7 @@ await client.export.exportBatchesOrg("csv", 123, {
|
|
|
3085
3127
|
</dl>
|
|
3086
3128
|
</details>
|
|
3087
3129
|
|
|
3088
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatchesOut</a>(
|
|
3130
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBatchesOut</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3089
3131
|
<dl>
|
|
3090
3132
|
<dd>
|
|
3091
3133
|
|
|
@@ -3112,7 +3154,7 @@ Export a list of money out batches for a paypoint. Use filters to limit results.
|
|
|
3112
3154
|
<dd>
|
|
3113
3155
|
|
|
3114
3156
|
```typescript
|
|
3115
|
-
await client.export.exportBatchesOut("
|
|
3157
|
+
await client.export.exportBatchesOut("csv", "8cfec329267", {
|
|
3116
3158
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3117
3159
|
fromRecord: 251,
|
|
3118
3160
|
limitRecord: 1000
|
|
@@ -3132,7 +3174,7 @@ await client.export.exportBatchesOut("8cfec329267", "csv", {
|
|
|
3132
3174
|
<dl>
|
|
3133
3175
|
<dd>
|
|
3134
3176
|
|
|
3135
|
-
**
|
|
3177
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3136
3178
|
|
|
3137
3179
|
</dd>
|
|
3138
3180
|
</dl>
|
|
@@ -3140,7 +3182,7 @@ await client.export.exportBatchesOut("8cfec329267", "csv", {
|
|
|
3140
3182
|
<dl>
|
|
3141
3183
|
<dd>
|
|
3142
3184
|
|
|
3143
|
-
**
|
|
3185
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3144
3186
|
|
|
3145
3187
|
</dd>
|
|
3146
3188
|
</dl>
|
|
@@ -3156,7 +3198,7 @@ await client.export.exportBatchesOut("8cfec329267", "csv", {
|
|
|
3156
3198
|
<dl>
|
|
3157
3199
|
<dd>
|
|
3158
3200
|
|
|
3159
|
-
**requestOptions:** `
|
|
3201
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3160
3202
|
|
|
3161
3203
|
</dd>
|
|
3162
3204
|
</dl>
|
|
@@ -3239,7 +3281,7 @@ await client.export.exportBatchesOutOrg("csv", 123, {
|
|
|
3239
3281
|
<dl>
|
|
3240
3282
|
<dd>
|
|
3241
3283
|
|
|
3242
|
-
**requestOptions:** `
|
|
3284
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3243
3285
|
|
|
3244
3286
|
</dd>
|
|
3245
3287
|
</dl>
|
|
@@ -3251,7 +3293,7 @@ await client.export.exportBatchesOutOrg("csv", 123, {
|
|
|
3251
3293
|
</dl>
|
|
3252
3294
|
</details>
|
|
3253
3295
|
|
|
3254
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBills</a>(
|
|
3296
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportBills</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3255
3297
|
<dl>
|
|
3256
3298
|
<dd>
|
|
3257
3299
|
|
|
@@ -3278,7 +3320,7 @@ Export a list of bills for an entrypoint. Use filters to limit results.
|
|
|
3278
3320
|
<dd>
|
|
3279
3321
|
|
|
3280
3322
|
```typescript
|
|
3281
|
-
await client.export.exportBills("
|
|
3323
|
+
await client.export.exportBills("csv", "8cfec329267", {
|
|
3282
3324
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3283
3325
|
fromRecord: 251,
|
|
3284
3326
|
limitRecord: 1000
|
|
@@ -3298,7 +3340,7 @@ await client.export.exportBills("8cfec329267", "csv", {
|
|
|
3298
3340
|
<dl>
|
|
3299
3341
|
<dd>
|
|
3300
3342
|
|
|
3301
|
-
**
|
|
3343
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3302
3344
|
|
|
3303
3345
|
</dd>
|
|
3304
3346
|
</dl>
|
|
@@ -3306,7 +3348,7 @@ await client.export.exportBills("8cfec329267", "csv", {
|
|
|
3306
3348
|
<dl>
|
|
3307
3349
|
<dd>
|
|
3308
3350
|
|
|
3309
|
-
**
|
|
3351
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3310
3352
|
|
|
3311
3353
|
</dd>
|
|
3312
3354
|
</dl>
|
|
@@ -3322,7 +3364,7 @@ await client.export.exportBills("8cfec329267", "csv", {
|
|
|
3322
3364
|
<dl>
|
|
3323
3365
|
<dd>
|
|
3324
3366
|
|
|
3325
|
-
**requestOptions:** `
|
|
3367
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3326
3368
|
|
|
3327
3369
|
</dd>
|
|
3328
3370
|
</dl>
|
|
@@ -3405,7 +3447,7 @@ await client.export.exportBillsOrg("csv", 123, {
|
|
|
3405
3447
|
<dl>
|
|
3406
3448
|
<dd>
|
|
3407
3449
|
|
|
3408
|
-
**requestOptions:** `
|
|
3450
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3409
3451
|
|
|
3410
3452
|
</dd>
|
|
3411
3453
|
</dl>
|
|
@@ -3417,7 +3459,7 @@ await client.export.exportBillsOrg("csv", 123, {
|
|
|
3417
3459
|
</dl>
|
|
3418
3460
|
</details>
|
|
3419
3461
|
|
|
3420
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportChargebacks</a>(
|
|
3462
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportChargebacks</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3421
3463
|
<dl>
|
|
3422
3464
|
<dd>
|
|
3423
3465
|
|
|
@@ -3444,7 +3486,7 @@ Export a list of chargebacks and ACH returns for an entrypoint. Use filters to l
|
|
|
3444
3486
|
<dd>
|
|
3445
3487
|
|
|
3446
3488
|
```typescript
|
|
3447
|
-
await client.export.exportChargebacks("
|
|
3489
|
+
await client.export.exportChargebacks("csv", "8cfec329267", {
|
|
3448
3490
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3449
3491
|
fromRecord: 251,
|
|
3450
3492
|
limitRecord: 1000
|
|
@@ -3464,7 +3506,7 @@ await client.export.exportChargebacks("8cfec329267", "csv", {
|
|
|
3464
3506
|
<dl>
|
|
3465
3507
|
<dd>
|
|
3466
3508
|
|
|
3467
|
-
**
|
|
3509
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3468
3510
|
|
|
3469
3511
|
</dd>
|
|
3470
3512
|
</dl>
|
|
@@ -3472,7 +3514,7 @@ await client.export.exportChargebacks("8cfec329267", "csv", {
|
|
|
3472
3514
|
<dl>
|
|
3473
3515
|
<dd>
|
|
3474
3516
|
|
|
3475
|
-
**
|
|
3517
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3476
3518
|
|
|
3477
3519
|
</dd>
|
|
3478
3520
|
</dl>
|
|
@@ -3488,7 +3530,7 @@ await client.export.exportChargebacks("8cfec329267", "csv", {
|
|
|
3488
3530
|
<dl>
|
|
3489
3531
|
<dd>
|
|
3490
3532
|
|
|
3491
|
-
**requestOptions:** `
|
|
3533
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3492
3534
|
|
|
3493
3535
|
</dd>
|
|
3494
3536
|
</dl>
|
|
@@ -3571,7 +3613,7 @@ await client.export.exportChargebacksOrg("csv", 123, {
|
|
|
3571
3613
|
<dl>
|
|
3572
3614
|
<dd>
|
|
3573
3615
|
|
|
3574
|
-
**requestOptions:** `
|
|
3616
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3575
3617
|
|
|
3576
3618
|
</dd>
|
|
3577
3619
|
</dl>
|
|
@@ -3583,7 +3625,7 @@ await client.export.exportChargebacksOrg("csv", 123, {
|
|
|
3583
3625
|
</dl>
|
|
3584
3626
|
</details>
|
|
3585
3627
|
|
|
3586
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportCustomers</a>(
|
|
3628
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportCustomers</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3587
3629
|
<dl>
|
|
3588
3630
|
<dd>
|
|
3589
3631
|
|
|
@@ -3610,7 +3652,7 @@ Export a list of customers for an entrypoint. Use filters to limit results.
|
|
|
3610
3652
|
<dd>
|
|
3611
3653
|
|
|
3612
3654
|
```typescript
|
|
3613
|
-
await client.export.exportCustomers("
|
|
3655
|
+
await client.export.exportCustomers("csv", "8cfec329267", {
|
|
3614
3656
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3615
3657
|
fromRecord: 251,
|
|
3616
3658
|
limitRecord: 1000
|
|
@@ -3630,7 +3672,7 @@ await client.export.exportCustomers("8cfec329267", "csv", {
|
|
|
3630
3672
|
<dl>
|
|
3631
3673
|
<dd>
|
|
3632
3674
|
|
|
3633
|
-
**
|
|
3675
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3634
3676
|
|
|
3635
3677
|
</dd>
|
|
3636
3678
|
</dl>
|
|
@@ -3638,7 +3680,7 @@ await client.export.exportCustomers("8cfec329267", "csv", {
|
|
|
3638
3680
|
<dl>
|
|
3639
3681
|
<dd>
|
|
3640
3682
|
|
|
3641
|
-
**
|
|
3683
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3642
3684
|
|
|
3643
3685
|
</dd>
|
|
3644
3686
|
</dl>
|
|
@@ -3654,7 +3696,7 @@ await client.export.exportCustomers("8cfec329267", "csv", {
|
|
|
3654
3696
|
<dl>
|
|
3655
3697
|
<dd>
|
|
3656
3698
|
|
|
3657
|
-
**requestOptions:** `
|
|
3699
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3658
3700
|
|
|
3659
3701
|
</dd>
|
|
3660
3702
|
</dl>
|
|
@@ -3737,7 +3779,7 @@ await client.export.exportCustomersOrg("csv", 123, {
|
|
|
3737
3779
|
<dl>
|
|
3738
3780
|
<dd>
|
|
3739
3781
|
|
|
3740
|
-
**requestOptions:** `
|
|
3782
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3741
3783
|
|
|
3742
3784
|
</dd>
|
|
3743
3785
|
</dl>
|
|
@@ -3749,7 +3791,7 @@ await client.export.exportCustomersOrg("csv", 123, {
|
|
|
3749
3791
|
</dl>
|
|
3750
3792
|
</details>
|
|
3751
3793
|
|
|
3752
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportInvoices</a>(
|
|
3794
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportInvoices</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
3753
3795
|
<dl>
|
|
3754
3796
|
<dd>
|
|
3755
3797
|
|
|
@@ -3776,7 +3818,7 @@ Export list of invoices for an entrypoint. Use filters to limit results.
|
|
|
3776
3818
|
<dd>
|
|
3777
3819
|
|
|
3778
3820
|
```typescript
|
|
3779
|
-
await client.export.exportInvoices("
|
|
3821
|
+
await client.export.exportInvoices("csv", "8cfec329267", {
|
|
3780
3822
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3781
3823
|
fromRecord: 251,
|
|
3782
3824
|
limitRecord: 1000
|
|
@@ -3796,7 +3838,7 @@ await client.export.exportInvoices("8cfec329267", "csv", {
|
|
|
3796
3838
|
<dl>
|
|
3797
3839
|
<dd>
|
|
3798
3840
|
|
|
3799
|
-
**
|
|
3841
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
3800
3842
|
|
|
3801
3843
|
</dd>
|
|
3802
3844
|
</dl>
|
|
@@ -3804,7 +3846,7 @@ await client.export.exportInvoices("8cfec329267", "csv", {
|
|
|
3804
3846
|
<dl>
|
|
3805
3847
|
<dd>
|
|
3806
3848
|
|
|
3807
|
-
**
|
|
3849
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
3808
3850
|
|
|
3809
3851
|
</dd>
|
|
3810
3852
|
</dl>
|
|
@@ -3820,7 +3862,7 @@ await client.export.exportInvoices("8cfec329267", "csv", {
|
|
|
3820
3862
|
<dl>
|
|
3821
3863
|
<dd>
|
|
3822
3864
|
|
|
3823
|
-
**requestOptions:** `
|
|
3865
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3824
3866
|
|
|
3825
3867
|
</dd>
|
|
3826
3868
|
</dl>
|
|
@@ -3903,7 +3945,7 @@ await client.export.exportInvoicesOrg("csv", 123, {
|
|
|
3903
3945
|
<dl>
|
|
3904
3946
|
<dd>
|
|
3905
3947
|
|
|
3906
|
-
**requestOptions:** `
|
|
3948
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3907
3949
|
|
|
3908
3950
|
</dd>
|
|
3909
3951
|
</dl>
|
|
@@ -3986,7 +4028,7 @@ await client.export.exportOrganizations("csv", 123, {
|
|
|
3986
4028
|
<dl>
|
|
3987
4029
|
<dd>
|
|
3988
4030
|
|
|
3989
|
-
**requestOptions:** `
|
|
4031
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
3990
4032
|
|
|
3991
4033
|
</dd>
|
|
3992
4034
|
</dl>
|
|
@@ -3998,7 +4040,7 @@ await client.export.exportOrganizations("csv", 123, {
|
|
|
3998
4040
|
</dl>
|
|
3999
4041
|
</details>
|
|
4000
4042
|
|
|
4001
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportPayout</a>(
|
|
4043
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportPayout</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4002
4044
|
<dl>
|
|
4003
4045
|
<dd>
|
|
4004
4046
|
|
|
@@ -4025,7 +4067,7 @@ Export a list of payouts and their statuses for an entrypoint. Use filters to li
|
|
|
4025
4067
|
<dd>
|
|
4026
4068
|
|
|
4027
4069
|
```typescript
|
|
4028
|
-
await client.export.exportPayout("
|
|
4070
|
+
await client.export.exportPayout("csv", "8cfec329267", {
|
|
4029
4071
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4030
4072
|
fromRecord: 251,
|
|
4031
4073
|
limitRecord: 1000
|
|
@@ -4045,7 +4087,7 @@ await client.export.exportPayout("8cfec329267", "csv", {
|
|
|
4045
4087
|
<dl>
|
|
4046
4088
|
<dd>
|
|
4047
4089
|
|
|
4048
|
-
**
|
|
4090
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4049
4091
|
|
|
4050
4092
|
</dd>
|
|
4051
4093
|
</dl>
|
|
@@ -4053,7 +4095,7 @@ await client.export.exportPayout("8cfec329267", "csv", {
|
|
|
4053
4095
|
<dl>
|
|
4054
4096
|
<dd>
|
|
4055
4097
|
|
|
4056
|
-
**
|
|
4098
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4057
4099
|
|
|
4058
4100
|
</dd>
|
|
4059
4101
|
</dl>
|
|
@@ -4069,7 +4111,7 @@ await client.export.exportPayout("8cfec329267", "csv", {
|
|
|
4069
4111
|
<dl>
|
|
4070
4112
|
<dd>
|
|
4071
4113
|
|
|
4072
|
-
**requestOptions:** `
|
|
4114
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4073
4115
|
|
|
4074
4116
|
</dd>
|
|
4075
4117
|
</dl>
|
|
@@ -4152,7 +4194,7 @@ await client.export.exportPayoutOrg("csv", 123, {
|
|
|
4152
4194
|
<dl>
|
|
4153
4195
|
<dd>
|
|
4154
4196
|
|
|
4155
|
-
**requestOptions:** `
|
|
4197
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4156
4198
|
|
|
4157
4199
|
</dd>
|
|
4158
4200
|
</dl>
|
|
@@ -4235,7 +4277,7 @@ await client.export.exportPaypoints("csv", 123, {
|
|
|
4235
4277
|
<dl>
|
|
4236
4278
|
<dd>
|
|
4237
4279
|
|
|
4238
|
-
**requestOptions:** `
|
|
4280
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4239
4281
|
|
|
4240
4282
|
</dd>
|
|
4241
4283
|
</dl>
|
|
@@ -4247,7 +4289,7 @@ await client.export.exportPaypoints("csv", 123, {
|
|
|
4247
4289
|
</dl>
|
|
4248
4290
|
</details>
|
|
4249
4291
|
|
|
4250
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportSettlements</a>(
|
|
4292
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportSettlements</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4251
4293
|
<dl>
|
|
4252
4294
|
<dd>
|
|
4253
4295
|
|
|
@@ -4274,7 +4316,7 @@ Export a list of settled transactions for an entrypoint. Use filters to limit re
|
|
|
4274
4316
|
<dd>
|
|
4275
4317
|
|
|
4276
4318
|
```typescript
|
|
4277
|
-
await client.export.exportSettlements("
|
|
4319
|
+
await client.export.exportSettlements("csv", "8cfec329267", {
|
|
4278
4320
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4279
4321
|
fromRecord: 251,
|
|
4280
4322
|
limitRecord: 1000
|
|
@@ -4294,7 +4336,7 @@ await client.export.exportSettlements("8cfec329267", "csv", {
|
|
|
4294
4336
|
<dl>
|
|
4295
4337
|
<dd>
|
|
4296
4338
|
|
|
4297
|
-
**
|
|
4339
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4298
4340
|
|
|
4299
4341
|
</dd>
|
|
4300
4342
|
</dl>
|
|
@@ -4302,7 +4344,7 @@ await client.export.exportSettlements("8cfec329267", "csv", {
|
|
|
4302
4344
|
<dl>
|
|
4303
4345
|
<dd>
|
|
4304
4346
|
|
|
4305
|
-
**
|
|
4347
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4306
4348
|
|
|
4307
4349
|
</dd>
|
|
4308
4350
|
</dl>
|
|
@@ -4318,7 +4360,7 @@ await client.export.exportSettlements("8cfec329267", "csv", {
|
|
|
4318
4360
|
<dl>
|
|
4319
4361
|
<dd>
|
|
4320
4362
|
|
|
4321
|
-
**requestOptions:** `
|
|
4363
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4322
4364
|
|
|
4323
4365
|
</dd>
|
|
4324
4366
|
</dl>
|
|
@@ -4401,7 +4443,7 @@ await client.export.exportSettlementsOrg("csv", 123, {
|
|
|
4401
4443
|
<dl>
|
|
4402
4444
|
<dd>
|
|
4403
4445
|
|
|
4404
|
-
**requestOptions:** `
|
|
4446
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4405
4447
|
|
|
4406
4448
|
</dd>
|
|
4407
4449
|
</dl>
|
|
@@ -4413,7 +4455,7 @@ await client.export.exportSettlementsOrg("csv", 123, {
|
|
|
4413
4455
|
</dl>
|
|
4414
4456
|
</details>
|
|
4415
4457
|
|
|
4416
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportSubscriptions</a>(
|
|
4458
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportSubscriptions</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4417
4459
|
<dl>
|
|
4418
4460
|
<dd>
|
|
4419
4461
|
|
|
@@ -4440,7 +4482,7 @@ Export a list of subscriptions for an entrypoint. Use filters to limit results.
|
|
|
4440
4482
|
<dd>
|
|
4441
4483
|
|
|
4442
4484
|
```typescript
|
|
4443
|
-
await client.export.exportSubscriptions("
|
|
4485
|
+
await client.export.exportSubscriptions("csv", "8cfec329267", {
|
|
4444
4486
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4445
4487
|
fromRecord: 251,
|
|
4446
4488
|
limitRecord: 1000
|
|
@@ -4460,7 +4502,7 @@ await client.export.exportSubscriptions("8cfec329267", "csv", {
|
|
|
4460
4502
|
<dl>
|
|
4461
4503
|
<dd>
|
|
4462
4504
|
|
|
4463
|
-
**
|
|
4505
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4464
4506
|
|
|
4465
4507
|
</dd>
|
|
4466
4508
|
</dl>
|
|
@@ -4468,7 +4510,7 @@ await client.export.exportSubscriptions("8cfec329267", "csv", {
|
|
|
4468
4510
|
<dl>
|
|
4469
4511
|
<dd>
|
|
4470
4512
|
|
|
4471
|
-
**
|
|
4513
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4472
4514
|
|
|
4473
4515
|
</dd>
|
|
4474
4516
|
</dl>
|
|
@@ -4484,7 +4526,7 @@ await client.export.exportSubscriptions("8cfec329267", "csv", {
|
|
|
4484
4526
|
<dl>
|
|
4485
4527
|
<dd>
|
|
4486
4528
|
|
|
4487
|
-
**requestOptions:** `
|
|
4529
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4488
4530
|
|
|
4489
4531
|
</dd>
|
|
4490
4532
|
</dl>
|
|
@@ -4567,7 +4609,7 @@ await client.export.exportSubscriptionsOrg("csv", 123, {
|
|
|
4567
4609
|
<dl>
|
|
4568
4610
|
<dd>
|
|
4569
4611
|
|
|
4570
|
-
**requestOptions:** `
|
|
4612
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4571
4613
|
|
|
4572
4614
|
</dd>
|
|
4573
4615
|
</dl>
|
|
@@ -4579,7 +4621,7 @@ await client.export.exportSubscriptionsOrg("csv", 123, {
|
|
|
4579
4621
|
</dl>
|
|
4580
4622
|
</details>
|
|
4581
4623
|
|
|
4582
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportTransactions</a>(
|
|
4624
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportTransactions</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4583
4625
|
<dl>
|
|
4584
4626
|
<dd>
|
|
4585
4627
|
|
|
@@ -4606,7 +4648,7 @@ Export a list of transactions for an entrypoint in a file in XLXS or CSV format.
|
|
|
4606
4648
|
<dd>
|
|
4607
4649
|
|
|
4608
4650
|
```typescript
|
|
4609
|
-
await client.export.exportTransactions("
|
|
4651
|
+
await client.export.exportTransactions("csv", "8cfec329267", {
|
|
4610
4652
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4611
4653
|
fromRecord: 251,
|
|
4612
4654
|
limitRecord: 1000
|
|
@@ -4626,7 +4668,7 @@ await client.export.exportTransactions("8cfec329267", "csv", {
|
|
|
4626
4668
|
<dl>
|
|
4627
4669
|
<dd>
|
|
4628
4670
|
|
|
4629
|
-
**
|
|
4671
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4630
4672
|
|
|
4631
4673
|
</dd>
|
|
4632
4674
|
</dl>
|
|
@@ -4634,7 +4676,7 @@ await client.export.exportTransactions("8cfec329267", "csv", {
|
|
|
4634
4676
|
<dl>
|
|
4635
4677
|
<dd>
|
|
4636
4678
|
|
|
4637
|
-
**
|
|
4679
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4638
4680
|
|
|
4639
4681
|
</dd>
|
|
4640
4682
|
</dl>
|
|
@@ -4650,7 +4692,7 @@ await client.export.exportTransactions("8cfec329267", "csv", {
|
|
|
4650
4692
|
<dl>
|
|
4651
4693
|
<dd>
|
|
4652
4694
|
|
|
4653
|
-
**requestOptions:** `
|
|
4695
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4654
4696
|
|
|
4655
4697
|
</dd>
|
|
4656
4698
|
</dl>
|
|
@@ -4733,7 +4775,7 @@ await client.export.exportTransactionsOrg("csv", 123, {
|
|
|
4733
4775
|
<dl>
|
|
4734
4776
|
<dd>
|
|
4735
4777
|
|
|
4736
|
-
**requestOptions:** `
|
|
4778
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4737
4779
|
|
|
4738
4780
|
</dd>
|
|
4739
4781
|
</dl>
|
|
@@ -4745,7 +4787,7 @@ await client.export.exportTransactionsOrg("csv", 123, {
|
|
|
4745
4787
|
</dl>
|
|
4746
4788
|
</details>
|
|
4747
4789
|
|
|
4748
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportTransferDetails</a>(
|
|
4790
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportTransferDetails</a>(format, entry, transferId, { ...params }) -> Payabli.File_</code></summary>
|
|
4749
4791
|
<dl>
|
|
4750
4792
|
<dd>
|
|
4751
4793
|
|
|
@@ -4772,7 +4814,7 @@ Export a list of transfer details for an entrypoint. Use filters to limit result
|
|
|
4772
4814
|
<dd>
|
|
4773
4815
|
|
|
4774
4816
|
```typescript
|
|
4775
|
-
await client.export.exportTransferDetails("
|
|
4817
|
+
await client.export.exportTransferDetails("csv", "8cfec329267", 1000000, {
|
|
4776
4818
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4777
4819
|
fromRecord: 251,
|
|
4778
4820
|
limitRecord: 1000,
|
|
@@ -4793,7 +4835,7 @@ await client.export.exportTransferDetails("8cfec329267", "csv", 1000000, {
|
|
|
4793
4835
|
<dl>
|
|
4794
4836
|
<dd>
|
|
4795
4837
|
|
|
4796
|
-
**
|
|
4838
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4797
4839
|
|
|
4798
4840
|
</dd>
|
|
4799
4841
|
</dl>
|
|
@@ -4801,7 +4843,7 @@ await client.export.exportTransferDetails("8cfec329267", "csv", 1000000, {
|
|
|
4801
4843
|
<dl>
|
|
4802
4844
|
<dd>
|
|
4803
4845
|
|
|
4804
|
-
**
|
|
4846
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4805
4847
|
|
|
4806
4848
|
</dd>
|
|
4807
4849
|
</dl>
|
|
@@ -4825,7 +4867,7 @@ await client.export.exportTransferDetails("8cfec329267", "csv", 1000000, {
|
|
|
4825
4867
|
<dl>
|
|
4826
4868
|
<dd>
|
|
4827
4869
|
|
|
4828
|
-
**requestOptions:** `
|
|
4870
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4829
4871
|
|
|
4830
4872
|
</dd>
|
|
4831
4873
|
</dl>
|
|
@@ -4901,7 +4943,7 @@ await client.export.exportTransfers("8cfec329267", {
|
|
|
4901
4943
|
<dl>
|
|
4902
4944
|
<dd>
|
|
4903
4945
|
|
|
4904
|
-
**requestOptions:** `
|
|
4946
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4905
4947
|
|
|
4906
4948
|
</dd>
|
|
4907
4949
|
</dl>
|
|
@@ -4913,7 +4955,7 @@ await client.export.exportTransfers("8cfec329267", {
|
|
|
4913
4955
|
</dl>
|
|
4914
4956
|
</details>
|
|
4915
4957
|
|
|
4916
|
-
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportVendors</a>(
|
|
4958
|
+
<details><summary><code>client.export.<a href="/src/api/resources/export/client/Client.ts">exportVendors</a>(format, entry, { ...params }) -> Payabli.File_</code></summary>
|
|
4917
4959
|
<dl>
|
|
4918
4960
|
<dd>
|
|
4919
4961
|
|
|
@@ -4940,7 +4982,7 @@ Export a list of vendors for an entrypoint. Use filters to limit results.
|
|
|
4940
4982
|
<dd>
|
|
4941
4983
|
|
|
4942
4984
|
```typescript
|
|
4943
|
-
await client.export.exportVendors("
|
|
4985
|
+
await client.export.exportVendors("csv", "8cfec329267", {
|
|
4944
4986
|
columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4945
4987
|
fromRecord: 251,
|
|
4946
4988
|
limitRecord: 1000
|
|
@@ -4960,7 +5002,7 @@ await client.export.exportVendors("8cfec329267", "csv", {
|
|
|
4960
5002
|
<dl>
|
|
4961
5003
|
<dd>
|
|
4962
5004
|
|
|
4963
|
-
**
|
|
5005
|
+
**format:** `Payabli.ExportFormat1` — Format for the export, either XLSX or CSV.
|
|
4964
5006
|
|
|
4965
5007
|
</dd>
|
|
4966
5008
|
</dl>
|
|
@@ -4968,7 +5010,7 @@ await client.export.exportVendors("8cfec329267", "csv", {
|
|
|
4968
5010
|
<dl>
|
|
4969
5011
|
<dd>
|
|
4970
5012
|
|
|
4971
|
-
**
|
|
5013
|
+
**entry:** `string` — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry)
|
|
4972
5014
|
|
|
4973
5015
|
</dd>
|
|
4974
5016
|
</dl>
|
|
@@ -4984,7 +5026,7 @@ await client.export.exportVendors("8cfec329267", "csv", {
|
|
|
4984
5026
|
<dl>
|
|
4985
5027
|
<dd>
|
|
4986
5028
|
|
|
4987
|
-
**requestOptions:** `
|
|
5029
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
4988
5030
|
|
|
4989
5031
|
</dd>
|
|
4990
5032
|
</dl>
|
|
@@ -5067,7 +5109,7 @@ await client.export.exportVendorsOrg("csv", 123, {
|
|
|
5067
5109
|
<dl>
|
|
5068
5110
|
<dd>
|
|
5069
5111
|
|
|
5070
|
-
**requestOptions:** `
|
|
5112
|
+
**requestOptions:** `ExportClient.RequestOptions`
|
|
5071
5113
|
|
|
5072
5114
|
</dd>
|
|
5073
5115
|
</dl>
|
|
@@ -5139,7 +5181,7 @@ await client.hostedPaymentPages.loadPage("8cfec329267", "pay-your-fees-1");
|
|
|
5139
5181
|
<dl>
|
|
5140
5182
|
<dd>
|
|
5141
5183
|
|
|
5142
|
-
**requestOptions:** `
|
|
5184
|
+
**requestOptions:** `HostedPaymentPagesClient.RequestOptions`
|
|
5143
5185
|
|
|
5144
5186
|
</dd>
|
|
5145
5187
|
</dl>
|
|
@@ -5215,7 +5257,7 @@ await client.hostedPaymentPages.newPage("8cfec329267", {
|
|
|
5215
5257
|
<dl>
|
|
5216
5258
|
<dd>
|
|
5217
5259
|
|
|
5218
|
-
**requestOptions:** `
|
|
5260
|
+
**requestOptions:** `HostedPaymentPagesClient.RequestOptions`
|
|
5219
5261
|
|
|
5220
5262
|
</dd>
|
|
5221
5263
|
</dl>
|
|
@@ -5294,7 +5336,7 @@ await client.hostedPaymentPages.savePage("8cfec329267", "pay-your-fees-1", {});
|
|
|
5294
5336
|
<dl>
|
|
5295
5337
|
<dd>
|
|
5296
5338
|
|
|
5297
|
-
**requestOptions:** `
|
|
5339
|
+
**requestOptions:** `HostedPaymentPagesClient.RequestOptions`
|
|
5298
5340
|
|
|
5299
5341
|
</dd>
|
|
5300
5342
|
</dl>
|
|
@@ -5368,7 +5410,7 @@ await client.import.importBills("8cfec329267", {
|
|
|
5368
5410
|
<dl>
|
|
5369
5411
|
<dd>
|
|
5370
5412
|
|
|
5371
|
-
**requestOptions:** `
|
|
5413
|
+
**requestOptions:** `ImportClient.RequestOptions`
|
|
5372
5414
|
|
|
5373
5415
|
</dd>
|
|
5374
5416
|
</dl>
|
|
@@ -5441,7 +5483,7 @@ await client.import.importCustomer("8cfec329267", {
|
|
|
5441
5483
|
<dl>
|
|
5442
5484
|
<dd>
|
|
5443
5485
|
|
|
5444
|
-
**requestOptions:** `
|
|
5486
|
+
**requestOptions:** `ImportClient.RequestOptions`
|
|
5445
5487
|
|
|
5446
5488
|
</dd>
|
|
5447
5489
|
</dl>
|
|
@@ -5514,7 +5556,7 @@ await client.import.importVendor("8cfec329267", {
|
|
|
5514
5556
|
<dl>
|
|
5515
5557
|
<dd>
|
|
5516
5558
|
|
|
5517
|
-
**requestOptions:** `
|
|
5559
|
+
**requestOptions:** `ImportClient.RequestOptions`
|
|
5518
5560
|
|
|
5519
5561
|
</dd>
|
|
5520
5562
|
</dl>
|
|
@@ -5615,7 +5657,7 @@ await client.invoice.addInvoice("8cfec329267", {
|
|
|
5615
5657
|
<dl>
|
|
5616
5658
|
<dd>
|
|
5617
5659
|
|
|
5618
|
-
**requestOptions:** `
|
|
5660
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5619
5661
|
|
|
5620
5662
|
</dd>
|
|
5621
5663
|
</dl>
|
|
@@ -5627,7 +5669,7 @@ await client.invoice.addInvoice("8cfec329267", {
|
|
|
5627
5669
|
</dl>
|
|
5628
5670
|
</details>
|
|
5629
5671
|
|
|
5630
|
-
<details><summary><code>client.invoice.<a href="/src/api/resources/invoice/client/Client.ts">deleteAttachedFromInvoice</a>(
|
|
5672
|
+
<details><summary><code>client.invoice.<a href="/src/api/resources/invoice/client/Client.ts">deleteAttachedFromInvoice</a>(idInvoice, filename) -> Payabli.InvoiceResponseWithoutData</code></summary>
|
|
5631
5673
|
<dl>
|
|
5632
5674
|
<dd>
|
|
5633
5675
|
|
|
@@ -5654,7 +5696,7 @@ Deletes an invoice that's attached to a file.
|
|
|
5654
5696
|
<dd>
|
|
5655
5697
|
|
|
5656
5698
|
```typescript
|
|
5657
|
-
await client.invoice.deleteAttachedFromInvoice("0_Bill.pdf"
|
|
5699
|
+
await client.invoice.deleteAttachedFromInvoice(23548884, "0_Bill.pdf");
|
|
5658
5700
|
|
|
5659
5701
|
```
|
|
5660
5702
|
</dd>
|
|
@@ -5670,6 +5712,14 @@ await client.invoice.deleteAttachedFromInvoice("0_Bill.pdf", 23548884);
|
|
|
5670
5712
|
<dl>
|
|
5671
5713
|
<dd>
|
|
5672
5714
|
|
|
5715
|
+
**idInvoice:** `number` — Invoice ID
|
|
5716
|
+
|
|
5717
|
+
</dd>
|
|
5718
|
+
</dl>
|
|
5719
|
+
|
|
5720
|
+
<dl>
|
|
5721
|
+
<dd>
|
|
5722
|
+
|
|
5673
5723
|
**filename:** `string`
|
|
5674
5724
|
|
|
5675
5725
|
The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
|
|
@@ -5690,15 +5740,7 @@ The filename in Payabli. Filename is `zipName` in response to a request to `/api
|
|
|
5690
5740
|
<dl>
|
|
5691
5741
|
<dd>
|
|
5692
5742
|
|
|
5693
|
-
**
|
|
5694
|
-
|
|
5695
|
-
</dd>
|
|
5696
|
-
</dl>
|
|
5697
|
-
|
|
5698
|
-
<dl>
|
|
5699
|
-
<dd>
|
|
5700
|
-
|
|
5701
|
-
**requestOptions:** `Invoice.RequestOptions`
|
|
5743
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5702
5744
|
|
|
5703
5745
|
</dd>
|
|
5704
5746
|
</dl>
|
|
@@ -5761,7 +5803,7 @@ await client.invoice.deleteInvoice(23548884);
|
|
|
5761
5803
|
<dl>
|
|
5762
5804
|
<dd>
|
|
5763
5805
|
|
|
5764
|
-
**requestOptions:** `
|
|
5806
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5765
5807
|
|
|
5766
5808
|
</dd>
|
|
5767
5809
|
</dl>
|
|
@@ -5846,7 +5888,7 @@ await client.invoice.editInvoice(332, {
|
|
|
5846
5888
|
<dl>
|
|
5847
5889
|
<dd>
|
|
5848
5890
|
|
|
5849
|
-
**requestOptions:** `
|
|
5891
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5850
5892
|
|
|
5851
5893
|
</dd>
|
|
5852
5894
|
</dl>
|
|
@@ -5858,7 +5900,7 @@ await client.invoice.editInvoice(332, {
|
|
|
5858
5900
|
</dl>
|
|
5859
5901
|
</details>
|
|
5860
5902
|
|
|
5861
|
-
<details><summary><code>client.invoice.<a href="/src/api/resources/invoice/client/Client.ts">getAttachedFileFromInvoice</a>(
|
|
5903
|
+
<details><summary><code>client.invoice.<a href="/src/api/resources/invoice/client/Client.ts">getAttachedFileFromInvoice</a>(idInvoice, filename, { ...params }) -> Payabli.FileContent</code></summary>
|
|
5862
5904
|
<dl>
|
|
5863
5905
|
<dd>
|
|
5864
5906
|
|
|
@@ -5885,7 +5927,7 @@ Retrieves a file attached to an invoice.
|
|
|
5885
5927
|
<dd>
|
|
5886
5928
|
|
|
5887
5929
|
```typescript
|
|
5888
|
-
await client.invoice.getAttachedFileFromInvoice("filename"
|
|
5930
|
+
await client.invoice.getAttachedFileFromInvoice(1, "filename");
|
|
5889
5931
|
|
|
5890
5932
|
```
|
|
5891
5933
|
</dd>
|
|
@@ -5901,6 +5943,14 @@ await client.invoice.getAttachedFileFromInvoice("filename", 1);
|
|
|
5901
5943
|
<dl>
|
|
5902
5944
|
<dd>
|
|
5903
5945
|
|
|
5946
|
+
**idInvoice:** `number` — Invoice ID
|
|
5947
|
+
|
|
5948
|
+
</dd>
|
|
5949
|
+
</dl>
|
|
5950
|
+
|
|
5951
|
+
<dl>
|
|
5952
|
+
<dd>
|
|
5953
|
+
|
|
5904
5954
|
**filename:** `string`
|
|
5905
5955
|
|
|
5906
5956
|
The filename in Payabli. Filename is `zipName` in the response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
|
|
@@ -5923,14 +5973,6 @@ The filename in Payabli. Filename is `zipName` in the response to a request to `
|
|
|
5923
5973
|
<dl>
|
|
5924
5974
|
<dd>
|
|
5925
5975
|
|
|
5926
|
-
**idInvoice:** `number` — Invoice ID
|
|
5927
|
-
|
|
5928
|
-
</dd>
|
|
5929
|
-
</dl>
|
|
5930
|
-
|
|
5931
|
-
<dl>
|
|
5932
|
-
<dd>
|
|
5933
|
-
|
|
5934
5976
|
**request:** `Payabli.GetAttachedFileFromInvoiceRequest`
|
|
5935
5977
|
|
|
5936
5978
|
</dd>
|
|
@@ -5939,7 +5981,7 @@ The filename in Payabli. Filename is `zipName` in the response to a request to `
|
|
|
5939
5981
|
<dl>
|
|
5940
5982
|
<dd>
|
|
5941
5983
|
|
|
5942
|
-
**requestOptions:** `
|
|
5984
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
5943
5985
|
|
|
5944
5986
|
</dd>
|
|
5945
5987
|
</dl>
|
|
@@ -6002,7 +6044,7 @@ await client.invoice.getInvoice(23548884);
|
|
|
6002
6044
|
<dl>
|
|
6003
6045
|
<dd>
|
|
6004
6046
|
|
|
6005
|
-
**requestOptions:** `
|
|
6047
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6006
6048
|
|
|
6007
6049
|
</dd>
|
|
6008
6050
|
</dl>
|
|
@@ -6065,7 +6107,7 @@ await client.invoice.getInvoiceNumber("8cfec329267");
|
|
|
6065
6107
|
<dl>
|
|
6066
6108
|
<dd>
|
|
6067
6109
|
|
|
6068
|
-
**requestOptions:** `
|
|
6110
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6069
6111
|
|
|
6070
6112
|
</dd>
|
|
6071
6113
|
</dl>
|
|
@@ -6140,7 +6182,7 @@ await client.invoice.listInvoices("8cfec329267", {
|
|
|
6140
6182
|
<dl>
|
|
6141
6183
|
<dd>
|
|
6142
6184
|
|
|
6143
|
-
**requestOptions:** `
|
|
6185
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6144
6186
|
|
|
6145
6187
|
</dd>
|
|
6146
6188
|
</dl>
|
|
@@ -6215,7 +6257,7 @@ await client.invoice.listInvoicesOrg(123, {
|
|
|
6215
6257
|
<dl>
|
|
6216
6258
|
<dd>
|
|
6217
6259
|
|
|
6218
|
-
**requestOptions:** `
|
|
6260
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6219
6261
|
|
|
6220
6262
|
</dd>
|
|
6221
6263
|
</dl>
|
|
@@ -6289,7 +6331,7 @@ await client.invoice.sendInvoice(23548884, {
|
|
|
6289
6331
|
<dl>
|
|
6290
6332
|
<dd>
|
|
6291
6333
|
|
|
6292
|
-
**requestOptions:** `
|
|
6334
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6293
6335
|
|
|
6294
6336
|
</dd>
|
|
6295
6337
|
</dl>
|
|
@@ -6352,7 +6394,7 @@ await client.invoice.getInvoicePdf(23548884);
|
|
|
6352
6394
|
<dl>
|
|
6353
6395
|
<dd>
|
|
6354
6396
|
|
|
6355
|
-
**requestOptions:** `
|
|
6397
|
+
**requestOptions:** `InvoiceClient.RequestOptions`
|
|
6356
6398
|
|
|
6357
6399
|
</dd>
|
|
6358
6400
|
</dl>
|
|
@@ -6435,7 +6477,7 @@ await client.lineItem.addItem("47cae3d74", {
|
|
|
6435
6477
|
<dl>
|
|
6436
6478
|
<dd>
|
|
6437
6479
|
|
|
6438
|
-
**requestOptions:** `
|
|
6480
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6439
6481
|
|
|
6440
6482
|
</dd>
|
|
6441
6483
|
</dl>
|
|
@@ -6498,7 +6540,7 @@ await client.lineItem.deleteItem(700);
|
|
|
6498
6540
|
<dl>
|
|
6499
6541
|
<dd>
|
|
6500
6542
|
|
|
6501
|
-
**requestOptions:** `
|
|
6543
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6502
6544
|
|
|
6503
6545
|
</dd>
|
|
6504
6546
|
</dl>
|
|
@@ -6561,7 +6603,7 @@ await client.lineItem.getItem(700);
|
|
|
6561
6603
|
<dl>
|
|
6562
6604
|
<dd>
|
|
6563
6605
|
|
|
6564
|
-
**requestOptions:** `
|
|
6606
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6565
6607
|
|
|
6566
6608
|
</dd>
|
|
6567
6609
|
</dl>
|
|
@@ -6636,7 +6678,7 @@ await client.lineItem.listLineItems("8cfec329267", {
|
|
|
6636
6678
|
<dl>
|
|
6637
6679
|
<dd>
|
|
6638
6680
|
|
|
6639
|
-
**requestOptions:** `
|
|
6681
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6640
6682
|
|
|
6641
6683
|
</dd>
|
|
6642
6684
|
</dl>
|
|
@@ -6710,7 +6752,7 @@ await client.lineItem.updateItem(700, {
|
|
|
6710
6752
|
<dl>
|
|
6711
6753
|
<dd>
|
|
6712
6754
|
|
|
6713
|
-
**requestOptions:** `
|
|
6755
|
+
**requestOptions:** `LineItemClient.RequestOptions`
|
|
6714
6756
|
|
|
6715
6757
|
</dd>
|
|
6716
6758
|
</dl>
|
|
@@ -6797,7 +6839,7 @@ await client.moneyIn.authorize({
|
|
|
6797
6839
|
<dl>
|
|
6798
6840
|
<dd>
|
|
6799
6841
|
|
|
6800
|
-
**requestOptions:** `
|
|
6842
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
6801
6843
|
|
|
6802
6844
|
</dd>
|
|
6803
6845
|
</dl>
|
|
@@ -6809,7 +6851,7 @@ await client.moneyIn.authorize({
|
|
|
6809
6851
|
</dl>
|
|
6810
6852
|
</details>
|
|
6811
6853
|
|
|
6812
|
-
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">capture</a>(
|
|
6854
|
+
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">capture</a>(transId, amount) -> Payabli.CaptureResponse</code></summary>
|
|
6813
6855
|
<dl>
|
|
6814
6856
|
<dd>
|
|
6815
6857
|
|
|
@@ -6841,7 +6883,7 @@ transaction](/api-reference/moneyin/authorize-a-transaction) to complete the tra
|
|
|
6841
6883
|
<dd>
|
|
6842
6884
|
|
|
6843
6885
|
```typescript
|
|
6844
|
-
await client.moneyIn.capture(
|
|
6886
|
+
await client.moneyIn.capture("10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13", 0);
|
|
6845
6887
|
|
|
6846
6888
|
```
|
|
6847
6889
|
</dd>
|
|
@@ -6857,7 +6899,7 @@ await client.moneyIn.capture(0, "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13");
|
|
|
6857
6899
|
<dl>
|
|
6858
6900
|
<dd>
|
|
6859
6901
|
|
|
6860
|
-
**
|
|
6902
|
+
**transId:** `string` — ReferenceId for the transaction (PaymentId).
|
|
6861
6903
|
|
|
6862
6904
|
</dd>
|
|
6863
6905
|
</dl>
|
|
@@ -6865,7 +6907,7 @@ await client.moneyIn.capture(0, "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13");
|
|
|
6865
6907
|
<dl>
|
|
6866
6908
|
<dd>
|
|
6867
6909
|
|
|
6868
|
-
**
|
|
6910
|
+
**amount:** `number` — Amount to be captured. The amount can't be greater the original total amount of the transaction. `0` captures the total amount authorized in the transaction. Partial captures aren't supported.
|
|
6869
6911
|
|
|
6870
6912
|
</dd>
|
|
6871
6913
|
</dl>
|
|
@@ -6873,7 +6915,7 @@ await client.moneyIn.capture(0, "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13");
|
|
|
6873
6915
|
<dl>
|
|
6874
6916
|
<dd>
|
|
6875
6917
|
|
|
6876
|
-
**requestOptions:** `
|
|
6918
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
6877
6919
|
|
|
6878
6920
|
</dd>
|
|
6879
6921
|
</dl>
|
|
@@ -6951,7 +6993,7 @@ await client.moneyIn.captureAuth("10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13", {
|
|
|
6951
6993
|
<dl>
|
|
6952
6994
|
<dd>
|
|
6953
6995
|
|
|
6954
|
-
**requestOptions:** `
|
|
6996
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
6955
6997
|
|
|
6956
6998
|
</dd>
|
|
6957
6999
|
</dl>
|
|
@@ -7034,7 +7076,7 @@ await client.moneyIn.credit({
|
|
|
7034
7076
|
<dl>
|
|
7035
7077
|
<dd>
|
|
7036
7078
|
|
|
7037
|
-
**requestOptions:** `
|
|
7079
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7038
7080
|
|
|
7039
7081
|
</dd>
|
|
7040
7082
|
</dl>
|
|
@@ -7097,7 +7139,7 @@ await client.moneyIn.details("45-as456777hhhhhhhhhh77777777-324");
|
|
|
7097
7139
|
<dl>
|
|
7098
7140
|
<dd>
|
|
7099
7141
|
|
|
7100
|
-
**requestOptions:** `
|
|
7142
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7101
7143
|
|
|
7102
7144
|
</dd>
|
|
7103
7145
|
</dl>
|
|
@@ -7181,7 +7223,7 @@ await client.moneyIn.getpaid({
|
|
|
7181
7223
|
<dl>
|
|
7182
7224
|
<dd>
|
|
7183
7225
|
|
|
7184
|
-
**requestOptions:** `
|
|
7226
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7185
7227
|
|
|
7186
7228
|
</dd>
|
|
7187
7229
|
</dl>
|
|
@@ -7193,7 +7235,7 @@ await client.moneyIn.getpaid({
|
|
|
7193
7235
|
</dl>
|
|
7194
7236
|
</details>
|
|
7195
7237
|
|
|
7196
|
-
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">reverse</a>(
|
|
7238
|
+
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">reverse</a>(transId, amount) -> Payabli.ReverseResponse</code></summary>
|
|
7197
7239
|
<dl>
|
|
7198
7240
|
<dd>
|
|
7199
7241
|
|
|
@@ -7220,7 +7262,7 @@ A reversal either refunds or voids a transaction independent of the transaction'
|
|
|
7220
7262
|
<dd>
|
|
7221
7263
|
|
|
7222
7264
|
```typescript
|
|
7223
|
-
await client.moneyIn.reverse(
|
|
7265
|
+
await client.moneyIn.reverse("10-3ffa27df-b171-44e0-b251-e95fbfc7a723", 0);
|
|
7224
7266
|
|
|
7225
7267
|
```
|
|
7226
7268
|
</dd>
|
|
@@ -7236,6 +7278,14 @@ await client.moneyIn.reverse(0, "10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
|
|
|
7236
7278
|
<dl>
|
|
7237
7279
|
<dd>
|
|
7238
7280
|
|
|
7281
|
+
**transId:** `string` — ReferenceId for the transaction (PaymentId).
|
|
7282
|
+
|
|
7283
|
+
</dd>
|
|
7284
|
+
</dl>
|
|
7285
|
+
|
|
7286
|
+
<dl>
|
|
7287
|
+
<dd>
|
|
7288
|
+
|
|
7239
7289
|
**amount:** `number`
|
|
7240
7290
|
|
|
7241
7291
|
|
|
@@ -7251,15 +7301,7 @@ An amount equal to zero will refunds the total amount authorized minus any servi
|
|
|
7251
7301
|
<dl>
|
|
7252
7302
|
<dd>
|
|
7253
7303
|
|
|
7254
|
-
**
|
|
7255
|
-
|
|
7256
|
-
</dd>
|
|
7257
|
-
</dl>
|
|
7258
|
-
|
|
7259
|
-
<dl>
|
|
7260
|
-
<dd>
|
|
7261
|
-
|
|
7262
|
-
**requestOptions:** `MoneyIn.RequestOptions`
|
|
7304
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7263
7305
|
|
|
7264
7306
|
</dd>
|
|
7265
7307
|
</dl>
|
|
@@ -7271,7 +7313,7 @@ An amount equal to zero will refunds the total amount authorized minus any servi
|
|
|
7271
7313
|
</dl>
|
|
7272
7314
|
</details>
|
|
7273
7315
|
|
|
7274
|
-
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">refund</a>(
|
|
7316
|
+
<details><summary><code>client.moneyIn.<a href="/src/api/resources/moneyIn/client/Client.ts">refund</a>(transId, amount) -> Payabli.RefundResponse</code></summary>
|
|
7275
7317
|
<dl>
|
|
7276
7318
|
<dd>
|
|
7277
7319
|
|
|
@@ -7298,7 +7340,7 @@ Refund a transaction that has settled and send money back to the account holder.
|
|
|
7298
7340
|
<dd>
|
|
7299
7341
|
|
|
7300
7342
|
```typescript
|
|
7301
|
-
await client.moneyIn.refund(
|
|
7343
|
+
await client.moneyIn.refund("10-3ffa27df-b171-44e0-b251-e95fbfc7a723", 0);
|
|
7302
7344
|
|
|
7303
7345
|
```
|
|
7304
7346
|
</dd>
|
|
@@ -7314,6 +7356,14 @@ await client.moneyIn.refund(0, "10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
|
|
|
7314
7356
|
<dl>
|
|
7315
7357
|
<dd>
|
|
7316
7358
|
|
|
7359
|
+
**transId:** `string` — ReferenceId for the transaction (PaymentId).
|
|
7360
|
+
|
|
7361
|
+
</dd>
|
|
7362
|
+
</dl>
|
|
7363
|
+
|
|
7364
|
+
<dl>
|
|
7365
|
+
<dd>
|
|
7366
|
+
|
|
7317
7367
|
**amount:** `number`
|
|
7318
7368
|
|
|
7319
7369
|
|
|
@@ -7329,15 +7379,7 @@ An amount equal to zero will refund the total amount authorized minus any servic
|
|
|
7329
7379
|
<dl>
|
|
7330
7380
|
<dd>
|
|
7331
7381
|
|
|
7332
|
-
**
|
|
7333
|
-
|
|
7334
|
-
</dd>
|
|
7335
|
-
</dl>
|
|
7336
|
-
|
|
7337
|
-
<dl>
|
|
7338
|
-
<dd>
|
|
7339
|
-
|
|
7340
|
-
**requestOptions:** `MoneyIn.RequestOptions`
|
|
7382
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7341
7383
|
|
|
7342
7384
|
</dd>
|
|
7343
7385
|
</dl>
|
|
@@ -7426,7 +7468,7 @@ await client.moneyIn.refundWithInstructions("10-3ffa27df-b171-44e0-b251-e95fbfc7
|
|
|
7426
7468
|
<dl>
|
|
7427
7469
|
<dd>
|
|
7428
7470
|
|
|
7429
|
-
**requestOptions:** `
|
|
7471
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7430
7472
|
|
|
7431
7473
|
</dd>
|
|
7432
7474
|
</dl>
|
|
@@ -7489,7 +7531,7 @@ await client.moneyIn.reverseCredit("45-as456777hhhhhhhhhh77777777-324");
|
|
|
7489
7531
|
<dl>
|
|
7490
7532
|
<dd>
|
|
7491
7533
|
|
|
7492
|
-
**requestOptions:** `
|
|
7534
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7493
7535
|
|
|
7494
7536
|
</dd>
|
|
7495
7537
|
</dl>
|
|
@@ -7562,7 +7604,7 @@ await client.moneyIn.sendReceipt2Trans("45-as456777hhhhhhhhhh77777777-324", {
|
|
|
7562
7604
|
<dl>
|
|
7563
7605
|
<dd>
|
|
7564
7606
|
|
|
7565
|
-
**requestOptions:** `
|
|
7607
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7566
7608
|
|
|
7567
7609
|
</dd>
|
|
7568
7610
|
</dl>
|
|
@@ -7635,7 +7677,7 @@ await client.moneyIn.validate({
|
|
|
7635
7677
|
<dl>
|
|
7636
7678
|
<dd>
|
|
7637
7679
|
|
|
7638
|
-
**requestOptions:** `
|
|
7680
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7639
7681
|
|
|
7640
7682
|
</dd>
|
|
7641
7683
|
</dl>
|
|
@@ -7698,7 +7740,7 @@ await client.moneyIn.void("10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
|
|
|
7698
7740
|
<dl>
|
|
7699
7741
|
<dd>
|
|
7700
7742
|
|
|
7701
|
-
**requestOptions:** `
|
|
7743
|
+
**requestOptions:** `MoneyInClient.RequestOptions`
|
|
7702
7744
|
|
|
7703
7745
|
</dd>
|
|
7704
7746
|
</dl>
|
|
@@ -7746,7 +7788,8 @@ await client.moneyOut.authorizeOut({
|
|
|
7746
7788
|
}],
|
|
7747
7789
|
orderDescription: "Window Painting",
|
|
7748
7790
|
paymentDetails: {
|
|
7749
|
-
totalAmount: 47
|
|
7791
|
+
totalAmount: 47,
|
|
7792
|
+
unbundled: false
|
|
7750
7793
|
},
|
|
7751
7794
|
paymentMethod: {
|
|
7752
7795
|
method: "managed"
|
|
@@ -7779,7 +7822,7 @@ await client.moneyOut.authorizeOut({
|
|
|
7779
7822
|
<dl>
|
|
7780
7823
|
<dd>
|
|
7781
7824
|
|
|
7782
|
-
**requestOptions:** `
|
|
7825
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
7783
7826
|
|
|
7784
7827
|
</dd>
|
|
7785
7828
|
</dl>
|
|
@@ -7842,7 +7885,7 @@ await client.moneyOut.cancelAllOut(["2-29", "2-28", "2-27"]);
|
|
|
7842
7885
|
<dl>
|
|
7843
7886
|
<dd>
|
|
7844
7887
|
|
|
7845
|
-
**requestOptions:** `
|
|
7888
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
7846
7889
|
|
|
7847
7890
|
</dd>
|
|
7848
7891
|
</dl>
|
|
@@ -7854,7 +7897,7 @@ await client.moneyOut.cancelAllOut(["2-29", "2-28", "2-27"]);
|
|
|
7854
7897
|
</dl>
|
|
7855
7898
|
</details>
|
|
7856
7899
|
|
|
7857
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
7900
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">cancelOutGet</a>(referenceId) -> Payabli.PayabliApiResponse0000</code></summary>
|
|
7858
7901
|
<dl>
|
|
7859
7902
|
<dd>
|
|
7860
7903
|
|
|
@@ -7881,7 +7924,7 @@ Cancel a payout transaction by ID.
|
|
|
7881
7924
|
<dd>
|
|
7882
7925
|
|
|
7883
7926
|
```typescript
|
|
7884
|
-
await client.moneyOut.
|
|
7927
|
+
await client.moneyOut.cancelOutGet("129-219");
|
|
7885
7928
|
|
|
7886
7929
|
```
|
|
7887
7930
|
</dd>
|
|
@@ -7905,7 +7948,7 @@ await client.moneyOut.cancelOut("129-219");
|
|
|
7905
7948
|
<dl>
|
|
7906
7949
|
<dd>
|
|
7907
7950
|
|
|
7908
|
-
**requestOptions:** `
|
|
7951
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
7909
7952
|
|
|
7910
7953
|
</dd>
|
|
7911
7954
|
</dl>
|
|
@@ -7917,7 +7960,7 @@ await client.moneyOut.cancelOut("129-219");
|
|
|
7917
7960
|
</dl>
|
|
7918
7961
|
</details>
|
|
7919
7962
|
|
|
7920
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
7963
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">cancelOutDelete</a>(referenceId) -> Payabli.PayabliApiResponse0000</code></summary>
|
|
7921
7964
|
<dl>
|
|
7922
7965
|
<dd>
|
|
7923
7966
|
|
|
@@ -7929,7 +7972,7 @@ await client.moneyOut.cancelOut("129-219");
|
|
|
7929
7972
|
<dl>
|
|
7930
7973
|
<dd>
|
|
7931
7974
|
|
|
7932
|
-
|
|
7975
|
+
Cancel a payout transaction by ID.
|
|
7933
7976
|
</dd>
|
|
7934
7977
|
</dl>
|
|
7935
7978
|
</dd>
|
|
@@ -7944,9 +7987,7 @@ Captures an array of authorized payout transactions for settlement. The maximum
|
|
|
7944
7987
|
<dd>
|
|
7945
7988
|
|
|
7946
7989
|
```typescript
|
|
7947
|
-
await client.moneyOut.
|
|
7948
|
-
body: ["2-29", "2-28", "2-27"]
|
|
7949
|
-
});
|
|
7990
|
+
await client.moneyOut.cancelOutDelete("129-219");
|
|
7950
7991
|
|
|
7951
7992
|
```
|
|
7952
7993
|
</dd>
|
|
@@ -7962,7 +8003,7 @@ await client.moneyOut.captureAllOut({
|
|
|
7962
8003
|
<dl>
|
|
7963
8004
|
<dd>
|
|
7964
8005
|
|
|
7965
|
-
**
|
|
8006
|
+
**referenceId:** `string` — The ID for the payout transaction.
|
|
7966
8007
|
|
|
7967
8008
|
</dd>
|
|
7968
8009
|
</dl>
|
|
@@ -7970,7 +8011,7 @@ await client.moneyOut.captureAllOut({
|
|
|
7970
8011
|
<dl>
|
|
7971
8012
|
<dd>
|
|
7972
8013
|
|
|
7973
|
-
**requestOptions:** `
|
|
8014
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
7974
8015
|
|
|
7975
8016
|
</dd>
|
|
7976
8017
|
</dl>
|
|
@@ -7982,7 +8023,7 @@ await client.moneyOut.captureAllOut({
|
|
|
7982
8023
|
</dl>
|
|
7983
8024
|
</details>
|
|
7984
8025
|
|
|
7985
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
8026
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">captureAllOut</a>({ ...params }) -> Payabli.CaptureAllOutResponse</code></summary>
|
|
7986
8027
|
<dl>
|
|
7987
8028
|
<dd>
|
|
7988
8029
|
|
|
@@ -7994,7 +8035,7 @@ await client.moneyOut.captureAllOut({
|
|
|
7994
8035
|
<dl>
|
|
7995
8036
|
<dd>
|
|
7996
8037
|
|
|
7997
|
-
Captures
|
|
8038
|
+
Captures an array of authorized payout transactions for settlement. The maximum number of transactions that can be captured in a single request is 500.
|
|
7998
8039
|
</dd>
|
|
7999
8040
|
</dl>
|
|
8000
8041
|
</dd>
|
|
@@ -8009,7 +8050,9 @@ Captures a single authorized payout transaction by ID.
|
|
|
8009
8050
|
<dd>
|
|
8010
8051
|
|
|
8011
8052
|
```typescript
|
|
8012
|
-
await client.moneyOut.
|
|
8053
|
+
await client.moneyOut.captureAllOut({
|
|
8054
|
+
body: ["2-29", "2-28", "2-27"]
|
|
8055
|
+
});
|
|
8013
8056
|
|
|
8014
8057
|
```
|
|
8015
8058
|
</dd>
|
|
@@ -8025,15 +8068,7 @@ await client.moneyOut.captureOut("129-219");
|
|
|
8025
8068
|
<dl>
|
|
8026
8069
|
<dd>
|
|
8027
8070
|
|
|
8028
|
-
**
|
|
8029
|
-
|
|
8030
|
-
</dd>
|
|
8031
|
-
</dl>
|
|
8032
|
-
|
|
8033
|
-
<dl>
|
|
8034
|
-
<dd>
|
|
8035
|
-
|
|
8036
|
-
**request:** `Payabli.CaptureOutRequest`
|
|
8071
|
+
**request:** `Payabli.CaptureAllOutRequest`
|
|
8037
8072
|
|
|
8038
8073
|
</dd>
|
|
8039
8074
|
</dl>
|
|
@@ -8041,7 +8076,7 @@ await client.moneyOut.captureOut("129-219");
|
|
|
8041
8076
|
<dl>
|
|
8042
8077
|
<dd>
|
|
8043
8078
|
|
|
8044
|
-
**requestOptions:** `
|
|
8079
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8045
8080
|
|
|
8046
8081
|
</dd>
|
|
8047
8082
|
</dl>
|
|
@@ -8053,7 +8088,7 @@ await client.moneyOut.captureOut("129-219");
|
|
|
8053
8088
|
</dl>
|
|
8054
8089
|
</details>
|
|
8055
8090
|
|
|
8056
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
8091
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">captureOut</a>(referenceId, { ...params }) -> Payabli.AuthCapturePayoutResponse</code></summary>
|
|
8057
8092
|
<dl>
|
|
8058
8093
|
<dd>
|
|
8059
8094
|
|
|
@@ -8065,7 +8100,7 @@ await client.moneyOut.captureOut("129-219");
|
|
|
8065
8100
|
<dl>
|
|
8066
8101
|
<dd>
|
|
8067
8102
|
|
|
8068
|
-
|
|
8103
|
+
Captures a single authorized payout transaction by ID.
|
|
8069
8104
|
</dd>
|
|
8070
8105
|
</dl>
|
|
8071
8106
|
</dd>
|
|
@@ -8080,7 +8115,7 @@ Returns details for a processed money out transaction.
|
|
|
8080
8115
|
<dd>
|
|
8081
8116
|
|
|
8082
8117
|
```typescript
|
|
8083
|
-
await client.moneyOut.
|
|
8118
|
+
await client.moneyOut.captureOut("129-219");
|
|
8084
8119
|
|
|
8085
8120
|
```
|
|
8086
8121
|
</dd>
|
|
@@ -8096,7 +8131,15 @@ await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
|
8096
8131
|
<dl>
|
|
8097
8132
|
<dd>
|
|
8098
8133
|
|
|
8099
|
-
**
|
|
8134
|
+
**referenceId:** `string` — The ID for the payout transaction.
|
|
8135
|
+
|
|
8136
|
+
</dd>
|
|
8137
|
+
</dl>
|
|
8138
|
+
|
|
8139
|
+
<dl>
|
|
8140
|
+
<dd>
|
|
8141
|
+
|
|
8142
|
+
**request:** `Payabli.CaptureOutRequest`
|
|
8100
8143
|
|
|
8101
8144
|
</dd>
|
|
8102
8145
|
</dl>
|
|
@@ -8104,7 +8147,7 @@ await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
|
8104
8147
|
<dl>
|
|
8105
8148
|
<dd>
|
|
8106
8149
|
|
|
8107
|
-
**requestOptions:** `
|
|
8150
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8108
8151
|
|
|
8109
8152
|
</dd>
|
|
8110
8153
|
</dl>
|
|
@@ -8116,7 +8159,7 @@ await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
|
8116
8159
|
</dl>
|
|
8117
8160
|
</details>
|
|
8118
8161
|
|
|
8119
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
8162
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">payoutDetails</a>(transId) -> Payabli.BillDetailResponse</code></summary>
|
|
8120
8163
|
<dl>
|
|
8121
8164
|
<dd>
|
|
8122
8165
|
|
|
@@ -8128,7 +8171,7 @@ await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
|
8128
8171
|
<dl>
|
|
8129
8172
|
<dd>
|
|
8130
8173
|
|
|
8131
|
-
|
|
8174
|
+
Returns details for a processed money out transaction.
|
|
8132
8175
|
</dd>
|
|
8133
8176
|
</dl>
|
|
8134
8177
|
</dd>
|
|
@@ -8143,7 +8186,7 @@ Retrieves vCard details for a single card in an entrypoint.
|
|
|
8143
8186
|
<dd>
|
|
8144
8187
|
|
|
8145
8188
|
```typescript
|
|
8146
|
-
await client.moneyOut.
|
|
8189
|
+
await client.moneyOut.payoutDetails("45-as456777hhhhhhhhhh77777777-324");
|
|
8147
8190
|
|
|
8148
8191
|
```
|
|
8149
8192
|
</dd>
|
|
@@ -8159,7 +8202,7 @@ await client.moneyOut.vCardGet("20230403315245421165");
|
|
|
8159
8202
|
<dl>
|
|
8160
8203
|
<dd>
|
|
8161
8204
|
|
|
8162
|
-
**
|
|
8205
|
+
**transId:** `string` — ReferenceId for the transaction (PaymentId).
|
|
8163
8206
|
|
|
8164
8207
|
</dd>
|
|
8165
8208
|
</dl>
|
|
@@ -8167,7 +8210,7 @@ await client.moneyOut.vCardGet("20230403315245421165");
|
|
|
8167
8210
|
<dl>
|
|
8168
8211
|
<dd>
|
|
8169
8212
|
|
|
8170
|
-
**requestOptions:** `
|
|
8213
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8171
8214
|
|
|
8172
8215
|
</dd>
|
|
8173
8216
|
</dl>
|
|
@@ -8179,7 +8222,70 @@ await client.moneyOut.vCardGet("20230403315245421165");
|
|
|
8179
8222
|
</dl>
|
|
8180
8223
|
</details>
|
|
8181
8224
|
|
|
8182
|
-
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">
|
|
8225
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">vCardGet</a>(cardToken) -> Payabli.VCardGetResponse</code></summary>
|
|
8226
|
+
<dl>
|
|
8227
|
+
<dd>
|
|
8228
|
+
|
|
8229
|
+
#### 📝 Description
|
|
8230
|
+
|
|
8231
|
+
<dl>
|
|
8232
|
+
<dd>
|
|
8233
|
+
|
|
8234
|
+
<dl>
|
|
8235
|
+
<dd>
|
|
8236
|
+
|
|
8237
|
+
Retrieves vCard details for a single card in an entrypoint.
|
|
8238
|
+
</dd>
|
|
8239
|
+
</dl>
|
|
8240
|
+
</dd>
|
|
8241
|
+
</dl>
|
|
8242
|
+
|
|
8243
|
+
#### 🔌 Usage
|
|
8244
|
+
|
|
8245
|
+
<dl>
|
|
8246
|
+
<dd>
|
|
8247
|
+
|
|
8248
|
+
<dl>
|
|
8249
|
+
<dd>
|
|
8250
|
+
|
|
8251
|
+
```typescript
|
|
8252
|
+
await client.moneyOut.vCardGet("20230403315245421165");
|
|
8253
|
+
|
|
8254
|
+
```
|
|
8255
|
+
</dd>
|
|
8256
|
+
</dl>
|
|
8257
|
+
</dd>
|
|
8258
|
+
</dl>
|
|
8259
|
+
|
|
8260
|
+
#### ⚙️ Parameters
|
|
8261
|
+
|
|
8262
|
+
<dl>
|
|
8263
|
+
<dd>
|
|
8264
|
+
|
|
8265
|
+
<dl>
|
|
8266
|
+
<dd>
|
|
8267
|
+
|
|
8268
|
+
**cardToken:** `string` — ID for a virtual card.
|
|
8269
|
+
|
|
8270
|
+
</dd>
|
|
8271
|
+
</dl>
|
|
8272
|
+
|
|
8273
|
+
<dl>
|
|
8274
|
+
<dd>
|
|
8275
|
+
|
|
8276
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8277
|
+
|
|
8278
|
+
</dd>
|
|
8279
|
+
</dl>
|
|
8280
|
+
</dd>
|
|
8281
|
+
</dl>
|
|
8282
|
+
|
|
8283
|
+
|
|
8284
|
+
</dd>
|
|
8285
|
+
</dl>
|
|
8286
|
+
</details>
|
|
8287
|
+
|
|
8288
|
+
<details><summary><code>client.moneyOut.<a href="/src/api/resources/moneyOut/client/Client.ts">sendVCardLink</a>({ ...params }) -> Payabli.OperationResult</code></summary>
|
|
8183
8289
|
<dl>
|
|
8184
8290
|
<dd>
|
|
8185
8291
|
|
|
@@ -8232,7 +8338,7 @@ await client.moneyOut.sendVCardLink({
|
|
|
8232
8338
|
<dl>
|
|
8233
8339
|
<dd>
|
|
8234
8340
|
|
|
8235
|
-
**requestOptions:** `
|
|
8341
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8236
8342
|
|
|
8237
8343
|
</dd>
|
|
8238
8344
|
</dl>
|
|
@@ -8308,7 +8414,7 @@ in the response when you make a GET request to `/MoneyOut/details/{transId}`.
|
|
|
8308
8414
|
<dl>
|
|
8309
8415
|
<dd>
|
|
8310
8416
|
|
|
8311
|
-
**requestOptions:** `
|
|
8417
|
+
**requestOptions:** `MoneyOutClient.RequestOptions`
|
|
8312
8418
|
|
|
8313
8419
|
</dd>
|
|
8314
8420
|
</dl>
|
|
@@ -8382,7 +8488,7 @@ await client.notification.addNotification({
|
|
|
8382
8488
|
<dl>
|
|
8383
8489
|
<dd>
|
|
8384
8490
|
|
|
8385
|
-
**requestOptions:** `
|
|
8491
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8386
8492
|
|
|
8387
8493
|
</dd>
|
|
8388
8494
|
</dl>
|
|
@@ -8445,7 +8551,7 @@ await client.notification.deleteNotification("1717");
|
|
|
8445
8551
|
<dl>
|
|
8446
8552
|
<dd>
|
|
8447
8553
|
|
|
8448
|
-
**requestOptions:** `
|
|
8554
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8449
8555
|
|
|
8450
8556
|
</dd>
|
|
8451
8557
|
</dl>
|
|
@@ -8508,7 +8614,7 @@ await client.notification.getNotification("1717");
|
|
|
8508
8614
|
<dl>
|
|
8509
8615
|
<dd>
|
|
8510
8616
|
|
|
8511
|
-
**requestOptions:** `
|
|
8617
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8512
8618
|
|
|
8513
8619
|
</dd>
|
|
8514
8620
|
</dl>
|
|
@@ -8589,7 +8695,7 @@ await client.notification.updateNotification("1717", {
|
|
|
8589
8695
|
<dl>
|
|
8590
8696
|
<dd>
|
|
8591
8697
|
|
|
8592
|
-
**requestOptions:** `
|
|
8698
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8593
8699
|
|
|
8594
8700
|
</dd>
|
|
8595
8701
|
</dl>
|
|
@@ -8601,7 +8707,7 @@ await client.notification.updateNotification("1717", {
|
|
|
8601
8707
|
</dl>
|
|
8602
8708
|
</details>
|
|
8603
8709
|
|
|
8604
|
-
<details><summary><code>client.notification.<a href="/src/api/resources/notification/client/Client.ts">getReportFile</a>(
|
|
8710
|
+
<details><summary><code>client.notification.<a href="/src/api/resources/notification/client/Client.ts">getReportFile</a>(Id) -> Payabli.File_</code></summary>
|
|
8605
8711
|
<dl>
|
|
8606
8712
|
<dd>
|
|
8607
8713
|
|
|
@@ -8644,7 +8750,7 @@ await client.notification.getReportFile(1000000);
|
|
|
8644
8750
|
<dl>
|
|
8645
8751
|
<dd>
|
|
8646
8752
|
|
|
8647
|
-
**
|
|
8753
|
+
**Id:** `number` — Report ID
|
|
8648
8754
|
|
|
8649
8755
|
</dd>
|
|
8650
8756
|
</dl>
|
|
@@ -8652,7 +8758,7 @@ await client.notification.getReportFile(1000000);
|
|
|
8652
8758
|
<dl>
|
|
8653
8759
|
<dd>
|
|
8654
8760
|
|
|
8655
|
-
**requestOptions:** `
|
|
8761
|
+
**requestOptions:** `NotificationClient.RequestOptions`
|
|
8656
8762
|
|
|
8657
8763
|
</dd>
|
|
8658
8764
|
</dl>
|
|
@@ -8729,7 +8835,7 @@ await client.notificationlogs.searchNotificationLogs({
|
|
|
8729
8835
|
<dl>
|
|
8730
8836
|
<dd>
|
|
8731
8837
|
|
|
8732
|
-
**requestOptions:** `
|
|
8838
|
+
**requestOptions:** `NotificationlogsClient.RequestOptions`
|
|
8733
8839
|
|
|
8734
8840
|
</dd>
|
|
8735
8841
|
</dl>
|
|
@@ -8793,7 +8899,7 @@ await client.notificationlogs.getNotificationLog("550e8400-e29b-41d4-a716-446655
|
|
|
8793
8899
|
<dl>
|
|
8794
8900
|
<dd>
|
|
8795
8901
|
|
|
8796
|
-
**requestOptions:** `
|
|
8902
|
+
**requestOptions:** `NotificationlogsClient.RequestOptions`
|
|
8797
8903
|
|
|
8798
8904
|
</dd>
|
|
8799
8905
|
</dl>
|
|
@@ -8858,7 +8964,7 @@ await client.notificationlogs.retryNotificationLog("550e8400-e29b-41d4-a716-4466
|
|
|
8858
8964
|
<dl>
|
|
8859
8965
|
<dd>
|
|
8860
8966
|
|
|
8861
|
-
**requestOptions:** `
|
|
8967
|
+
**requestOptions:** `NotificationlogsClient.RequestOptions`
|
|
8862
8968
|
|
|
8863
8969
|
</dd>
|
|
8864
8970
|
</dl>
|
|
@@ -8924,7 +9030,7 @@ await client.notificationlogs.bulkRetryNotificationLogs(["550e8400-e29b-41d4-a71
|
|
|
8924
9030
|
<dl>
|
|
8925
9031
|
<dd>
|
|
8926
9032
|
|
|
8927
|
-
**requestOptions:** `
|
|
9033
|
+
**requestOptions:** `NotificationlogsClient.RequestOptions`
|
|
8928
9034
|
|
|
8929
9035
|
</dd>
|
|
8930
9036
|
</dl>
|
|
@@ -8941,6 +9047,20 @@ await client.notificationlogs.bulkRetryNotificationLogs(["550e8400-e29b-41d4-a71
|
|
|
8941
9047
|
<dl>
|
|
8942
9048
|
<dd>
|
|
8943
9049
|
|
|
9050
|
+
#### 📝 Description
|
|
9051
|
+
|
|
9052
|
+
<dl>
|
|
9053
|
+
<dd>
|
|
9054
|
+
|
|
9055
|
+
<dl>
|
|
9056
|
+
<dd>
|
|
9057
|
+
|
|
9058
|
+
Use this endpoint to upload an image file for OCR processing. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more.
|
|
9059
|
+
</dd>
|
|
9060
|
+
</dl>
|
|
9061
|
+
</dd>
|
|
9062
|
+
</dl>
|
|
9063
|
+
|
|
8944
9064
|
#### 🔌 Usage
|
|
8945
9065
|
|
|
8946
9066
|
<dl>
|
|
@@ -8982,7 +9102,7 @@ await client.ocr.ocrDocumentForm("typeResult", {});
|
|
|
8982
9102
|
<dl>
|
|
8983
9103
|
<dd>
|
|
8984
9104
|
|
|
8985
|
-
**requestOptions:** `
|
|
9105
|
+
**requestOptions:** `OcrClient.RequestOptions`
|
|
8986
9106
|
|
|
8987
9107
|
</dd>
|
|
8988
9108
|
</dl>
|
|
@@ -8998,6 +9118,20 @@ await client.ocr.ocrDocumentForm("typeResult", {});
|
|
|
8998
9118
|
<dl>
|
|
8999
9119
|
<dd>
|
|
9000
9120
|
|
|
9121
|
+
#### 📝 Description
|
|
9122
|
+
|
|
9123
|
+
<dl>
|
|
9124
|
+
<dd>
|
|
9125
|
+
|
|
9126
|
+
<dl>
|
|
9127
|
+
<dd>
|
|
9128
|
+
|
|
9129
|
+
Use this endpoint to submit a Base64-encoded image file for OCR processing. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more.
|
|
9130
|
+
</dd>
|
|
9131
|
+
</dl>
|
|
9132
|
+
</dd>
|
|
9133
|
+
</dl>
|
|
9134
|
+
|
|
9001
9135
|
#### 🔌 Usage
|
|
9002
9136
|
|
|
9003
9137
|
<dl>
|
|
@@ -9039,7 +9173,7 @@ await client.ocr.ocrDocumentJson("typeResult", {});
|
|
|
9039
9173
|
<dl>
|
|
9040
9174
|
<dd>
|
|
9041
9175
|
|
|
9042
|
-
**requestOptions:** `
|
|
9176
|
+
**requestOptions:** `OcrClient.RequestOptions`
|
|
9043
9177
|
|
|
9044
9178
|
</dd>
|
|
9045
9179
|
</dl>
|
|
@@ -9141,7 +9275,7 @@ await client.organization.addOrganization({
|
|
|
9141
9275
|
<dl>
|
|
9142
9276
|
<dd>
|
|
9143
9277
|
|
|
9144
|
-
**requestOptions:** `
|
|
9278
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9145
9279
|
|
|
9146
9280
|
</dd>
|
|
9147
9281
|
</dl>
|
|
@@ -9204,7 +9338,7 @@ await client.organization.deleteOrganization(123);
|
|
|
9204
9338
|
<dl>
|
|
9205
9339
|
<dd>
|
|
9206
9340
|
|
|
9207
|
-
**requestOptions:** `
|
|
9341
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9208
9342
|
|
|
9209
9343
|
</dd>
|
|
9210
9344
|
</dl>
|
|
@@ -9293,7 +9427,7 @@ await client.organization.editOrganization(123, {
|
|
|
9293
9427
|
<dl>
|
|
9294
9428
|
<dd>
|
|
9295
9429
|
|
|
9296
|
-
**requestOptions:** `
|
|
9430
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9297
9431
|
|
|
9298
9432
|
</dd>
|
|
9299
9433
|
</dl>
|
|
@@ -9356,7 +9490,7 @@ await client.organization.getBasicOrganization("8cfec329267");
|
|
|
9356
9490
|
<dl>
|
|
9357
9491
|
<dd>
|
|
9358
9492
|
|
|
9359
|
-
**requestOptions:** `
|
|
9493
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9360
9494
|
|
|
9361
9495
|
</dd>
|
|
9362
9496
|
</dl>
|
|
@@ -9419,7 +9553,7 @@ await client.organization.getBasicOrganizationById(123);
|
|
|
9419
9553
|
<dl>
|
|
9420
9554
|
<dd>
|
|
9421
9555
|
|
|
9422
|
-
**requestOptions:** `
|
|
9556
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9423
9557
|
|
|
9424
9558
|
</dd>
|
|
9425
9559
|
</dl>
|
|
@@ -9482,7 +9616,7 @@ await client.organization.getOrganization(123);
|
|
|
9482
9616
|
<dl>
|
|
9483
9617
|
<dd>
|
|
9484
9618
|
|
|
9485
|
-
**requestOptions:** `
|
|
9619
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9486
9620
|
|
|
9487
9621
|
</dd>
|
|
9488
9622
|
</dl>
|
|
@@ -9545,7 +9679,7 @@ await client.organization.getSettingsOrganization(123);
|
|
|
9545
9679
|
<dl>
|
|
9546
9680
|
<dd>
|
|
9547
9681
|
|
|
9548
|
-
**requestOptions:** `
|
|
9682
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
9549
9683
|
|
|
9550
9684
|
</dd>
|
|
9551
9685
|
</dl>
|
|
@@ -9726,7 +9860,7 @@ await client.paymentLink.addPayLinkFromInvoice(23548884, {
|
|
|
9726
9860
|
<dl>
|
|
9727
9861
|
<dd>
|
|
9728
9862
|
|
|
9729
|
-
**requestOptions:** `
|
|
9863
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
9730
9864
|
|
|
9731
9865
|
</dd>
|
|
9732
9866
|
</dl>
|
|
@@ -9876,7 +10010,7 @@ await client.paymentLink.addPayLinkFromBill(23548884, {
|
|
|
9876
10010
|
<dl>
|
|
9877
10011
|
<dd>
|
|
9878
10012
|
|
|
9879
|
-
**requestOptions:** `
|
|
10013
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
9880
10014
|
|
|
9881
10015
|
</dd>
|
|
9882
10016
|
</dl>
|
|
@@ -9939,7 +10073,7 @@ await client.paymentLink.deletePayLinkFromId("payLinkId");
|
|
|
9939
10073
|
<dl>
|
|
9940
10074
|
<dd>
|
|
9941
10075
|
|
|
9942
|
-
**requestOptions:** `
|
|
10076
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
9943
10077
|
|
|
9944
10078
|
</dd>
|
|
9945
10079
|
</dl>
|
|
@@ -10002,7 +10136,7 @@ await client.paymentLink.getPayLinkFromId("paylinkId");
|
|
|
10002
10136
|
<dl>
|
|
10003
10137
|
<dd>
|
|
10004
10138
|
|
|
10005
|
-
**requestOptions:** `
|
|
10139
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10006
10140
|
|
|
10007
10141
|
</dd>
|
|
10008
10142
|
</dl>
|
|
@@ -10075,7 +10209,7 @@ await client.paymentLink.pushPayLinkFromId("payLinkId", {
|
|
|
10075
10209
|
<dl>
|
|
10076
10210
|
<dd>
|
|
10077
10211
|
|
|
10078
|
-
**requestOptions:** `
|
|
10212
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10079
10213
|
|
|
10080
10214
|
</dd>
|
|
10081
10215
|
</dl>
|
|
@@ -10146,7 +10280,7 @@ await client.paymentLink.refreshPayLinkFromId("payLinkId");
|
|
|
10146
10280
|
<dl>
|
|
10147
10281
|
<dd>
|
|
10148
10282
|
|
|
10149
|
-
**requestOptions:** `
|
|
10283
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10150
10284
|
|
|
10151
10285
|
</dd>
|
|
10152
10286
|
</dl>
|
|
@@ -10219,7 +10353,7 @@ await client.paymentLink.sendPayLinkFromId("payLinkId", {
|
|
|
10219
10353
|
<dl>
|
|
10220
10354
|
<dd>
|
|
10221
10355
|
|
|
10222
|
-
**requestOptions:** `
|
|
10356
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10223
10357
|
|
|
10224
10358
|
</dd>
|
|
10225
10359
|
</dl>
|
|
@@ -10303,7 +10437,7 @@ await client.paymentLink.updatePayLinkFromId("332-c277b704-1301", {
|
|
|
10303
10437
|
<dl>
|
|
10304
10438
|
<dd>
|
|
10305
10439
|
|
|
10306
|
-
**requestOptions:** `
|
|
10440
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10307
10441
|
|
|
10308
10442
|
</dd>
|
|
10309
10443
|
</dl>
|
|
@@ -10456,7 +10590,7 @@ await client.paymentLink.addPayLinkFromBillLotNumber("LOT-2024-001", {
|
|
|
10456
10590
|
<dl>
|
|
10457
10591
|
<dd>
|
|
10458
10592
|
|
|
10459
|
-
**requestOptions:** `
|
|
10593
|
+
**requestOptions:** `PaymentLinkClient.RequestOptions`
|
|
10460
10594
|
|
|
10461
10595
|
</dd>
|
|
10462
10596
|
</dl>
|
|
@@ -10530,7 +10664,7 @@ await client.paymentMethodDomain.addPaymentMethodDomain({
|
|
|
10530
10664
|
<dl>
|
|
10531
10665
|
<dd>
|
|
10532
10666
|
|
|
10533
|
-
**requestOptions:** `
|
|
10667
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10534
10668
|
|
|
10535
10669
|
</dd>
|
|
10536
10670
|
</dl>
|
|
@@ -10593,7 +10727,7 @@ await client.paymentMethodDomain.cascadePaymentMethodDomain("pmd_b8237fa45c964d8
|
|
|
10593
10727
|
<dl>
|
|
10594
10728
|
<dd>
|
|
10595
10729
|
|
|
10596
|
-
**requestOptions:** `
|
|
10730
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10597
10731
|
|
|
10598
10732
|
</dd>
|
|
10599
10733
|
</dl>
|
|
@@ -10656,7 +10790,7 @@ await client.paymentMethodDomain.deletePaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
10656
10790
|
<dl>
|
|
10657
10791
|
<dd>
|
|
10658
10792
|
|
|
10659
|
-
**requestOptions:** `
|
|
10793
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10660
10794
|
|
|
10661
10795
|
</dd>
|
|
10662
10796
|
</dl>
|
|
@@ -10719,7 +10853,7 @@ await client.paymentMethodDomain.getPaymentMethodDomain("pmd_b8237fa45c964d8a9ef
|
|
|
10719
10853
|
<dl>
|
|
10720
10854
|
<dd>
|
|
10721
10855
|
|
|
10722
|
-
**requestOptions:** `
|
|
10856
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10723
10857
|
|
|
10724
10858
|
</dd>
|
|
10725
10859
|
</dl>
|
|
@@ -10785,7 +10919,7 @@ await client.paymentMethodDomain.listPaymentMethodDomains({
|
|
|
10785
10919
|
<dl>
|
|
10786
10920
|
<dd>
|
|
10787
10921
|
|
|
10788
|
-
**requestOptions:** `
|
|
10922
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10789
10923
|
|
|
10790
10924
|
</dd>
|
|
10791
10925
|
</dl>
|
|
@@ -10863,7 +10997,7 @@ await client.paymentMethodDomain.updatePaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
10863
10997
|
<dl>
|
|
10864
10998
|
<dd>
|
|
10865
10999
|
|
|
10866
|
-
**requestOptions:** `
|
|
11000
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10867
11001
|
|
|
10868
11002
|
</dd>
|
|
10869
11003
|
</dl>
|
|
@@ -10926,7 +11060,7 @@ await client.paymentMethodDomain.verifyPaymentMethodDomain("pmd_b8237fa45c964d8a
|
|
|
10926
11060
|
<dl>
|
|
10927
11061
|
<dd>
|
|
10928
11062
|
|
|
10929
|
-
**requestOptions:** `
|
|
11063
|
+
**requestOptions:** `PaymentMethodDomainClient.RequestOptions`
|
|
10930
11064
|
|
|
10931
11065
|
</dd>
|
|
10932
11066
|
</dl>
|
|
@@ -10990,7 +11124,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
10990
11124
|
<dl>
|
|
10991
11125
|
<dd>
|
|
10992
11126
|
|
|
10993
|
-
**requestOptions:** `
|
|
11127
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
10994
11128
|
|
|
10995
11129
|
</dd>
|
|
10996
11130
|
</dl>
|
|
@@ -11002,7 +11136,7 @@ await client.paypoint.getBasicEntry("8cfec329267");
|
|
|
11002
11136
|
</dl>
|
|
11003
11137
|
</details>
|
|
11004
11138
|
|
|
11005
|
-
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getBasicEntryById</a>(
|
|
11139
|
+
<details><summary><code>client.paypoint.<a href="/src/api/resources/paypoint/client/Client.ts">getBasicEntryById</a>(IdPaypoint) -> Payabli.GetBasicEntryByIdResponse</code></summary>
|
|
11006
11140
|
<dl>
|
|
11007
11141
|
<dd>
|
|
11008
11142
|
|
|
@@ -11045,7 +11179,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
11045
11179
|
<dl>
|
|
11046
11180
|
<dd>
|
|
11047
11181
|
|
|
11048
|
-
**
|
|
11182
|
+
**IdPaypoint:** `string` — Paypoint ID. You can find this value by querying `/api/Query/paypoints/{orgId}`
|
|
11049
11183
|
|
|
11050
11184
|
</dd>
|
|
11051
11185
|
</dl>
|
|
@@ -11053,7 +11187,7 @@ await client.paypoint.getBasicEntryById("198");
|
|
|
11053
11187
|
<dl>
|
|
11054
11188
|
<dd>
|
|
11055
11189
|
|
|
11056
|
-
**requestOptions:** `
|
|
11190
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11057
11191
|
|
|
11058
11192
|
</dd>
|
|
11059
11193
|
</dl>
|
|
@@ -11124,7 +11258,7 @@ await client.paypoint.getEntryConfig("8cfec329267");
|
|
|
11124
11258
|
<dl>
|
|
11125
11259
|
<dd>
|
|
11126
11260
|
|
|
11127
|
-
**requestOptions:** `
|
|
11261
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11128
11262
|
|
|
11129
11263
|
</dd>
|
|
11130
11264
|
</dl>
|
|
@@ -11195,7 +11329,7 @@ await client.paypoint.getPage("8cfec329267", "pay-your-fees-1");
|
|
|
11195
11329
|
<dl>
|
|
11196
11330
|
<dd>
|
|
11197
11331
|
|
|
11198
|
-
**requestOptions:** `
|
|
11332
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11199
11333
|
|
|
11200
11334
|
</dd>
|
|
11201
11335
|
</dl>
|
|
@@ -11266,7 +11400,7 @@ await client.paypoint.removePage("8cfec329267", "pay-your-fees-1");
|
|
|
11266
11400
|
<dl>
|
|
11267
11401
|
<dd>
|
|
11268
11402
|
|
|
11269
|
-
**requestOptions:** `
|
|
11403
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11270
11404
|
|
|
11271
11405
|
</dd>
|
|
11272
11406
|
</dl>
|
|
@@ -11337,7 +11471,7 @@ await client.paypoint.saveLogo("8cfec329267", {});
|
|
|
11337
11471
|
<dl>
|
|
11338
11472
|
<dd>
|
|
11339
11473
|
|
|
11340
|
-
**requestOptions:** `
|
|
11474
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11341
11475
|
|
|
11342
11476
|
</dd>
|
|
11343
11477
|
</dl>
|
|
@@ -11400,7 +11534,7 @@ await client.paypoint.settingsPage("8cfec329267");
|
|
|
11400
11534
|
<dl>
|
|
11401
11535
|
<dd>
|
|
11402
11536
|
|
|
11403
|
-
**requestOptions:** `
|
|
11537
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11404
11538
|
|
|
11405
11539
|
</dd>
|
|
11406
11540
|
</dl>
|
|
@@ -11473,7 +11607,7 @@ await client.paypoint.migrate({
|
|
|
11473
11607
|
<dl>
|
|
11474
11608
|
<dd>
|
|
11475
11609
|
|
|
11476
|
-
**requestOptions:** `
|
|
11610
|
+
**requestOptions:** `PaypointClient.RequestOptions`
|
|
11477
11611
|
|
|
11478
11612
|
</dd>
|
|
11479
11613
|
</dl>
|
|
@@ -11550,7 +11684,7 @@ await client.query.listBatchDetails("8cfec329267", {
|
|
|
11550
11684
|
<dl>
|
|
11551
11685
|
<dd>
|
|
11552
11686
|
|
|
11553
|
-
**requestOptions:** `
|
|
11687
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11554
11688
|
|
|
11555
11689
|
</dd>
|
|
11556
11690
|
</dl>
|
|
@@ -11625,7 +11759,7 @@ await client.query.listBatchDetailsOrg(123, {
|
|
|
11625
11759
|
<dl>
|
|
11626
11760
|
<dd>
|
|
11627
11761
|
|
|
11628
|
-
**requestOptions:** `
|
|
11762
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11629
11763
|
|
|
11630
11764
|
</dd>
|
|
11631
11765
|
</dl>
|
|
@@ -11700,7 +11834,7 @@ await client.query.listBatches("8cfec329267", {
|
|
|
11700
11834
|
<dl>
|
|
11701
11835
|
<dd>
|
|
11702
11836
|
|
|
11703
|
-
**requestOptions:** `
|
|
11837
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11704
11838
|
|
|
11705
11839
|
</dd>
|
|
11706
11840
|
</dl>
|
|
@@ -11775,7 +11909,7 @@ await client.query.listBatchesOrg(123, {
|
|
|
11775
11909
|
<dl>
|
|
11776
11910
|
<dd>
|
|
11777
11911
|
|
|
11778
|
-
**requestOptions:** `
|
|
11912
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11779
11913
|
|
|
11780
11914
|
</dd>
|
|
11781
11915
|
</dl>
|
|
@@ -11850,7 +11984,7 @@ await client.query.listBatchesOut("8cfec329267", {
|
|
|
11850
11984
|
<dl>
|
|
11851
11985
|
<dd>
|
|
11852
11986
|
|
|
11853
|
-
**requestOptions:** `
|
|
11987
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11854
11988
|
|
|
11855
11989
|
</dd>
|
|
11856
11990
|
</dl>
|
|
@@ -11925,7 +12059,7 @@ await client.query.listBatchesOutOrg(123, {
|
|
|
11925
12059
|
<dl>
|
|
11926
12060
|
<dd>
|
|
11927
12061
|
|
|
11928
|
-
**requestOptions:** `
|
|
12062
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
11929
12063
|
|
|
11930
12064
|
</dd>
|
|
11931
12065
|
</dl>
|
|
@@ -12000,7 +12134,7 @@ await client.query.listChargebacks("8cfec329267", {
|
|
|
12000
12134
|
<dl>
|
|
12001
12135
|
<dd>
|
|
12002
12136
|
|
|
12003
|
-
**requestOptions:** `
|
|
12137
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12004
12138
|
|
|
12005
12139
|
</dd>
|
|
12006
12140
|
</dl>
|
|
@@ -12075,7 +12209,7 @@ await client.query.listChargebacksOrg(123, {
|
|
|
12075
12209
|
<dl>
|
|
12076
12210
|
<dd>
|
|
12077
12211
|
|
|
12078
|
-
**requestOptions:** `
|
|
12212
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12079
12213
|
|
|
12080
12214
|
</dd>
|
|
12081
12215
|
</dl>
|
|
@@ -12150,7 +12284,7 @@ await client.query.listCustomers("8cfec329267", {
|
|
|
12150
12284
|
<dl>
|
|
12151
12285
|
<dd>
|
|
12152
12286
|
|
|
12153
|
-
**requestOptions:** `
|
|
12287
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12154
12288
|
|
|
12155
12289
|
</dd>
|
|
12156
12290
|
</dl>
|
|
@@ -12225,7 +12359,7 @@ await client.query.listCustomersOrg(123, {
|
|
|
12225
12359
|
<dl>
|
|
12226
12360
|
<dd>
|
|
12227
12361
|
|
|
12228
|
-
**requestOptions:** `
|
|
12362
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12229
12363
|
|
|
12230
12364
|
</dd>
|
|
12231
12365
|
</dl>
|
|
@@ -12300,7 +12434,7 @@ await client.query.listNotificationReports("8cfec329267", {
|
|
|
12300
12434
|
<dl>
|
|
12301
12435
|
<dd>
|
|
12302
12436
|
|
|
12303
|
-
**requestOptions:** `
|
|
12437
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12304
12438
|
|
|
12305
12439
|
</dd>
|
|
12306
12440
|
</dl>
|
|
@@ -12375,7 +12509,7 @@ await client.query.listNotificationReportsOrg(123, {
|
|
|
12375
12509
|
<dl>
|
|
12376
12510
|
<dd>
|
|
12377
12511
|
|
|
12378
|
-
**requestOptions:** `
|
|
12512
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12379
12513
|
|
|
12380
12514
|
</dd>
|
|
12381
12515
|
</dl>
|
|
@@ -12450,7 +12584,7 @@ await client.query.listNotifications("8cfec329267", {
|
|
|
12450
12584
|
<dl>
|
|
12451
12585
|
<dd>
|
|
12452
12586
|
|
|
12453
|
-
**requestOptions:** `
|
|
12587
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12454
12588
|
|
|
12455
12589
|
</dd>
|
|
12456
12590
|
</dl>
|
|
@@ -12525,7 +12659,7 @@ await client.query.listNotificationsOrg(123, {
|
|
|
12525
12659
|
<dl>
|
|
12526
12660
|
<dd>
|
|
12527
12661
|
|
|
12528
|
-
**requestOptions:** `
|
|
12662
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12529
12663
|
|
|
12530
12664
|
</dd>
|
|
12531
12665
|
</dl>
|
|
@@ -12600,7 +12734,7 @@ await client.query.listOrganizations(123, {
|
|
|
12600
12734
|
<dl>
|
|
12601
12735
|
<dd>
|
|
12602
12736
|
|
|
12603
|
-
**requestOptions:** `
|
|
12737
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12604
12738
|
|
|
12605
12739
|
</dd>
|
|
12606
12740
|
</dl>
|
|
@@ -12675,7 +12809,7 @@ await client.query.listPayout("8cfec329267", {
|
|
|
12675
12809
|
<dl>
|
|
12676
12810
|
<dd>
|
|
12677
12811
|
|
|
12678
|
-
**requestOptions:** `
|
|
12812
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12679
12813
|
|
|
12680
12814
|
</dd>
|
|
12681
12815
|
</dl>
|
|
@@ -12750,7 +12884,7 @@ await client.query.listPayoutOrg(123, {
|
|
|
12750
12884
|
<dl>
|
|
12751
12885
|
<dd>
|
|
12752
12886
|
|
|
12753
|
-
**requestOptions:** `
|
|
12887
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12754
12888
|
|
|
12755
12889
|
</dd>
|
|
12756
12890
|
</dl>
|
|
@@ -12825,7 +12959,7 @@ await client.query.listPaypoints(123, {
|
|
|
12825
12959
|
<dl>
|
|
12826
12960
|
<dd>
|
|
12827
12961
|
|
|
12828
|
-
**requestOptions:** `
|
|
12962
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12829
12963
|
|
|
12830
12964
|
</dd>
|
|
12831
12965
|
</dl>
|
|
@@ -12900,7 +13034,7 @@ await client.query.listSettlements("8cfec329267", {
|
|
|
12900
13034
|
<dl>
|
|
12901
13035
|
<dd>
|
|
12902
13036
|
|
|
12903
|
-
**requestOptions:** `
|
|
13037
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12904
13038
|
|
|
12905
13039
|
</dd>
|
|
12906
13040
|
</dl>
|
|
@@ -12975,7 +13109,7 @@ await client.query.listSettlementsOrg(123, {
|
|
|
12975
13109
|
<dl>
|
|
12976
13110
|
<dd>
|
|
12977
13111
|
|
|
12978
|
-
**requestOptions:** `
|
|
13112
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
12979
13113
|
|
|
12980
13114
|
</dd>
|
|
12981
13115
|
</dl>
|
|
@@ -13050,7 +13184,7 @@ await client.query.listSubscriptions("8cfec329267", {
|
|
|
13050
13184
|
<dl>
|
|
13051
13185
|
<dd>
|
|
13052
13186
|
|
|
13053
|
-
**requestOptions:** `
|
|
13187
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13054
13188
|
|
|
13055
13189
|
</dd>
|
|
13056
13190
|
</dl>
|
|
@@ -13125,7 +13259,7 @@ await client.query.listSubscriptionsOrg(123, {
|
|
|
13125
13259
|
<dl>
|
|
13126
13260
|
<dd>
|
|
13127
13261
|
|
|
13128
|
-
**requestOptions:** `
|
|
13262
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13129
13263
|
|
|
13130
13264
|
</dd>
|
|
13131
13265
|
</dl>
|
|
@@ -13207,7 +13341,7 @@ await client.query.listTransactions("8cfec329267", {
|
|
|
13207
13341
|
<dl>
|
|
13208
13342
|
<dd>
|
|
13209
13343
|
|
|
13210
|
-
**requestOptions:** `
|
|
13344
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13211
13345
|
|
|
13212
13346
|
</dd>
|
|
13213
13347
|
</dl>
|
|
@@ -13296,7 +13430,7 @@ await client.query.listTransactionsOrg(123, {
|
|
|
13296
13430
|
<dl>
|
|
13297
13431
|
<dd>
|
|
13298
13432
|
|
|
13299
|
-
**requestOptions:** `
|
|
13433
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13300
13434
|
|
|
13301
13435
|
</dd>
|
|
13302
13436
|
</dl>
|
|
@@ -13375,7 +13509,7 @@ await client.query.listTransferDetails("47862acd", 123456);
|
|
|
13375
13509
|
<dl>
|
|
13376
13510
|
<dd>
|
|
13377
13511
|
|
|
13378
|
-
**requestOptions:** `
|
|
13512
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13379
13513
|
|
|
13380
13514
|
</dd>
|
|
13381
13515
|
</dl>
|
|
@@ -13449,7 +13583,7 @@ await client.query.listTransfers("47862acd", {
|
|
|
13449
13583
|
<dl>
|
|
13450
13584
|
<dd>
|
|
13451
13585
|
|
|
13452
|
-
**requestOptions:** `
|
|
13586
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13453
13587
|
|
|
13454
13588
|
</dd>
|
|
13455
13589
|
</dl>
|
|
@@ -13516,7 +13650,7 @@ await client.query.listTransfersOrg({
|
|
|
13516
13650
|
<dl>
|
|
13517
13651
|
<dd>
|
|
13518
13652
|
|
|
13519
|
-
**requestOptions:** `
|
|
13653
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13520
13654
|
|
|
13521
13655
|
</dd>
|
|
13522
13656
|
</dl>
|
|
@@ -13591,7 +13725,7 @@ await client.query.listUsersOrg(123, {
|
|
|
13591
13725
|
<dl>
|
|
13592
13726
|
<dd>
|
|
13593
13727
|
|
|
13594
|
-
**requestOptions:** `
|
|
13728
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13595
13729
|
|
|
13596
13730
|
</dd>
|
|
13597
13731
|
</dl>
|
|
@@ -13666,7 +13800,7 @@ await client.query.listUsersPaypoint("8cfec329267", {
|
|
|
13666
13800
|
<dl>
|
|
13667
13801
|
<dd>
|
|
13668
13802
|
|
|
13669
|
-
**requestOptions:** `
|
|
13803
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13670
13804
|
|
|
13671
13805
|
</dd>
|
|
13672
13806
|
</dl>
|
|
@@ -13741,7 +13875,7 @@ await client.query.listVendors("8cfec329267", {
|
|
|
13741
13875
|
<dl>
|
|
13742
13876
|
<dd>
|
|
13743
13877
|
|
|
13744
|
-
**requestOptions:** `
|
|
13878
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13745
13879
|
|
|
13746
13880
|
</dd>
|
|
13747
13881
|
</dl>
|
|
@@ -13816,7 +13950,7 @@ await client.query.listVendorsOrg(123, {
|
|
|
13816
13950
|
<dl>
|
|
13817
13951
|
<dd>
|
|
13818
13952
|
|
|
13819
|
-
**requestOptions:** `
|
|
13953
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13820
13954
|
|
|
13821
13955
|
</dd>
|
|
13822
13956
|
</dl>
|
|
@@ -13891,7 +14025,7 @@ await client.query.listVcards("8cfec329267", {
|
|
|
13891
14025
|
<dl>
|
|
13892
14026
|
<dd>
|
|
13893
14027
|
|
|
13894
|
-
**requestOptions:** `
|
|
14028
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13895
14029
|
|
|
13896
14030
|
</dd>
|
|
13897
14031
|
</dl>
|
|
@@ -13966,7 +14100,7 @@ await client.query.listVcardsOrg(123, {
|
|
|
13966
14100
|
<dl>
|
|
13967
14101
|
<dd>
|
|
13968
14102
|
|
|
13969
|
-
**requestOptions:** `
|
|
14103
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13970
14104
|
|
|
13971
14105
|
</dd>
|
|
13972
14106
|
</dl>
|
|
@@ -13979,7 +14113,7 @@ await client.query.listVcardsOrg(123, {
|
|
|
13979
14113
|
</details>
|
|
13980
14114
|
|
|
13981
14115
|
## Statistic
|
|
13982
|
-
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">basicStats</a>(
|
|
14116
|
+
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">basicStats</a>(mode, freq, level, entryId, { ...params }) -> Payabli.StatBasicExtendedQueryRecord[]</code></summary>
|
|
13983
14117
|
<dl>
|
|
13984
14118
|
<dd>
|
|
13985
14119
|
|
|
@@ -14006,9 +14140,9 @@ Retrieves the basic statistics for an organization or a paypoint, for a given ti
|
|
|
14006
14140
|
<dd>
|
|
14007
14141
|
|
|
14008
14142
|
```typescript
|
|
14009
|
-
await client.statistic.basicStats(
|
|
14010
|
-
endDate: "
|
|
14011
|
-
startDate: "
|
|
14143
|
+
await client.statistic.basicStats("ytd", "m", 1, 1000000, {
|
|
14144
|
+
endDate: "2025-11-01",
|
|
14145
|
+
startDate: "2025-11-30"
|
|
14012
14146
|
});
|
|
14013
14147
|
|
|
14014
14148
|
```
|
|
@@ -14025,7 +14159,23 @@ await client.statistic.basicStats(1000000, "m", 1, "ytd", {
|
|
|
14025
14159
|
<dl>
|
|
14026
14160
|
<dd>
|
|
14027
14161
|
|
|
14028
|
-
**
|
|
14162
|
+
**mode:** `string`
|
|
14163
|
+
|
|
14164
|
+
Mode for the request. Allowed values:
|
|
14165
|
+
|
|
14166
|
+
- `custom` - Allows you to set a custom date range
|
|
14167
|
+
- `ytd` - Year To Date
|
|
14168
|
+
- `mtd` - Month To Date
|
|
14169
|
+
- `wtd` - Week To Date
|
|
14170
|
+
- `today` - All current day
|
|
14171
|
+
- `m12` - Last 12 months
|
|
14172
|
+
- `d30` - Last 30 days
|
|
14173
|
+
- `h24` - Last 24 hours
|
|
14174
|
+
- `lasty` - Last Year
|
|
14175
|
+
- `lastm` - Last Month
|
|
14176
|
+
- `lastw` - Last Week
|
|
14177
|
+
- `yesterday` - Last Day
|
|
14178
|
+
|
|
14029
14179
|
|
|
14030
14180
|
</dd>
|
|
14031
14181
|
</dl>
|
|
@@ -14062,23 +14212,7 @@ The entry level for the request:
|
|
|
14062
14212
|
<dl>
|
|
14063
14213
|
<dd>
|
|
14064
14214
|
|
|
14065
|
-
**
|
|
14066
|
-
|
|
14067
|
-
Mode for the request. Allowed values:
|
|
14068
|
-
|
|
14069
|
-
- `custom` - Allows you to set a custom date range
|
|
14070
|
-
- `ytd` - Year To Date
|
|
14071
|
-
- `mtd` - Month To Date
|
|
14072
|
-
- `wtd` - Week To Date
|
|
14073
|
-
- `today` - All current day
|
|
14074
|
-
- `m12` - Last 12 months
|
|
14075
|
-
- `d30` - Last 30 days
|
|
14076
|
-
- `h24` - Last 24 hours
|
|
14077
|
-
- `lasty` - Last Year
|
|
14078
|
-
- `lastm` - Last Month
|
|
14079
|
-
- `lastw` - Last Week
|
|
14080
|
-
- `yesterday` - Last Day
|
|
14081
|
-
|
|
14215
|
+
**entryId:** `number` — Identifier in Payabli for the entity.
|
|
14082
14216
|
|
|
14083
14217
|
</dd>
|
|
14084
14218
|
</dl>
|
|
@@ -14094,7 +14228,7 @@ Mode for the request. Allowed values:
|
|
|
14094
14228
|
<dl>
|
|
14095
14229
|
<dd>
|
|
14096
14230
|
|
|
14097
|
-
**requestOptions:** `
|
|
14231
|
+
**requestOptions:** `StatisticClient.RequestOptions`
|
|
14098
14232
|
|
|
14099
14233
|
</dd>
|
|
14100
14234
|
</dl>
|
|
@@ -14106,7 +14240,7 @@ Mode for the request. Allowed values:
|
|
|
14106
14240
|
</dl>
|
|
14107
14241
|
</details>
|
|
14108
14242
|
|
|
14109
|
-
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">customerBasicStats</a>(
|
|
14243
|
+
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">customerBasicStats</a>(mode, freq, customerId, { ...params }) -> Payabli.SubscriptionStatsQueryRecord[]</code></summary>
|
|
14110
14244
|
<dl>
|
|
14111
14245
|
<dd>
|
|
14112
14246
|
|
|
@@ -14133,7 +14267,7 @@ Retrieves the basic statistics for a customer for a specific time period, groupe
|
|
|
14133
14267
|
<dd>
|
|
14134
14268
|
|
|
14135
14269
|
```typescript
|
|
14136
|
-
await client.statistic.customerBasicStats(
|
|
14270
|
+
await client.statistic.customerBasicStats("ytd", "m", 998);
|
|
14137
14271
|
|
|
14138
14272
|
```
|
|
14139
14273
|
</dd>
|
|
@@ -14149,7 +14283,21 @@ await client.statistic.customerBasicStats(998, "m", "ytd");
|
|
|
14149
14283
|
<dl>
|
|
14150
14284
|
<dd>
|
|
14151
14285
|
|
|
14152
|
-
**
|
|
14286
|
+
**mode:** `string`
|
|
14287
|
+
|
|
14288
|
+
Mode for request. Allowed values:
|
|
14289
|
+
|
|
14290
|
+
- `ytd` - Year To Date
|
|
14291
|
+
- `mtd` - Month To Date
|
|
14292
|
+
- `wtd` - Week To Date
|
|
14293
|
+
- `today` - All current day
|
|
14294
|
+
- `m12` - Last 12 months
|
|
14295
|
+
- `d30` - Last 30 days
|
|
14296
|
+
- `h24` - Last 24 hours
|
|
14297
|
+
- `lasty` - Last Year
|
|
14298
|
+
- `lastm` - Last Month
|
|
14299
|
+
- `lastw` - Last Week
|
|
14300
|
+
- `yesterday` - Last Day
|
|
14153
14301
|
|
|
14154
14302
|
</dd>
|
|
14155
14303
|
</dl>
|
|
@@ -14174,21 +14322,7 @@ For example, `w` groups the results by week.
|
|
|
14174
14322
|
<dl>
|
|
14175
14323
|
<dd>
|
|
14176
14324
|
|
|
14177
|
-
**
|
|
14178
|
-
|
|
14179
|
-
Mode for request. Allowed values:
|
|
14180
|
-
|
|
14181
|
-
- `ytd` - Year To Date
|
|
14182
|
-
- `mtd` - Month To Date
|
|
14183
|
-
- `wtd` - Week To Date
|
|
14184
|
-
- `today` - All current day
|
|
14185
|
-
- `m12` - Last 12 months
|
|
14186
|
-
- `d30` - Last 30 days
|
|
14187
|
-
- `h24` - Last 24 hours
|
|
14188
|
-
- `lasty` - Last Year
|
|
14189
|
-
- `lastm` - Last Month
|
|
14190
|
-
- `lastw` - Last Week
|
|
14191
|
-
- `yesterday` - Last Day
|
|
14325
|
+
**customerId:** `number` — Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
|
|
14192
14326
|
|
|
14193
14327
|
</dd>
|
|
14194
14328
|
</dl>
|
|
@@ -14204,7 +14338,7 @@ Mode for request. Allowed values:
|
|
|
14204
14338
|
<dl>
|
|
14205
14339
|
<dd>
|
|
14206
14340
|
|
|
14207
|
-
**requestOptions:** `
|
|
14341
|
+
**requestOptions:** `StatisticClient.RequestOptions`
|
|
14208
14342
|
|
|
14209
14343
|
</dd>
|
|
14210
14344
|
</dl>
|
|
@@ -14216,7 +14350,7 @@ Mode for request. Allowed values:
|
|
|
14216
14350
|
</dl>
|
|
14217
14351
|
</details>
|
|
14218
14352
|
|
|
14219
|
-
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">subStats</a>(
|
|
14353
|
+
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">subStats</a>(interval, level, entryId, { ...params }) -> Payabli.StatBasicQueryRecord[]</code></summary>
|
|
14220
14354
|
<dl>
|
|
14221
14355
|
<dd>
|
|
14222
14356
|
|
|
@@ -14243,7 +14377,7 @@ Retrieves the subscription statistics for a given interval for a paypoint or org
|
|
|
14243
14377
|
<dd>
|
|
14244
14378
|
|
|
14245
14379
|
```typescript
|
|
14246
|
-
await client.statistic.subStats(
|
|
14380
|
+
await client.statistic.subStats("30", 1, 1000000);
|
|
14247
14381
|
|
|
14248
14382
|
```
|
|
14249
14383
|
</dd>
|
|
@@ -14259,14 +14393,6 @@ await client.statistic.subStats(1000000, "30", 1);
|
|
|
14259
14393
|
<dl>
|
|
14260
14394
|
<dd>
|
|
14261
14395
|
|
|
14262
|
-
**entryId:** `number` — Identifier in Payabli for the entity.
|
|
14263
|
-
|
|
14264
|
-
</dd>
|
|
14265
|
-
</dl>
|
|
14266
|
-
|
|
14267
|
-
<dl>
|
|
14268
|
-
<dd>
|
|
14269
|
-
|
|
14270
14396
|
**interval:** `string`
|
|
14271
14397
|
|
|
14272
14398
|
Interval to get the data. Allowed values:
|
|
@@ -14295,6 +14421,14 @@ The entry level for the request:
|
|
|
14295
14421
|
<dl>
|
|
14296
14422
|
<dd>
|
|
14297
14423
|
|
|
14424
|
+
**entryId:** `number` — Identifier in Payabli for the entity.
|
|
14425
|
+
|
|
14426
|
+
</dd>
|
|
14427
|
+
</dl>
|
|
14428
|
+
|
|
14429
|
+
<dl>
|
|
14430
|
+
<dd>
|
|
14431
|
+
|
|
14298
14432
|
**request:** `Payabli.SubStatsRequest`
|
|
14299
14433
|
|
|
14300
14434
|
</dd>
|
|
@@ -14303,7 +14437,7 @@ The entry level for the request:
|
|
|
14303
14437
|
<dl>
|
|
14304
14438
|
<dd>
|
|
14305
14439
|
|
|
14306
|
-
**requestOptions:** `
|
|
14440
|
+
**requestOptions:** `StatisticClient.RequestOptions`
|
|
14307
14441
|
|
|
14308
14442
|
</dd>
|
|
14309
14443
|
</dl>
|
|
@@ -14315,7 +14449,7 @@ The entry level for the request:
|
|
|
14315
14449
|
</dl>
|
|
14316
14450
|
</details>
|
|
14317
14451
|
|
|
14318
|
-
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">vendorBasicStats</a>(freq, idVendor,
|
|
14452
|
+
<details><summary><code>client.statistic.<a href="/src/api/resources/statistic/client/Client.ts">vendorBasicStats</a>(mode, freq, idVendor, { ...params }) -> Payabli.StatisticsVendorQueryRecord[]</code></summary>
|
|
14319
14453
|
<dl>
|
|
14320
14454
|
<dd>
|
|
14321
14455
|
|
|
@@ -14342,7 +14476,7 @@ Retrieve the basic statistics about a vendor for a given time period, grouped by
|
|
|
14342
14476
|
<dd>
|
|
14343
14477
|
|
|
14344
14478
|
```typescript
|
|
14345
|
-
await client.statistic.vendorBasicStats("m", 1
|
|
14479
|
+
await client.statistic.vendorBasicStats("ytd", "m", 1);
|
|
14346
14480
|
|
|
14347
14481
|
```
|
|
14348
14482
|
</dd>
|
|
@@ -14358,6 +14492,28 @@ await client.statistic.vendorBasicStats("m", 1, "ytd");
|
|
|
14358
14492
|
<dl>
|
|
14359
14493
|
<dd>
|
|
14360
14494
|
|
|
14495
|
+
**mode:** `string`
|
|
14496
|
+
|
|
14497
|
+
Mode for request. Allowed values:
|
|
14498
|
+
|
|
14499
|
+
- `ytd` - Year To Date
|
|
14500
|
+
- `mtd` - Month To Date
|
|
14501
|
+
- `wtd` - Week To Date
|
|
14502
|
+
- `today` - All current day
|
|
14503
|
+
- `m12` - Last 12 months
|
|
14504
|
+
- `d30` - Last 30 days
|
|
14505
|
+
- `h24` - Last 24 hours
|
|
14506
|
+
- `lasty` - Last Year
|
|
14507
|
+
- `lastm` - Last Month
|
|
14508
|
+
- `lastw` - Last Week
|
|
14509
|
+
- `yesterday` - Last Day
|
|
14510
|
+
|
|
14511
|
+
</dd>
|
|
14512
|
+
</dl>
|
|
14513
|
+
|
|
14514
|
+
<dl>
|
|
14515
|
+
<dd>
|
|
14516
|
+
|
|
14361
14517
|
**freq:** `string`
|
|
14362
14518
|
|
|
14363
14519
|
Frequency to group series. Allowed values:
|
|
@@ -14383,28 +14539,6 @@ For example, `w` groups the results by week.
|
|
|
14383
14539
|
<dl>
|
|
14384
14540
|
<dd>
|
|
14385
14541
|
|
|
14386
|
-
**mode:** `string`
|
|
14387
|
-
|
|
14388
|
-
Mode for request. Allowed values:
|
|
14389
|
-
|
|
14390
|
-
- `ytd` - Year To Date
|
|
14391
|
-
- `mtd` - Month To Date
|
|
14392
|
-
- `wtd` - Week To Date
|
|
14393
|
-
- `today` - All current day
|
|
14394
|
-
- `m12` - Last 12 months
|
|
14395
|
-
- `d30` - Last 30 days
|
|
14396
|
-
- `h24` - Last 24 hours
|
|
14397
|
-
- `lasty` - Last Year
|
|
14398
|
-
- `lastm` - Last Month
|
|
14399
|
-
- `lastw` - Last Week
|
|
14400
|
-
- `yesterday` - Last Day
|
|
14401
|
-
|
|
14402
|
-
</dd>
|
|
14403
|
-
</dl>
|
|
14404
|
-
|
|
14405
|
-
<dl>
|
|
14406
|
-
<dd>
|
|
14407
|
-
|
|
14408
14542
|
**request:** `Payabli.VendorBasicStatsRequest`
|
|
14409
14543
|
|
|
14410
14544
|
</dd>
|
|
@@ -14413,7 +14547,7 @@ Mode for request. Allowed values:
|
|
|
14413
14547
|
<dl>
|
|
14414
14548
|
<dd>
|
|
14415
14549
|
|
|
14416
|
-
**requestOptions:** `
|
|
14550
|
+
**requestOptions:** `StatisticClient.RequestOptions`
|
|
14417
14551
|
|
|
14418
14552
|
</dd>
|
|
14419
14553
|
</dl>
|
|
@@ -14477,7 +14611,7 @@ await client.subscription.getSubscription(263);
|
|
|
14477
14611
|
<dl>
|
|
14478
14612
|
<dd>
|
|
14479
14613
|
|
|
14480
|
-
**requestOptions:** `
|
|
14614
|
+
**requestOptions:** `SubscriptionClient.RequestOptions`
|
|
14481
14615
|
|
|
14482
14616
|
</dd>
|
|
14483
14617
|
</dl>
|
|
@@ -14566,7 +14700,7 @@ await client.subscription.newSubscription({
|
|
|
14566
14700
|
<dl>
|
|
14567
14701
|
<dd>
|
|
14568
14702
|
|
|
14569
|
-
**requestOptions:** `
|
|
14703
|
+
**requestOptions:** `SubscriptionClient.RequestOptions`
|
|
14570
14704
|
|
|
14571
14705
|
</dd>
|
|
14572
14706
|
</dl>
|
|
@@ -14629,7 +14763,7 @@ await client.subscription.removeSubscription(396);
|
|
|
14629
14763
|
<dl>
|
|
14630
14764
|
<dd>
|
|
14631
14765
|
|
|
14632
|
-
**requestOptions:** `
|
|
14766
|
+
**requestOptions:** `SubscriptionClient.RequestOptions`
|
|
14633
14767
|
|
|
14634
14768
|
</dd>
|
|
14635
14769
|
</dl>
|
|
@@ -14702,7 +14836,7 @@ await client.subscription.updateSubscription(231, {
|
|
|
14702
14836
|
<dl>
|
|
14703
14837
|
<dd>
|
|
14704
14838
|
|
|
14705
|
-
**requestOptions:** `
|
|
14839
|
+
**requestOptions:** `SubscriptionClient.RequestOptions`
|
|
14706
14840
|
|
|
14707
14841
|
</dd>
|
|
14708
14842
|
</dl>
|
|
@@ -14766,7 +14900,7 @@ await client.templates.deleteTemplate(80);
|
|
|
14766
14900
|
<dl>
|
|
14767
14901
|
<dd>
|
|
14768
14902
|
|
|
14769
|
-
**requestOptions:** `
|
|
14903
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
14770
14904
|
|
|
14771
14905
|
</dd>
|
|
14772
14906
|
</dl>
|
|
@@ -14778,7 +14912,7 @@ await client.templates.deleteTemplate(80);
|
|
|
14778
14912
|
</dl>
|
|
14779
14913
|
</details>
|
|
14780
14914
|
|
|
14781
|
-
<details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">getlinkTemplate</a>(
|
|
14915
|
+
<details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">getlinkTemplate</a>(templateId, ignoreEmpty) -> Payabli.BoardingLinkApiResponse</code></summary>
|
|
14782
14916
|
<dl>
|
|
14783
14917
|
<dd>
|
|
14784
14918
|
|
|
@@ -14805,7 +14939,7 @@ Generates a boarding link from a boarding template.
|
|
|
14805
14939
|
<dd>
|
|
14806
14940
|
|
|
14807
14941
|
```typescript
|
|
14808
|
-
await client.templates.getlinkTemplate(
|
|
14942
|
+
await client.templates.getlinkTemplate(80, true);
|
|
14809
14943
|
|
|
14810
14944
|
```
|
|
14811
14945
|
</dd>
|
|
@@ -14821,7 +14955,7 @@ await client.templates.getlinkTemplate(true, 80);
|
|
|
14821
14955
|
<dl>
|
|
14822
14956
|
<dd>
|
|
14823
14957
|
|
|
14824
|
-
**
|
|
14958
|
+
**templateId:** `number` — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
14825
14959
|
|
|
14826
14960
|
</dd>
|
|
14827
14961
|
</dl>
|
|
@@ -14829,7 +14963,7 @@ await client.templates.getlinkTemplate(true, 80);
|
|
|
14829
14963
|
<dl>
|
|
14830
14964
|
<dd>
|
|
14831
14965
|
|
|
14832
|
-
**
|
|
14966
|
+
**ignoreEmpty:** `boolean` — Ignore read-only and empty fields Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
|
|
14833
14967
|
|
|
14834
14968
|
</dd>
|
|
14835
14969
|
</dl>
|
|
@@ -14837,7 +14971,7 @@ await client.templates.getlinkTemplate(true, 80);
|
|
|
14837
14971
|
<dl>
|
|
14838
14972
|
<dd>
|
|
14839
14973
|
|
|
14840
|
-
**requestOptions:** `
|
|
14974
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
14841
14975
|
|
|
14842
14976
|
</dd>
|
|
14843
14977
|
</dl>
|
|
@@ -14900,7 +15034,7 @@ await client.templates.getTemplate(80);
|
|
|
14900
15034
|
<dl>
|
|
14901
15035
|
<dd>
|
|
14902
15036
|
|
|
14903
|
-
**requestOptions:** `
|
|
15037
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
14904
15038
|
|
|
14905
15039
|
</dd>
|
|
14906
15040
|
</dl>
|
|
@@ -14975,7 +15109,7 @@ await client.templates.listTemplates(123, {
|
|
|
14975
15109
|
<dl>
|
|
14976
15110
|
<dd>
|
|
14977
15111
|
|
|
14978
|
-
**requestOptions:** `
|
|
15112
|
+
**requestOptions:** `TemplatesClient.RequestOptions`
|
|
14979
15113
|
|
|
14980
15114
|
</dd>
|
|
14981
15115
|
</dl>
|
|
@@ -15055,7 +15189,7 @@ await client.tokenStorage.addMethod({
|
|
|
15055
15189
|
<dl>
|
|
15056
15190
|
<dd>
|
|
15057
15191
|
|
|
15058
|
-
**requestOptions:** `
|
|
15192
|
+
**requestOptions:** `TokenStorageClient.RequestOptions`
|
|
15059
15193
|
|
|
15060
15194
|
</dd>
|
|
15061
15195
|
</dl>
|
|
@@ -15129,7 +15263,7 @@ await client.tokenStorage.getMethod("32-8877drt00045632-678", {
|
|
|
15129
15263
|
<dl>
|
|
15130
15264
|
<dd>
|
|
15131
15265
|
|
|
15132
|
-
**requestOptions:** `
|
|
15266
|
+
**requestOptions:** `TokenStorageClient.RequestOptions`
|
|
15133
15267
|
|
|
15134
15268
|
</dd>
|
|
15135
15269
|
</dl>
|
|
@@ -15192,7 +15326,7 @@ await client.tokenStorage.removeMethod("32-8877drt00045632-678");
|
|
|
15192
15326
|
<dl>
|
|
15193
15327
|
<dd>
|
|
15194
15328
|
|
|
15195
|
-
**requestOptions:** `
|
|
15329
|
+
**requestOptions:** `TokenStorageClient.RequestOptions`
|
|
15196
15330
|
|
|
15197
15331
|
</dd>
|
|
15198
15332
|
</dl>
|
|
@@ -15279,7 +15413,7 @@ await client.tokenStorage.updateMethod("32-8877drt00045632-678", {
|
|
|
15279
15413
|
<dl>
|
|
15280
15414
|
<dd>
|
|
15281
15415
|
|
|
15282
|
-
**requestOptions:** `
|
|
15416
|
+
**requestOptions:** `TokenStorageClient.RequestOptions`
|
|
15283
15417
|
|
|
15284
15418
|
</dd>
|
|
15285
15419
|
</dl>
|
|
@@ -15296,6 +15430,20 @@ await client.tokenStorage.updateMethod("32-8877drt00045632-678", {
|
|
|
15296
15430
|
<dl>
|
|
15297
15431
|
<dd>
|
|
15298
15432
|
|
|
15433
|
+
#### 📝 Description
|
|
15434
|
+
|
|
15435
|
+
<dl>
|
|
15436
|
+
<dd>
|
|
15437
|
+
|
|
15438
|
+
<dl>
|
|
15439
|
+
<dd>
|
|
15440
|
+
|
|
15441
|
+
Use this endpoint to add a new user to an organization.
|
|
15442
|
+
</dd>
|
|
15443
|
+
</dl>
|
|
15444
|
+
</dd>
|
|
15445
|
+
</dl>
|
|
15446
|
+
|
|
15299
15447
|
#### 🔌 Usage
|
|
15300
15448
|
|
|
15301
15449
|
<dl>
|
|
@@ -15329,7 +15477,7 @@ await client.user.addUser({});
|
|
|
15329
15477
|
<dl>
|
|
15330
15478
|
<dd>
|
|
15331
15479
|
|
|
15332
|
-
**requestOptions:** `
|
|
15480
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15333
15481
|
|
|
15334
15482
|
</dd>
|
|
15335
15483
|
</dl>
|
|
@@ -15345,6 +15493,20 @@ await client.user.addUser({});
|
|
|
15345
15493
|
<dl>
|
|
15346
15494
|
<dd>
|
|
15347
15495
|
|
|
15496
|
+
#### 📝 Description
|
|
15497
|
+
|
|
15498
|
+
<dl>
|
|
15499
|
+
<dd>
|
|
15500
|
+
|
|
15501
|
+
<dl>
|
|
15502
|
+
<dd>
|
|
15503
|
+
|
|
15504
|
+
Use this endpoint to refresh the authentication token for a user within an organization.
|
|
15505
|
+
</dd>
|
|
15506
|
+
</dl>
|
|
15507
|
+
</dd>
|
|
15508
|
+
</dl>
|
|
15509
|
+
|
|
15348
15510
|
#### 🔌 Usage
|
|
15349
15511
|
|
|
15350
15512
|
<dl>
|
|
@@ -15370,7 +15532,7 @@ await client.user.authRefreshUser();
|
|
|
15370
15532
|
<dl>
|
|
15371
15533
|
<dd>
|
|
15372
15534
|
|
|
15373
|
-
**requestOptions:** `
|
|
15535
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15374
15536
|
|
|
15375
15537
|
</dd>
|
|
15376
15538
|
</dl>
|
|
@@ -15386,6 +15548,20 @@ await client.user.authRefreshUser();
|
|
|
15386
15548
|
<dl>
|
|
15387
15549
|
<dd>
|
|
15388
15550
|
|
|
15551
|
+
#### 📝 Description
|
|
15552
|
+
|
|
15553
|
+
<dl>
|
|
15554
|
+
<dd>
|
|
15555
|
+
|
|
15556
|
+
<dl>
|
|
15557
|
+
<dd>
|
|
15558
|
+
|
|
15559
|
+
Use this endpoint to initiate a password reset for a user within an organization.
|
|
15560
|
+
</dd>
|
|
15561
|
+
</dl>
|
|
15562
|
+
</dd>
|
|
15563
|
+
</dl>
|
|
15564
|
+
|
|
15389
15565
|
#### 🔌 Usage
|
|
15390
15566
|
|
|
15391
15567
|
<dl>
|
|
@@ -15419,7 +15595,7 @@ await client.user.authResetUser();
|
|
|
15419
15595
|
<dl>
|
|
15420
15596
|
<dd>
|
|
15421
15597
|
|
|
15422
|
-
**requestOptions:** `
|
|
15598
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15423
15599
|
|
|
15424
15600
|
</dd>
|
|
15425
15601
|
</dl>
|
|
@@ -15490,7 +15666,7 @@ await client.user.authUser("provider");
|
|
|
15490
15666
|
<dl>
|
|
15491
15667
|
<dd>
|
|
15492
15668
|
|
|
15493
|
-
**requestOptions:** `
|
|
15669
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15494
15670
|
|
|
15495
15671
|
</dd>
|
|
15496
15672
|
</dl>
|
|
@@ -15506,6 +15682,20 @@ await client.user.authUser("provider");
|
|
|
15506
15682
|
<dl>
|
|
15507
15683
|
<dd>
|
|
15508
15684
|
|
|
15685
|
+
#### 📝 Description
|
|
15686
|
+
|
|
15687
|
+
<dl>
|
|
15688
|
+
<dd>
|
|
15689
|
+
|
|
15690
|
+
<dl>
|
|
15691
|
+
<dd>
|
|
15692
|
+
|
|
15693
|
+
Use this endpoint to change the password for a user within an organization.
|
|
15694
|
+
</dd>
|
|
15695
|
+
</dl>
|
|
15696
|
+
</dd>
|
|
15697
|
+
</dl>
|
|
15698
|
+
|
|
15509
15699
|
#### 🔌 Usage
|
|
15510
15700
|
|
|
15511
15701
|
<dl>
|
|
@@ -15539,7 +15729,7 @@ await client.user.changePswUser();
|
|
|
15539
15729
|
<dl>
|
|
15540
15730
|
<dd>
|
|
15541
15731
|
|
|
15542
|
-
**requestOptions:** `
|
|
15732
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15543
15733
|
|
|
15544
15734
|
</dd>
|
|
15545
15735
|
</dl>
|
|
@@ -15555,6 +15745,20 @@ await client.user.changePswUser();
|
|
|
15555
15745
|
<dl>
|
|
15556
15746
|
<dd>
|
|
15557
15747
|
|
|
15748
|
+
#### 📝 Description
|
|
15749
|
+
|
|
15750
|
+
<dl>
|
|
15751
|
+
<dd>
|
|
15752
|
+
|
|
15753
|
+
<dl>
|
|
15754
|
+
<dd>
|
|
15755
|
+
|
|
15756
|
+
Use this endpoint to delete a specific user within an organization.
|
|
15757
|
+
</dd>
|
|
15758
|
+
</dl>
|
|
15759
|
+
</dd>
|
|
15760
|
+
</dl>
|
|
15761
|
+
|
|
15558
15762
|
#### 🔌 Usage
|
|
15559
15763
|
|
|
15560
15764
|
<dl>
|
|
@@ -15588,7 +15792,7 @@ await client.user.deleteUser(1000000);
|
|
|
15588
15792
|
<dl>
|
|
15589
15793
|
<dd>
|
|
15590
15794
|
|
|
15591
|
-
**requestOptions:** `
|
|
15795
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15592
15796
|
|
|
15593
15797
|
</dd>
|
|
15594
15798
|
</dl>
|
|
@@ -15604,6 +15808,20 @@ await client.user.deleteUser(1000000);
|
|
|
15604
15808
|
<dl>
|
|
15605
15809
|
<dd>
|
|
15606
15810
|
|
|
15811
|
+
#### 📝 Description
|
|
15812
|
+
|
|
15813
|
+
<dl>
|
|
15814
|
+
<dd>
|
|
15815
|
+
|
|
15816
|
+
<dl>
|
|
15817
|
+
<dd>
|
|
15818
|
+
|
|
15819
|
+
Use this endpoint to enable or disable multi-factor authentication (MFA) for a user within an organization.
|
|
15820
|
+
</dd>
|
|
15821
|
+
</dl>
|
|
15822
|
+
</dd>
|
|
15823
|
+
</dl>
|
|
15824
|
+
|
|
15607
15825
|
#### 🔌 Usage
|
|
15608
15826
|
|
|
15609
15827
|
<dl>
|
|
@@ -15645,7 +15863,7 @@ await client.user.editMfaUser(1000000, {});
|
|
|
15645
15863
|
<dl>
|
|
15646
15864
|
<dd>
|
|
15647
15865
|
|
|
15648
|
-
**requestOptions:** `
|
|
15866
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15649
15867
|
|
|
15650
15868
|
</dd>
|
|
15651
15869
|
</dl>
|
|
@@ -15661,6 +15879,20 @@ await client.user.editMfaUser(1000000, {});
|
|
|
15661
15879
|
<dl>
|
|
15662
15880
|
<dd>
|
|
15663
15881
|
|
|
15882
|
+
#### 📝 Description
|
|
15883
|
+
|
|
15884
|
+
<dl>
|
|
15885
|
+
<dd>
|
|
15886
|
+
|
|
15887
|
+
<dl>
|
|
15888
|
+
<dd>
|
|
15889
|
+
|
|
15890
|
+
Use this endpoint to modify the details of a specific user within an organization.
|
|
15891
|
+
</dd>
|
|
15892
|
+
</dl>
|
|
15893
|
+
</dd>
|
|
15894
|
+
</dl>
|
|
15895
|
+
|
|
15664
15896
|
#### 🔌 Usage
|
|
15665
15897
|
|
|
15666
15898
|
<dl>
|
|
@@ -15702,7 +15934,7 @@ await client.user.editUser(1000000, {});
|
|
|
15702
15934
|
<dl>
|
|
15703
15935
|
<dd>
|
|
15704
15936
|
|
|
15705
|
-
**requestOptions:** `
|
|
15937
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15706
15938
|
|
|
15707
15939
|
</dd>
|
|
15708
15940
|
</dl>
|
|
@@ -15718,6 +15950,20 @@ await client.user.editUser(1000000, {});
|
|
|
15718
15950
|
<dl>
|
|
15719
15951
|
<dd>
|
|
15720
15952
|
|
|
15953
|
+
#### 📝 Description
|
|
15954
|
+
|
|
15955
|
+
<dl>
|
|
15956
|
+
<dd>
|
|
15957
|
+
|
|
15958
|
+
<dl>
|
|
15959
|
+
<dd>
|
|
15960
|
+
|
|
15961
|
+
Use this endpoint to retrieve information about a specific user within an organization.
|
|
15962
|
+
</dd>
|
|
15963
|
+
</dl>
|
|
15964
|
+
</dd>
|
|
15965
|
+
</dl>
|
|
15966
|
+
|
|
15721
15967
|
#### 🔌 Usage
|
|
15722
15968
|
|
|
15723
15969
|
<dl>
|
|
@@ -15761,7 +16007,7 @@ await client.user.getUser(1000000, {
|
|
|
15761
16007
|
<dl>
|
|
15762
16008
|
<dd>
|
|
15763
16009
|
|
|
15764
|
-
**requestOptions:** `
|
|
16010
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15765
16011
|
|
|
15766
16012
|
</dd>
|
|
15767
16013
|
</dl>
|
|
@@ -15777,6 +16023,20 @@ await client.user.getUser(1000000, {
|
|
|
15777
16023
|
<dl>
|
|
15778
16024
|
<dd>
|
|
15779
16025
|
|
|
16026
|
+
#### 📝 Description
|
|
16027
|
+
|
|
16028
|
+
<dl>
|
|
16029
|
+
<dd>
|
|
16030
|
+
|
|
16031
|
+
<dl>
|
|
16032
|
+
<dd>
|
|
16033
|
+
|
|
16034
|
+
Use this endpoint to log a user out from the system.
|
|
16035
|
+
</dd>
|
|
16036
|
+
</dl>
|
|
16037
|
+
</dd>
|
|
16038
|
+
</dl>
|
|
16039
|
+
|
|
15780
16040
|
#### 🔌 Usage
|
|
15781
16041
|
|
|
15782
16042
|
<dl>
|
|
@@ -15802,7 +16062,7 @@ await client.user.logoutUser();
|
|
|
15802
16062
|
<dl>
|
|
15803
16063
|
<dd>
|
|
15804
16064
|
|
|
15805
|
-
**requestOptions:** `
|
|
16065
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15806
16066
|
|
|
15807
16067
|
</dd>
|
|
15808
16068
|
</dl>
|
|
@@ -15814,10 +16074,24 @@ await client.user.logoutUser();
|
|
|
15814
16074
|
</dl>
|
|
15815
16075
|
</details>
|
|
15816
16076
|
|
|
15817
|
-
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">resendMfaCode</a>(
|
|
16077
|
+
<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">resendMfaCode</a>(usrname, Entry, EntryType) -> Payabli.PayabliApiResponseMfaBasic</code></summary>
|
|
15818
16078
|
<dl>
|
|
15819
16079
|
<dd>
|
|
15820
16080
|
|
|
16081
|
+
#### 📝 Description
|
|
16082
|
+
|
|
16083
|
+
<dl>
|
|
16084
|
+
<dd>
|
|
16085
|
+
|
|
16086
|
+
<dl>
|
|
16087
|
+
<dd>
|
|
16088
|
+
|
|
16089
|
+
Resends the MFA code to the user via the selected MFA mode (email or SMS).
|
|
16090
|
+
</dd>
|
|
16091
|
+
</dl>
|
|
16092
|
+
</dd>
|
|
16093
|
+
</dl>
|
|
16094
|
+
|
|
15821
16095
|
#### 🔌 Usage
|
|
15822
16096
|
|
|
15823
16097
|
<dl>
|
|
@@ -15827,7 +16101,7 @@ await client.user.logoutUser();
|
|
|
15827
16101
|
<dd>
|
|
15828
16102
|
|
|
15829
16103
|
```typescript
|
|
15830
|
-
await client.user.resendMfaCode("Entry", 1
|
|
16104
|
+
await client.user.resendMfaCode("usrname", "Entry", 1);
|
|
15831
16105
|
|
|
15832
16106
|
```
|
|
15833
16107
|
</dd>
|
|
@@ -15843,7 +16117,7 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15843
16117
|
<dl>
|
|
15844
16118
|
<dd>
|
|
15845
16119
|
|
|
15846
|
-
**
|
|
16120
|
+
**usrname:** `string` —
|
|
15847
16121
|
|
|
15848
16122
|
</dd>
|
|
15849
16123
|
</dl>
|
|
@@ -15851,7 +16125,7 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15851
16125
|
<dl>
|
|
15852
16126
|
<dd>
|
|
15853
16127
|
|
|
15854
|
-
**
|
|
16128
|
+
**Entry:** `string` —
|
|
15855
16129
|
|
|
15856
16130
|
</dd>
|
|
15857
16131
|
</dl>
|
|
@@ -15859,7 +16133,7 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15859
16133
|
<dl>
|
|
15860
16134
|
<dd>
|
|
15861
16135
|
|
|
15862
|
-
**
|
|
16136
|
+
**EntryType:** `number` —
|
|
15863
16137
|
|
|
15864
16138
|
</dd>
|
|
15865
16139
|
</dl>
|
|
@@ -15867,7 +16141,7 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15867
16141
|
<dl>
|
|
15868
16142
|
<dd>
|
|
15869
16143
|
|
|
15870
|
-
**requestOptions:** `
|
|
16144
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15871
16145
|
|
|
15872
16146
|
</dd>
|
|
15873
16147
|
</dl>
|
|
@@ -15883,6 +16157,20 @@ await client.user.resendMfaCode("Entry", 1, "usrname");
|
|
|
15883
16157
|
<dl>
|
|
15884
16158
|
<dd>
|
|
15885
16159
|
|
|
16160
|
+
#### 📝 Description
|
|
16161
|
+
|
|
16162
|
+
<dl>
|
|
16163
|
+
<dd>
|
|
16164
|
+
|
|
16165
|
+
<dl>
|
|
16166
|
+
<dd>
|
|
16167
|
+
|
|
16168
|
+
Use this endpoint to validate the multi-factor authentication (MFA) code for a user within an organization.
|
|
16169
|
+
</dd>
|
|
16170
|
+
</dl>
|
|
16171
|
+
</dd>
|
|
16172
|
+
</dl>
|
|
16173
|
+
|
|
15886
16174
|
#### 🔌 Usage
|
|
15887
16175
|
|
|
15888
16176
|
<dl>
|
|
@@ -15916,7 +16204,7 @@ await client.user.validateMfaUser();
|
|
|
15916
16204
|
<dl>
|
|
15917
16205
|
<dd>
|
|
15918
16206
|
|
|
15919
|
-
**requestOptions:** `
|
|
16207
|
+
**requestOptions:** `UserClient.RequestOptions`
|
|
15920
16208
|
|
|
15921
16209
|
</dd>
|
|
15922
16210
|
</dl>
|
|
@@ -16031,7 +16319,7 @@ await client.vendor.addVendor("8cfec329267", {
|
|
|
16031
16319
|
<dl>
|
|
16032
16320
|
<dd>
|
|
16033
16321
|
|
|
16034
|
-
**requestOptions:** `
|
|
16322
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
16035
16323
|
|
|
16036
16324
|
</dd>
|
|
16037
16325
|
</dl>
|
|
@@ -16094,7 +16382,7 @@ await client.vendor.deleteVendor(1);
|
|
|
16094
16382
|
<dl>
|
|
16095
16383
|
<dd>
|
|
16096
16384
|
|
|
16097
|
-
**requestOptions:** `
|
|
16385
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
16098
16386
|
|
|
16099
16387
|
</dd>
|
|
16100
16388
|
</dl>
|
|
@@ -16167,7 +16455,7 @@ await client.vendor.editVendor(1, {
|
|
|
16167
16455
|
<dl>
|
|
16168
16456
|
<dd>
|
|
16169
16457
|
|
|
16170
|
-
**requestOptions:** `
|
|
16458
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
16171
16459
|
|
|
16172
16460
|
</dd>
|
|
16173
16461
|
</dl>
|
|
@@ -16230,7 +16518,7 @@ await client.vendor.getVendor(1);
|
|
|
16230
16518
|
<dl>
|
|
16231
16519
|
<dd>
|
|
16232
16520
|
|
|
16233
|
-
**requestOptions:** `
|
|
16521
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
16234
16522
|
|
|
16235
16523
|
</dd>
|
|
16236
16524
|
</dl>
|
|
@@ -16298,7 +16586,7 @@ await client.wallet.configureApplePayOrganization({
|
|
|
16298
16586
|
<dl>
|
|
16299
16587
|
<dd>
|
|
16300
16588
|
|
|
16301
|
-
**requestOptions:** `
|
|
16589
|
+
**requestOptions:** `WalletClient.RequestOptions`
|
|
16302
16590
|
|
|
16303
16591
|
</dd>
|
|
16304
16592
|
</dl>
|
|
@@ -16364,7 +16652,7 @@ await client.wallet.configureApplePayPaypoint({
|
|
|
16364
16652
|
<dl>
|
|
16365
16653
|
<dd>
|
|
16366
16654
|
|
|
16367
|
-
**requestOptions:** `
|
|
16655
|
+
**requestOptions:** `WalletClient.RequestOptions`
|
|
16368
16656
|
|
|
16369
16657
|
</dd>
|
|
16370
16658
|
</dl>
|
|
@@ -16431,7 +16719,7 @@ await client.wallet.configureGooglePayOrganization({
|
|
|
16431
16719
|
<dl>
|
|
16432
16720
|
<dd>
|
|
16433
16721
|
|
|
16434
|
-
**requestOptions:** `
|
|
16722
|
+
**requestOptions:** `WalletClient.RequestOptions`
|
|
16435
16723
|
|
|
16436
16724
|
</dd>
|
|
16437
16725
|
</dl>
|
|
@@ -16497,7 +16785,7 @@ await client.wallet.configureGooglePayPaypoint({
|
|
|
16497
16785
|
<dl>
|
|
16498
16786
|
<dd>
|
|
16499
16787
|
|
|
16500
|
-
**requestOptions:** `
|
|
16788
|
+
**requestOptions:** `WalletClient.RequestOptions`
|
|
16501
16789
|
|
|
16502
16790
|
</dd>
|
|
16503
16791
|
</dl>
|