@emilgroup/payment-sdk-node 1.23.1-beta.27 → 1.23.1-beta.28
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 +2 -2
- package/api/bank-accounts-api.ts +12 -12
- package/api/bank-orders-api.ts +12 -12
- package/api/bank-transaction-api.ts +12 -12
- package/api/billing-addresses-api.ts +12 -12
- package/api/credit-allocation-api.ts +12 -12
- package/api/exceeding-credits-api.ts +12 -12
- package/api/payment-methods-api.ts +12 -12
- package/api/payment-reminders-api.ts +12 -12
- package/api/payment-requests-api.ts +8 -8
- package/api/payments-api.ts +12 -12
- package/api/payout-methods-api.ts +12 -12
- package/api/refunds-api.ts +12 -12
- package/api/tenant-bank-account-api.ts +12 -12
- package/dist/api/bank-accounts-api.d.ts +12 -12
- package/dist/api/bank-accounts-api.js +10 -10
- package/dist/api/bank-orders-api.d.ts +12 -12
- package/dist/api/bank-orders-api.js +10 -10
- package/dist/api/bank-transaction-api.d.ts +12 -12
- package/dist/api/bank-transaction-api.js +10 -10
- package/dist/api/billing-addresses-api.d.ts +12 -12
- package/dist/api/billing-addresses-api.js +10 -10
- package/dist/api/credit-allocation-api.d.ts +12 -12
- package/dist/api/credit-allocation-api.js +10 -10
- package/dist/api/exceeding-credits-api.d.ts +12 -12
- package/dist/api/exceeding-credits-api.js +10 -10
- package/dist/api/payment-methods-api.d.ts +12 -12
- package/dist/api/payment-methods-api.js +10 -10
- package/dist/api/payment-reminders-api.d.ts +12 -12
- package/dist/api/payment-reminders-api.js +10 -10
- package/dist/api/payment-requests-api.d.ts +8 -8
- package/dist/api/payment-requests-api.js +6 -6
- package/dist/api/payments-api.d.ts +12 -12
- package/dist/api/payments-api.js +10 -10
- package/dist/api/payout-methods-api.d.ts +12 -12
- package/dist/api/payout-methods-api.js +10 -10
- package/dist/api/refunds-api.d.ts +12 -12
- package/dist/api/refunds-api.js +10 -10
- package/dist/api/tenant-bank-account-api.d.ts +12 -12
- package/dist/api/tenant-bank-account-api.js +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/payment-sdk-node@1.23.1-beta.
|
|
20
|
+
npm install @emilgroup/payment-sdk-node@1.23.1-beta.28 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/payment-sdk-node@1.23.1-beta.
|
|
24
|
+
yarn add @emilgroup/payment-sdk-node@1.23.1-beta.28
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PaymentsApi`.
|
package/api/bank-accounts-api.ts
CHANGED
|
@@ -187,16 +187,16 @@ export const BankAccountsApiAxiosParamCreator = function (configuration?: Config
|
|
|
187
187
|
};
|
|
188
188
|
},
|
|
189
189
|
/**
|
|
190
|
-
* Returns a list of bank accounts you have previously created.
|
|
190
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
191
191
|
* @summary List bank accounts
|
|
192
192
|
* @param {string} [authorization] Bearer Token
|
|
193
193
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
194
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
195
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
195
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, accountCode, partnerCode</i>
|
|
196
196
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
197
197
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
198
198
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: primaryBankAccount<i>
|
|
199
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
199
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, accountCode, partnerCode</i>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
@@ -412,16 +412,16 @@ export const BankAccountsApiFp = function(configuration?: Configuration) {
|
|
|
412
412
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
413
413
|
},
|
|
414
414
|
/**
|
|
415
|
-
* Returns a list of bank accounts you have previously created.
|
|
415
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
416
416
|
* @summary List bank accounts
|
|
417
417
|
* @param {string} [authorization] Bearer Token
|
|
418
418
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
419
419
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
420
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
420
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, accountCode, partnerCode</i>
|
|
421
421
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
422
422
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
423
423
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: primaryBankAccount<i>
|
|
424
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
424
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, accountCode, partnerCode</i>
|
|
425
425
|
* @param {*} [options] Override http request option.
|
|
426
426
|
* @throws {RequiredError}
|
|
427
427
|
*/
|
|
@@ -500,16 +500,16 @@ export const BankAccountsApiFactory = function (configuration?: Configuration, b
|
|
|
500
500
|
return localVarFp.getBankAccount(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
501
501
|
},
|
|
502
502
|
/**
|
|
503
|
-
* Returns a list of bank accounts you have previously created.
|
|
503
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
504
504
|
* @summary List bank accounts
|
|
505
505
|
* @param {string} [authorization] Bearer Token
|
|
506
506
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
507
507
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
508
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
508
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, accountCode, partnerCode</i>
|
|
509
509
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
510
510
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
511
511
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: primaryBankAccount<i>
|
|
512
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
512
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, accountCode, partnerCode</i>
|
|
513
513
|
* @param {*} [options] Override http request option.
|
|
514
514
|
* @throws {RequiredError}
|
|
515
515
|
*/
|
|
@@ -641,7 +641,7 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
641
641
|
readonly pageToken?: string
|
|
642
642
|
|
|
643
643
|
/**
|
|
644
|
-
* Filter the response by one or multiple fields.
|
|
644
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, accountCode, partnerCode</i>
|
|
645
645
|
* @type {string}
|
|
646
646
|
* @memberof BankAccountsApiListBankAccounts
|
|
647
647
|
*/
|
|
@@ -669,7 +669,7 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
669
669
|
readonly expand?: string
|
|
670
670
|
|
|
671
671
|
/**
|
|
672
|
-
* Filters the response by one or multiple fields.
|
|
672
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, accountCode, partnerCode</i>
|
|
673
673
|
* @type {string}
|
|
674
674
|
* @memberof BankAccountsApiListBankAccounts
|
|
675
675
|
*/
|
|
@@ -776,7 +776,7 @@ export class BankAccountsApi extends BaseAPI {
|
|
|
776
776
|
}
|
|
777
777
|
|
|
778
778
|
/**
|
|
779
|
-
* Returns a list of bank accounts you have previously created.
|
|
779
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
780
780
|
* @summary List bank accounts
|
|
781
781
|
* @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
|
|
782
782
|
* @param {*} [options] Override http request option.
|
package/api/bank-orders-api.ts
CHANGED
|
@@ -185,16 +185,16 @@ export const BankOrdersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
185
185
|
};
|
|
186
186
|
},
|
|
187
187
|
/**
|
|
188
|
-
* Returns a list of bank orders you have previously created.
|
|
188
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
189
189
|
* @summary List bank orders
|
|
190
190
|
* @param {string} [authorization] Bearer Token
|
|
191
191
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
192
192
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
193
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, tenantBankAccountCode</i>
|
|
194
194
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, description, orderNumber, tenantBankAccountCode</i>
|
|
195
195
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
|
|
196
196
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: tenantBankAccount, xmlFile<i>
|
|
197
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
197
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, tenantBankAccountCode</i>
|
|
198
198
|
* @param {*} [options] Override http request option.
|
|
199
199
|
* @throws {RequiredError}
|
|
200
200
|
*/
|
|
@@ -359,16 +359,16 @@ export const BankOrdersApiFp = function(configuration?: Configuration) {
|
|
|
359
359
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
360
360
|
},
|
|
361
361
|
/**
|
|
362
|
-
* Returns a list of bank orders you have previously created.
|
|
362
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
363
363
|
* @summary List bank orders
|
|
364
364
|
* @param {string} [authorization] Bearer Token
|
|
365
365
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
366
366
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
367
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
367
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, tenantBankAccountCode</i>
|
|
368
368
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, description, orderNumber, tenantBankAccountCode</i>
|
|
369
369
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
|
|
370
370
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: tenantBankAccount, xmlFile<i>
|
|
371
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
371
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, tenantBankAccountCode</i>
|
|
372
372
|
* @param {*} [options] Override http request option.
|
|
373
373
|
* @throws {RequiredError}
|
|
374
374
|
*/
|
|
@@ -434,16 +434,16 @@ export const BankOrdersApiFactory = function (configuration?: Configuration, bas
|
|
|
434
434
|
return localVarFp.getBankOrder(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
435
435
|
},
|
|
436
436
|
/**
|
|
437
|
-
* Returns a list of bank orders you have previously created.
|
|
437
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
438
438
|
* @summary List bank orders
|
|
439
439
|
* @param {string} [authorization] Bearer Token
|
|
440
440
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
441
441
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
442
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
442
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, tenantBankAccountCode</i>
|
|
443
443
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, description, orderNumber, tenantBankAccountCode</i>
|
|
444
444
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
|
|
445
445
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: tenantBankAccount, xmlFile<i>
|
|
446
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
446
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, tenantBankAccountCode</i>
|
|
447
447
|
* @param {*} [options] Override http request option.
|
|
448
448
|
* @throws {RequiredError}
|
|
449
449
|
*/
|
|
@@ -563,7 +563,7 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
563
563
|
readonly pageToken?: string
|
|
564
564
|
|
|
565
565
|
/**
|
|
566
|
-
* Filter the response by one or multiple fields.
|
|
566
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, tenantBankAccountCode</i>
|
|
567
567
|
* @type {string}
|
|
568
568
|
* @memberof BankOrdersApiListBankOrders
|
|
569
569
|
*/
|
|
@@ -591,7 +591,7 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
591
591
|
readonly expand?: string
|
|
592
592
|
|
|
593
593
|
/**
|
|
594
|
-
* Filters the response by one or multiple fields.
|
|
594
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, tenantBankAccountCode</i>
|
|
595
595
|
* @type {string}
|
|
596
596
|
* @memberof BankOrdersApiListBankOrders
|
|
597
597
|
*/
|
|
@@ -670,7 +670,7 @@ export class BankOrdersApi extends BaseAPI {
|
|
|
670
670
|
}
|
|
671
671
|
|
|
672
672
|
/**
|
|
673
|
-
* Returns a list of bank orders you have previously created.
|
|
673
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
674
674
|
* @summary List bank orders
|
|
675
675
|
* @param {BankOrdersApiListBankOrdersRequest} requestParameters Request parameters.
|
|
676
676
|
* @param {*} [options] Override http request option.
|
|
@@ -244,16 +244,16 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
244
244
|
};
|
|
245
245
|
},
|
|
246
246
|
/**
|
|
247
|
-
* Returns a list of bank transactions you have previously created.
|
|
247
|
+
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
248
248
|
* @summary List bank transactions
|
|
249
249
|
* @param {string} [authorization] Bearer Token
|
|
250
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
252
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
253
253
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
254
254
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
255
255
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
256
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
256
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -425,16 +425,16 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
425
425
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
426
426
|
},
|
|
427
427
|
/**
|
|
428
|
-
* Returns a list of bank transactions you have previously created.
|
|
428
|
+
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
429
429
|
* @summary List bank transactions
|
|
430
430
|
* @param {string} [authorization] Bearer Token
|
|
431
431
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
432
432
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
433
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
433
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
434
434
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
435
435
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
436
436
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
437
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
437
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
438
438
|
* @param {*} [options] Override http request option.
|
|
439
439
|
* @throws {RequiredError}
|
|
440
440
|
*/
|
|
@@ -511,16 +511,16 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
511
511
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
512
512
|
},
|
|
513
513
|
/**
|
|
514
|
-
* Returns a list of bank transactions you have previously created.
|
|
514
|
+
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
515
515
|
* @summary List bank transactions
|
|
516
516
|
* @param {string} [authorization] Bearer Token
|
|
517
517
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
518
518
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
519
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
519
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
520
520
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
521
521
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
522
522
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
523
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
523
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
524
524
|
* @param {*} [options] Override http request option.
|
|
525
525
|
* @throws {RequiredError}
|
|
526
526
|
*/
|
|
@@ -667,7 +667,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
667
667
|
readonly pageToken?: string
|
|
668
668
|
|
|
669
669
|
/**
|
|
670
|
-
* Filter the response by one or multiple fields.
|
|
670
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
671
671
|
* @type {string}
|
|
672
672
|
* @memberof BankTransactionApiListBankTransactions
|
|
673
673
|
*/
|
|
@@ -695,7 +695,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
695
695
|
readonly expand?: string
|
|
696
696
|
|
|
697
697
|
/**
|
|
698
|
-
* Filters the response by one or multiple fields.
|
|
698
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
699
699
|
* @type {string}
|
|
700
700
|
* @memberof BankTransactionApiListBankTransactions
|
|
701
701
|
*/
|
|
@@ -779,7 +779,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
779
779
|
}
|
|
780
780
|
|
|
781
781
|
/**
|
|
782
|
-
* Returns a list of bank transactions you have previously created.
|
|
782
|
+
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
783
783
|
* @summary List bank transactions
|
|
784
784
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
785
785
|
* @param {*} [options] Override http request option.
|
|
@@ -180,16 +180,16 @@ export const BillingAddressesApiAxiosParamCreator = function (configuration?: Co
|
|
|
180
180
|
};
|
|
181
181
|
},
|
|
182
182
|
/**
|
|
183
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
183
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
184
184
|
* @summary List Billing Addresses
|
|
185
185
|
* @param {string} [authorization] Bearer Token
|
|
186
186
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
187
187
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
188
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
188
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
189
189
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: firstName, lastName, accountCode, partnerCode</i>
|
|
190
190
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt</i>
|
|
191
191
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
192
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
192
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
193
193
|
* @param {*} [options] Override http request option.
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
*/
|
|
@@ -353,16 +353,16 @@ export const BillingAddressesApiFp = function(configuration?: Configuration) {
|
|
|
353
353
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
354
354
|
},
|
|
355
355
|
/**
|
|
356
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
356
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
357
357
|
* @summary List Billing Addresses
|
|
358
358
|
* @param {string} [authorization] Bearer Token
|
|
359
359
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
360
360
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
361
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
361
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
362
362
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: firstName, lastName, accountCode, partnerCode</i>
|
|
363
363
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt</i>
|
|
364
364
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
365
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
365
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
366
366
|
* @param {*} [options] Override http request option.
|
|
367
367
|
* @throws {RequiredError}
|
|
368
368
|
*/
|
|
@@ -427,16 +427,16 @@ export const BillingAddressesApiFactory = function (configuration?: Configuratio
|
|
|
427
427
|
return localVarFp.getBillingAddress(code, authorization, options).then((request) => request(axios, basePath));
|
|
428
428
|
},
|
|
429
429
|
/**
|
|
430
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
430
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
431
431
|
* @summary List Billing Addresses
|
|
432
432
|
* @param {string} [authorization] Bearer Token
|
|
433
433
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
434
434
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
435
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
435
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
436
436
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: firstName, lastName, accountCode, partnerCode</i>
|
|
437
437
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt</i>
|
|
438
438
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
439
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
439
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
440
440
|
* @param {*} [options] Override http request option.
|
|
441
441
|
* @throws {RequiredError}
|
|
442
442
|
*/
|
|
@@ -549,7 +549,7 @@ export interface BillingAddressesApiListBillingAddressesRequest {
|
|
|
549
549
|
readonly pageToken?: string
|
|
550
550
|
|
|
551
551
|
/**
|
|
552
|
-
* Filter the response by one or multiple fields.
|
|
552
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
553
553
|
* @type {string}
|
|
554
554
|
* @memberof BillingAddressesApiListBillingAddresses
|
|
555
555
|
*/
|
|
@@ -577,7 +577,7 @@ export interface BillingAddressesApiListBillingAddressesRequest {
|
|
|
577
577
|
readonly expand?: string
|
|
578
578
|
|
|
579
579
|
/**
|
|
580
|
-
* Filters the response by one or multiple fields.
|
|
580
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
581
581
|
* @type {string}
|
|
582
582
|
* @memberof BillingAddressesApiListBillingAddresses
|
|
583
583
|
*/
|
|
@@ -656,7 +656,7 @@ export class BillingAddressesApi extends BaseAPI {
|
|
|
656
656
|
}
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
659
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
660
660
|
* @summary List Billing Addresses
|
|
661
661
|
* @param {BillingAddressesApiListBillingAddressesRequest} requestParameters Request parameters.
|
|
662
662
|
* @param {*} [options] Override http request option.
|
|
@@ -131,16 +131,16 @@ export const CreditAllocationApiAxiosParamCreator = function (configuration?: Co
|
|
|
131
131
|
};
|
|
132
132
|
},
|
|
133
133
|
/**
|
|
134
|
-
* Returns a list of credit allocations you have previously created.
|
|
134
|
+
* Returns a list of credit allocations you have previously created. The credit allocations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
135
135
|
* @summary List credit allocations
|
|
136
136
|
* @param {string} [authorization] Bearer Token
|
|
137
137
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
138
138
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
139
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
139
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, createdAt, updatedAt</i>
|
|
140
140
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode</i>
|
|
141
141
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
142
142
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: exceedingCredits<i>
|
|
143
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
143
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, createdAt, updatedAt</i>
|
|
144
144
|
* @param {*} [options] Override http request option.
|
|
145
145
|
* @throws {RequiredError}
|
|
146
146
|
*/
|
|
@@ -241,16 +241,16 @@ export const CreditAllocationApiFp = function(configuration?: Configuration) {
|
|
|
241
241
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
242
242
|
},
|
|
243
243
|
/**
|
|
244
|
-
* Returns a list of credit allocations you have previously created.
|
|
244
|
+
* Returns a list of credit allocations you have previously created. The credit allocations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
245
245
|
* @summary List credit allocations
|
|
246
246
|
* @param {string} [authorization] Bearer Token
|
|
247
247
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
248
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
249
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
249
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, createdAt, updatedAt</i>
|
|
250
250
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode</i>
|
|
251
251
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
252
252
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: exceedingCredits<i>
|
|
253
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
253
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, createdAt, updatedAt</i>
|
|
254
254
|
* @param {*} [options] Override http request option.
|
|
255
255
|
* @throws {RequiredError}
|
|
256
256
|
*/
|
|
@@ -291,16 +291,16 @@ export const CreditAllocationApiFactory = function (configuration?: Configuratio
|
|
|
291
291
|
return localVarFp.getCreditAllocation(code, authorization, options).then((request) => request(axios, basePath));
|
|
292
292
|
},
|
|
293
293
|
/**
|
|
294
|
-
* Returns a list of credit allocations you have previously created.
|
|
294
|
+
* Returns a list of credit allocations you have previously created. The credit allocations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
295
295
|
* @summary List credit allocations
|
|
296
296
|
* @param {string} [authorization] Bearer Token
|
|
297
297
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
298
298
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
299
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
299
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, createdAt, updatedAt</i>
|
|
300
300
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode</i>
|
|
301
301
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
302
302
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: exceedingCredits<i>
|
|
303
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
303
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, createdAt, updatedAt</i>
|
|
304
304
|
* @param {*} [options] Override http request option.
|
|
305
305
|
* @throws {RequiredError}
|
|
306
306
|
*/
|
|
@@ -380,7 +380,7 @@ export interface CreditAllocationApiListCreditAllocationsRequest {
|
|
|
380
380
|
readonly pageToken?: string
|
|
381
381
|
|
|
382
382
|
/**
|
|
383
|
-
* Filter the response by one or multiple fields.
|
|
383
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, createdAt, updatedAt</i>
|
|
384
384
|
* @type {string}
|
|
385
385
|
* @memberof CreditAllocationApiListCreditAllocations
|
|
386
386
|
*/
|
|
@@ -408,7 +408,7 @@ export interface CreditAllocationApiListCreditAllocationsRequest {
|
|
|
408
408
|
readonly expand?: string
|
|
409
409
|
|
|
410
410
|
/**
|
|
411
|
-
* Filters the response by one or multiple fields.
|
|
411
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, createdAt, updatedAt</i>
|
|
412
412
|
* @type {string}
|
|
413
413
|
* @memberof CreditAllocationApiListCreditAllocations
|
|
414
414
|
*/
|
|
@@ -447,7 +447,7 @@ export class CreditAllocationApi extends BaseAPI {
|
|
|
447
447
|
}
|
|
448
448
|
|
|
449
449
|
/**
|
|
450
|
-
* Returns a list of credit allocations you have previously created.
|
|
450
|
+
* Returns a list of credit allocations you have previously created. The credit allocations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
451
451
|
* @summary List credit allocations
|
|
452
452
|
* @param {CreditAllocationApiListCreditAllocationsRequest} requestParameters Request parameters.
|
|
453
453
|
* @param {*} [options] Override http request option.
|