@emilgroup/payment-sdk 1.16.1-beta.6 → 1.16.1-beta.61
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/.openapi-generator/FILES +12 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +16 -16
- package/api/bank-orders-api.ts +16 -16
- 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/ibanvalidator-api.ts +165 -0
- package/api/payment-methods-api.ts +12 -12
- package/api/payment-receipts-api.ts +676 -0
- package/api/payment-reminders-api.ts +12 -12
- package/api/payment-requests-api.ts +20 -20
- package/api/payments-api.ts +12 -12
- package/api/payout-methods-api.ts +138 -20
- package/api/refunds-api.ts +12 -12
- package/api/tenant-bank-account-api.ts +12 -12
- package/api.ts +4 -0
- package/dist/api/bank-accounts-api.d.ts +16 -16
- package/dist/api/bank-accounts-api.js +13 -13
- package/dist/api/bank-orders-api.d.ts +16 -16
- package/dist/api/bank-orders-api.js +14 -14
- 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/ibanvalidator-api.d.ts +97 -0
- package/dist/api/ibanvalidator-api.js +224 -0
- package/dist/api/payment-methods-api.d.ts +12 -12
- package/dist/api/payment-methods-api.js +10 -10
- package/dist/api/payment-receipts-api.d.ts +383 -0
- package/dist/api/payment-receipts-api.js +637 -0
- 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 +20 -20
- package/dist/api/payment-requests-api.js +15 -15
- 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 +85 -20
- package/dist/api/payout-methods-api.js +115 -16
- 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/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/bank-account-class-without-expand-properties.d.ts +6 -0
- package/dist/models/bank-account-class.d.ts +6 -0
- package/dist/models/bank-data-class.d.ts +36 -0
- package/dist/models/bank-data-class.js +15 -0
- package/dist/models/create-payment-receipt-request-dto.d.ts +65 -0
- package/dist/models/create-payment-receipt-request-dto.js +20 -0
- package/dist/models/create-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/create-payment-receipt-response-class.js +15 -0
- package/dist/models/create-payment-request-request-dto.d.ts +48 -11
- package/dist/models/create-payment-request-request-dto.js +8 -4
- package/dist/models/create-payout-method-by-bank-account-request-dto.d.ts +36 -0
- package/dist/models/create-payout-method-by-bank-account-request-dto.js +15 -0
- package/dist/models/create-payout-method-request-dto.d.ts +8 -2
- package/dist/models/get-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/get-payment-receipt-response-class.js +15 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/list-payment-receipts-response-class.d.ts +43 -0
- package/dist/models/list-payment-receipts-response-class.js +15 -0
- package/dist/models/payment-receipt-class.d.ts +101 -0
- package/dist/models/payment-receipt-class.js +20 -0
- package/dist/models/payment-request-class.d.ts +56 -12
- package/dist/models/payment-request-class.js +9 -5
- package/dist/models/payout-method-class.d.ts +6 -0
- package/dist/models/update-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/update-payment-receipt-response-class.js +15 -0
- package/dist/models/update-payment-request-request-dto.d.ts +2 -2
- package/dist/models/update-payment-request-request-dto.js +1 -1
- package/dist/models/validate-iban-request-dto.d.ts +24 -0
- package/dist/models/validate-iban-request-dto.js +15 -0
- package/dist/models/validate-iban-response-class.d.ts +31 -0
- package/dist/models/validate-iban-response-class.js +15 -0
- package/models/bank-account-class-without-expand-properties.ts +6 -0
- package/models/bank-account-class.ts +6 -0
- package/models/bank-data-class.ts +42 -0
- package/models/create-payment-receipt-request-dto.ts +74 -0
- package/models/create-payment-receipt-response-class.ts +31 -0
- package/models/create-payment-request-request-dto.ts +47 -11
- package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
- package/models/create-payout-method-request-dto.ts +8 -2
- package/models/get-payment-receipt-response-class.ts +31 -0
- package/models/index.ts +10 -0
- package/models/list-payment-receipts-response-class.ts +49 -0
- package/models/payment-receipt-class.ts +110 -0
- package/models/payment-request-class.ts +55 -12
- package/models/payout-method-class.ts +6 -0
- package/models/update-payment-receipt-response-class.ts +31 -0
- package/models/update-payment-request-request-dto.ts +2 -2
- package/models/validate-iban-request-dto.ts +30 -0
- package/models/validate-iban-response-class.ts +37 -0
- package/package.json +2 -2
package/.openapi-generator/FILES
CHANGED
|
@@ -10,7 +10,9 @@ api/billing-addresses-api.ts
|
|
|
10
10
|
api/credit-allocation-api.ts
|
|
11
11
|
api/exceeding-credits-api.ts
|
|
12
12
|
api/health-check-api.ts
|
|
13
|
+
api/ibanvalidator-api.ts
|
|
13
14
|
api/payment-methods-api.ts
|
|
15
|
+
api/payment-receipts-api.ts
|
|
14
16
|
api/payment-reminders-api.ts
|
|
15
17
|
api/payment-requests-api.ts
|
|
16
18
|
api/payment-setup-api.ts
|
|
@@ -28,6 +30,7 @@ index.ts
|
|
|
28
30
|
models/activate-policy-payment-method-request-dto.ts
|
|
29
31
|
models/bank-account-class-without-expand-properties.ts
|
|
30
32
|
models/bank-account-class.ts
|
|
33
|
+
models/bank-data-class.ts
|
|
31
34
|
models/bank-order-class.ts
|
|
32
35
|
models/bank-order-entity.ts
|
|
33
36
|
models/bank-order-xml-file-class.ts
|
|
@@ -60,12 +63,15 @@ models/create-credit-allocation-response-class.ts
|
|
|
60
63
|
models/create-payment-method-response-class.ts
|
|
61
64
|
models/create-payment-order-dto.ts
|
|
62
65
|
models/create-payment-order-request-dto.ts
|
|
66
|
+
models/create-payment-receipt-request-dto.ts
|
|
67
|
+
models/create-payment-receipt-response-class.ts
|
|
63
68
|
models/create-payment-reminder-request-dto.ts
|
|
64
69
|
models/create-payment-reminder-response-class.ts
|
|
65
70
|
models/create-payment-request-dto.ts
|
|
66
71
|
models/create-payment-request-request-dto.ts
|
|
67
72
|
models/create-payment-request-response-class.ts
|
|
68
73
|
models/create-payment-response-class.ts
|
|
74
|
+
models/create-payout-method-by-bank-account-request-dto.ts
|
|
69
75
|
models/create-payout-method-request-dto.ts
|
|
70
76
|
models/create-payout-method-response-class.ts
|
|
71
77
|
models/create-policy-payment-method-request-dto.ts
|
|
@@ -91,6 +97,7 @@ models/get-billing-address-response-class.ts
|
|
|
91
97
|
models/get-credit-allocation-response-class.ts
|
|
92
98
|
models/get-exceeding-credit-response-class.ts
|
|
93
99
|
models/get-payment-method-response-class.ts
|
|
100
|
+
models/get-payment-receipt-response-class.ts
|
|
94
101
|
models/get-payment-reminder-response-class.ts
|
|
95
102
|
models/get-payment-request-response-class.ts
|
|
96
103
|
models/get-payment-response-class.ts
|
|
@@ -122,6 +129,7 @@ models/list-billing-addresses-response-class.ts
|
|
|
122
129
|
models/list-credit-allocations-response-class.ts
|
|
123
130
|
models/list-exceeding-credits-response-class.ts
|
|
124
131
|
models/list-payment-methods-response-class.ts
|
|
132
|
+
models/list-payment-receipts-response-class.ts
|
|
125
133
|
models/list-payment-reminders-response-class.ts
|
|
126
134
|
models/list-payment-requests-response-class.ts
|
|
127
135
|
models/list-payments-response-class.ts
|
|
@@ -136,6 +144,7 @@ models/payment-class-without-expand-properties.ts
|
|
|
136
144
|
models/payment-class.ts
|
|
137
145
|
models/payment-entity.ts
|
|
138
146
|
models/payment-method-class.ts
|
|
147
|
+
models/payment-receipt-class.ts
|
|
139
148
|
models/payment-reminder-class.ts
|
|
140
149
|
models/payment-request-class.ts
|
|
141
150
|
models/payout-method-class.ts
|
|
@@ -162,10 +171,13 @@ models/update-bank-order-request-dto.ts
|
|
|
162
171
|
models/update-bank-order-response-class.ts
|
|
163
172
|
models/update-billing-address-request-dto.ts
|
|
164
173
|
models/update-billing-address-response-class.ts
|
|
174
|
+
models/update-payment-receipt-response-class.ts
|
|
165
175
|
models/update-payment-request-request-dto.ts
|
|
166
176
|
models/update-payment-request-response-class.ts
|
|
167
177
|
models/update-tenant-bank-account-response-class.ts
|
|
168
178
|
models/update-tenant-bank-account-rest-request-dto.ts
|
|
179
|
+
models/validate-iban-request-dto.ts
|
|
180
|
+
models/validate-iban-response-class.ts
|
|
169
181
|
models/validate-pspconfig-request-dto.ts
|
|
170
182
|
package.json
|
|
171
183
|
tsconfig.json
|
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@1.16.1-beta.
|
|
20
|
+
npm install @emilgroup/payment-sdk@1.16.1-beta.61 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/payment-sdk@1.16.1-beta.
|
|
24
|
+
yarn add @emilgroup/payment-sdk@1.16.1-beta.61
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PaymentsApi`.
|
package/api/bank-accounts-api.ts
CHANGED
|
@@ -183,16 +183,16 @@ export const BankAccountsApiAxiosParamCreator = function (configuration?: Config
|
|
|
183
183
|
};
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* Returns a list of bank accounts you have previously created.
|
|
186
|
+
* 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\"
|
|
187
187
|
* @summary List bank accounts
|
|
188
188
|
* @param {string} [authorization] Bearer Token
|
|
189
189
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
190
|
* @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.
|
|
191
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
192
|
-
* @param {string} [search]
|
|
191
|
+
* @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>
|
|
192
|
+
* @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: accountHolder, bankName</i>
|
|
193
193
|
* @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>
|
|
194
194
|
* @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>
|
|
195
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
195
|
+
* @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>
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
@@ -408,16 +408,16 @@ export const BankAccountsApiFp = function(configuration?: Configuration) {
|
|
|
408
408
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
409
409
|
},
|
|
410
410
|
/**
|
|
411
|
-
* Returns a list of bank accounts you have previously created.
|
|
411
|
+
* 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\"
|
|
412
412
|
* @summary List bank accounts
|
|
413
413
|
* @param {string} [authorization] Bearer Token
|
|
414
414
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
415
415
|
* @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.
|
|
416
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
417
|
-
* @param {string} [search]
|
|
416
|
+
* @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>
|
|
417
|
+
* @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: accountHolder, bankName</i>
|
|
418
418
|
* @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>
|
|
419
419
|
* @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>
|
|
420
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
420
|
+
* @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>
|
|
421
421
|
* @param {*} [options] Override http request option.
|
|
422
422
|
* @throws {RequiredError}
|
|
423
423
|
*/
|
|
@@ -496,16 +496,16 @@ export const BankAccountsApiFactory = function (configuration?: Configuration, b
|
|
|
496
496
|
return localVarFp.getBankAccount(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
497
497
|
},
|
|
498
498
|
/**
|
|
499
|
-
* Returns a list of bank accounts you have previously created.
|
|
499
|
+
* 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\"
|
|
500
500
|
* @summary List bank accounts
|
|
501
501
|
* @param {string} [authorization] Bearer Token
|
|
502
502
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
503
503
|
* @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.
|
|
504
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
505
|
-
* @param {string} [search]
|
|
504
|
+
* @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>
|
|
505
|
+
* @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: accountHolder, bankName</i>
|
|
506
506
|
* @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>
|
|
507
507
|
* @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>
|
|
508
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
508
|
+
* @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>
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
510
510
|
* @throws {RequiredError}
|
|
511
511
|
*/
|
|
@@ -637,14 +637,14 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
637
637
|
readonly pageToken?: string
|
|
638
638
|
|
|
639
639
|
/**
|
|
640
|
-
* Filter the response by one or multiple fields.
|
|
640
|
+
* 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>
|
|
641
641
|
* @type {string}
|
|
642
642
|
* @memberof BankAccountsApiListBankAccounts
|
|
643
643
|
*/
|
|
644
644
|
readonly filter?: string
|
|
645
645
|
|
|
646
646
|
/**
|
|
647
|
-
*
|
|
647
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: accountHolder, bankName</i>
|
|
648
648
|
* @type {string}
|
|
649
649
|
* @memberof BankAccountsApiListBankAccounts
|
|
650
650
|
*/
|
|
@@ -665,7 +665,7 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
665
665
|
readonly expand?: string
|
|
666
666
|
|
|
667
667
|
/**
|
|
668
|
-
* Filters the response by one or multiple fields.
|
|
668
|
+
* 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>
|
|
669
669
|
* @type {string}
|
|
670
670
|
* @memberof BankAccountsApiListBankAccounts
|
|
671
671
|
*/
|
|
@@ -772,7 +772,7 @@ export class BankAccountsApi extends BaseAPI {
|
|
|
772
772
|
}
|
|
773
773
|
|
|
774
774
|
/**
|
|
775
|
-
* Returns a list of bank accounts you have previously created.
|
|
775
|
+
* 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\"
|
|
776
776
|
* @summary List bank accounts
|
|
777
777
|
* @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
|
|
778
778
|
* @param {*} [options] Override http request option.
|
package/api/bank-orders-api.ts
CHANGED
|
@@ -39,7 +39,7 @@ import { UpdateBankOrderResponseClass } from '../models';
|
|
|
39
39
|
export const BankOrdersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
42
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
43
43
|
* @summary Create the bank order
|
|
44
44
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
45
45
|
* @param {string} [authorization] Bearer Token
|
|
@@ -181,16 +181,16 @@ export const BankOrdersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
181
181
|
};
|
|
182
182
|
},
|
|
183
183
|
/**
|
|
184
|
-
* Returns a list of bank orders you have previously created.
|
|
184
|
+
* 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\"
|
|
185
185
|
* @summary List bank orders
|
|
186
186
|
* @param {string} [authorization] Bearer Token
|
|
187
187
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
188
188
|
* @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.
|
|
189
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
189
|
+
* @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>
|
|
190
190
|
* @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>
|
|
191
191
|
* @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>
|
|
192
192
|
* @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>
|
|
193
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
193
|
+
* @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>
|
|
194
194
|
* @param {*} [options] Override http request option.
|
|
195
195
|
* @throws {RequiredError}
|
|
196
196
|
*/
|
|
@@ -318,7 +318,7 @@ export const BankOrdersApiFp = function(configuration?: Configuration) {
|
|
|
318
318
|
const localVarAxiosParamCreator = BankOrdersApiAxiosParamCreator(configuration)
|
|
319
319
|
return {
|
|
320
320
|
/**
|
|
321
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
321
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
322
322
|
* @summary Create the bank order
|
|
323
323
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
324
324
|
* @param {string} [authorization] Bearer Token
|
|
@@ -355,16 +355,16 @@ export const BankOrdersApiFp = function(configuration?: Configuration) {
|
|
|
355
355
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
356
356
|
},
|
|
357
357
|
/**
|
|
358
|
-
* Returns a list of bank orders you have previously created.
|
|
358
|
+
* 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\"
|
|
359
359
|
* @summary List bank orders
|
|
360
360
|
* @param {string} [authorization] Bearer Token
|
|
361
361
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
362
362
|
* @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.
|
|
363
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
363
|
+
* @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>
|
|
364
364
|
* @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>
|
|
365
365
|
* @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>
|
|
366
366
|
* @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>
|
|
367
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
367
|
+
* @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>
|
|
368
368
|
* @param {*} [options] Override http request option.
|
|
369
369
|
* @throws {RequiredError}
|
|
370
370
|
*/
|
|
@@ -396,7 +396,7 @@ export const BankOrdersApiFactory = function (configuration?: Configuration, bas
|
|
|
396
396
|
const localVarFp = BankOrdersApiFp(configuration)
|
|
397
397
|
return {
|
|
398
398
|
/**
|
|
399
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
399
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
400
400
|
* @summary Create the bank order
|
|
401
401
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
402
402
|
* @param {string} [authorization] Bearer Token
|
|
@@ -430,16 +430,16 @@ export const BankOrdersApiFactory = function (configuration?: Configuration, bas
|
|
|
430
430
|
return localVarFp.getBankOrder(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
431
431
|
},
|
|
432
432
|
/**
|
|
433
|
-
* Returns a list of bank orders you have previously created.
|
|
433
|
+
* 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\"
|
|
434
434
|
* @summary List bank orders
|
|
435
435
|
* @param {string} [authorization] Bearer Token
|
|
436
436
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
437
437
|
* @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.
|
|
438
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
438
|
+
* @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>
|
|
439
439
|
* @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>
|
|
440
440
|
* @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>
|
|
441
441
|
* @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>
|
|
442
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
442
|
+
* @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>
|
|
443
443
|
* @param {*} [options] Override http request option.
|
|
444
444
|
* @throws {RequiredError}
|
|
445
445
|
*/
|
|
@@ -559,7 +559,7 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
559
559
|
readonly pageToken?: string
|
|
560
560
|
|
|
561
561
|
/**
|
|
562
|
-
* Filter the response by one or multiple fields.
|
|
562
|
+
* 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>
|
|
563
563
|
* @type {string}
|
|
564
564
|
* @memberof BankOrdersApiListBankOrders
|
|
565
565
|
*/
|
|
@@ -587,7 +587,7 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
587
587
|
readonly expand?: string
|
|
588
588
|
|
|
589
589
|
/**
|
|
590
|
-
* Filters the response by one or multiple fields.
|
|
590
|
+
* 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>
|
|
591
591
|
* @type {string}
|
|
592
592
|
* @memberof BankOrdersApiListBankOrders
|
|
593
593
|
*/
|
|
@@ -630,7 +630,7 @@ export interface BankOrdersApiUpdateBankOrderRequest {
|
|
|
630
630
|
*/
|
|
631
631
|
export class BankOrdersApi extends BaseAPI {
|
|
632
632
|
/**
|
|
633
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
633
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
634
634
|
* @summary Create the bank order
|
|
635
635
|
* @param {BankOrdersApiCreateBankOrderRequest} requestParameters Request parameters.
|
|
636
636
|
* @param {*} [options] Override http request option.
|
|
@@ -666,7 +666,7 @@ export class BankOrdersApi extends BaseAPI {
|
|
|
666
666
|
}
|
|
667
667
|
|
|
668
668
|
/**
|
|
669
|
-
* Returns a list of bank orders you have previously created.
|
|
669
|
+
* 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\"
|
|
670
670
|
* @summary List bank orders
|
|
671
671
|
* @param {BankOrdersApiListBankOrdersRequest} requestParameters Request parameters.
|
|
672
672
|
* @param {*} [options] Override http request option.
|
|
@@ -239,16 +239,16 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
239
239
|
};
|
|
240
240
|
},
|
|
241
241
|
/**
|
|
242
|
-
* Returns a list of bank transactions you have previously created.
|
|
242
|
+
* 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\"
|
|
243
243
|
* @summary List bank transactions
|
|
244
244
|
* @param {string} [authorization] Bearer Token
|
|
245
245
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
246
246
|
* @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.
|
|
247
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
247
|
+
* @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>
|
|
248
248
|
* @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>
|
|
249
249
|
* @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>
|
|
250
250
|
* @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>
|
|
251
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
251
|
+
* @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>
|
|
252
252
|
* @param {*} [options] Override http request option.
|
|
253
253
|
* @throws {RequiredError}
|
|
254
254
|
*/
|
|
@@ -420,16 +420,16 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
420
420
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
421
421
|
},
|
|
422
422
|
/**
|
|
423
|
-
* Returns a list of bank transactions you have previously created.
|
|
423
|
+
* 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\"
|
|
424
424
|
* @summary List bank transactions
|
|
425
425
|
* @param {string} [authorization] Bearer Token
|
|
426
426
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
427
427
|
* @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.
|
|
428
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
428
|
+
* @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>
|
|
429
429
|
* @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>
|
|
430
430
|
* @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>
|
|
431
431
|
* @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>
|
|
432
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
432
|
+
* @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>
|
|
433
433
|
* @param {*} [options] Override http request option.
|
|
434
434
|
* @throws {RequiredError}
|
|
435
435
|
*/
|
|
@@ -506,16 +506,16 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
506
506
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
507
507
|
},
|
|
508
508
|
/**
|
|
509
|
-
* Returns a list of bank transactions you have previously created.
|
|
509
|
+
* 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\"
|
|
510
510
|
* @summary List bank transactions
|
|
511
511
|
* @param {string} [authorization] Bearer Token
|
|
512
512
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
513
513
|
* @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.
|
|
514
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
514
|
+
* @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>
|
|
515
515
|
* @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>
|
|
516
516
|
* @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>
|
|
517
517
|
* @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>
|
|
518
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
518
|
+
* @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>
|
|
519
519
|
* @param {*} [options] Override http request option.
|
|
520
520
|
* @throws {RequiredError}
|
|
521
521
|
*/
|
|
@@ -662,7 +662,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
662
662
|
readonly pageToken?: string
|
|
663
663
|
|
|
664
664
|
/**
|
|
665
|
-
* Filter the response by one or multiple fields.
|
|
665
|
+
* 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>
|
|
666
666
|
* @type {string}
|
|
667
667
|
* @memberof BankTransactionApiListBankTransactions
|
|
668
668
|
*/
|
|
@@ -690,7 +690,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
690
690
|
readonly expand?: string
|
|
691
691
|
|
|
692
692
|
/**
|
|
693
|
-
* Filters the response by one or multiple fields.
|
|
693
|
+
* 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>
|
|
694
694
|
* @type {string}
|
|
695
695
|
* @memberof BankTransactionApiListBankTransactions
|
|
696
696
|
*/
|
|
@@ -774,7 +774,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
774
774
|
}
|
|
775
775
|
|
|
776
776
|
/**
|
|
777
|
-
* Returns a list of bank transactions you have previously created.
|
|
777
|
+
* 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\"
|
|
778
778
|
* @summary List bank transactions
|
|
779
779
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
780
780
|
* @param {*} [options] Override http request option.
|
|
@@ -176,16 +176,16 @@ export const BillingAddressesApiAxiosParamCreator = function (configuration?: Co
|
|
|
176
176
|
};
|
|
177
177
|
},
|
|
178
178
|
/**
|
|
179
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
179
|
+
* 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\"
|
|
180
180
|
* @summary List Billing Addresses
|
|
181
181
|
* @param {string} [authorization] Bearer Token
|
|
182
182
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
183
183
|
* @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.
|
|
184
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
184
|
+
* @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>
|
|
185
185
|
* @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>
|
|
186
186
|
* @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>
|
|
187
187
|
* @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/>
|
|
188
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
188
|
+
* @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>
|
|
189
189
|
* @param {*} [options] Override http request option.
|
|
190
190
|
* @throws {RequiredError}
|
|
191
191
|
*/
|
|
@@ -349,16 +349,16 @@ export const BillingAddressesApiFp = function(configuration?: Configuration) {
|
|
|
349
349
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
350
350
|
},
|
|
351
351
|
/**
|
|
352
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
352
|
+
* 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\"
|
|
353
353
|
* @summary List Billing Addresses
|
|
354
354
|
* @param {string} [authorization] Bearer Token
|
|
355
355
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
356
356
|
* @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.
|
|
357
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
357
|
+
* @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>
|
|
358
358
|
* @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>
|
|
359
359
|
* @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>
|
|
360
360
|
* @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/>
|
|
361
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
361
|
+
* @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>
|
|
362
362
|
* @param {*} [options] Override http request option.
|
|
363
363
|
* @throws {RequiredError}
|
|
364
364
|
*/
|
|
@@ -423,16 +423,16 @@ export const BillingAddressesApiFactory = function (configuration?: Configuratio
|
|
|
423
423
|
return localVarFp.getBillingAddress(code, authorization, options).then((request) => request(axios, basePath));
|
|
424
424
|
},
|
|
425
425
|
/**
|
|
426
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
426
|
+
* 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\"
|
|
427
427
|
* @summary List Billing Addresses
|
|
428
428
|
* @param {string} [authorization] Bearer Token
|
|
429
429
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
430
430
|
* @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.
|
|
431
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
431
|
+
* @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>
|
|
432
432
|
* @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>
|
|
433
433
|
* @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>
|
|
434
434
|
* @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/>
|
|
435
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
435
|
+
* @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>
|
|
436
436
|
* @param {*} [options] Override http request option.
|
|
437
437
|
* @throws {RequiredError}
|
|
438
438
|
*/
|
|
@@ -545,7 +545,7 @@ export interface BillingAddressesApiListBillingAddressesRequest {
|
|
|
545
545
|
readonly pageToken?: string
|
|
546
546
|
|
|
547
547
|
/**
|
|
548
|
-
* Filter the response by one or multiple fields.
|
|
548
|
+
* 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>
|
|
549
549
|
* @type {string}
|
|
550
550
|
* @memberof BillingAddressesApiListBillingAddresses
|
|
551
551
|
*/
|
|
@@ -573,7 +573,7 @@ export interface BillingAddressesApiListBillingAddressesRequest {
|
|
|
573
573
|
readonly expand?: string
|
|
574
574
|
|
|
575
575
|
/**
|
|
576
|
-
* Filters the response by one or multiple fields.
|
|
576
|
+
* 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>
|
|
577
577
|
* @type {string}
|
|
578
578
|
* @memberof BillingAddressesApiListBillingAddresses
|
|
579
579
|
*/
|
|
@@ -652,7 +652,7 @@ export class BillingAddressesApi extends BaseAPI {
|
|
|
652
652
|
}
|
|
653
653
|
|
|
654
654
|
/**
|
|
655
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
655
|
+
* 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\"
|
|
656
656
|
* @summary List Billing Addresses
|
|
657
657
|
* @param {BillingAddressesApiListBillingAddressesRequest} requestParameters Request parameters.
|
|
658
658
|
* @param {*} [options] Override http request option.
|