@emilgroup/payment-sdk 1.16.1-beta.6 → 1.16.1-beta.60
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/api/refunds-api.ts
CHANGED
|
@@ -132,16 +132,16 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
132
132
|
};
|
|
133
133
|
},
|
|
134
134
|
/**
|
|
135
|
-
* Returns a list of refunds you have previously created.
|
|
135
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
136
136
|
* @summary List refunds
|
|
137
137
|
* @param {string} [authorization] Bearer Token
|
|
138
138
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
139
139
|
* @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.
|
|
140
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
140
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
141
141
|
* @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, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
142
142
|
* @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, amount</i>
|
|
143
143
|
* @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: refundItems<i>
|
|
144
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
144
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
145
145
|
* @param {*} [options] Override http request option.
|
|
146
146
|
* @throws {RequiredError}
|
|
147
147
|
*/
|
|
@@ -243,16 +243,16 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
243
243
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
244
244
|
},
|
|
245
245
|
/**
|
|
246
|
-
* Returns a list of refunds you have previously created.
|
|
246
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
247
247
|
* @summary List refunds
|
|
248
248
|
* @param {string} [authorization] Bearer Token
|
|
249
249
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
250
250
|
* @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.
|
|
251
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
251
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
252
252
|
* @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, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
253
253
|
* @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, amount</i>
|
|
254
254
|
* @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: refundItems<i>
|
|
255
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
255
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
256
256
|
* @param {*} [options] Override http request option.
|
|
257
257
|
* @throws {RequiredError}
|
|
258
258
|
*/
|
|
@@ -294,16 +294,16 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
294
294
|
return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
295
295
|
},
|
|
296
296
|
/**
|
|
297
|
-
* Returns a list of refunds you have previously created.
|
|
297
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
298
298
|
* @summary List refunds
|
|
299
299
|
* @param {string} [authorization] Bearer Token
|
|
300
300
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
301
301
|
* @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.
|
|
302
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
302
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
303
303
|
* @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, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
304
304
|
* @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, amount</i>
|
|
305
305
|
* @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: refundItems<i>
|
|
306
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
306
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
307
307
|
* @param {*} [options] Override http request option.
|
|
308
308
|
* @throws {RequiredError}
|
|
309
309
|
*/
|
|
@@ -390,7 +390,7 @@ export interface RefundsApiListRefundsRequest {
|
|
|
390
390
|
readonly pageToken?: string
|
|
391
391
|
|
|
392
392
|
/**
|
|
393
|
-
* Filter the response by one or multiple fields.
|
|
393
|
+
* 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, status, reason, psp, accountCode, invoiceCode</i>
|
|
394
394
|
* @type {string}
|
|
395
395
|
* @memberof RefundsApiListRefunds
|
|
396
396
|
*/
|
|
@@ -418,7 +418,7 @@ export interface RefundsApiListRefundsRequest {
|
|
|
418
418
|
readonly expand?: string
|
|
419
419
|
|
|
420
420
|
/**
|
|
421
|
-
* Filters the response by one or multiple fields.
|
|
421
|
+
* 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, status, reason, psp, accountCode, invoiceCode</i>
|
|
422
422
|
* @type {string}
|
|
423
423
|
* @memberof RefundsApiListRefunds
|
|
424
424
|
*/
|
|
@@ -457,7 +457,7 @@ export class RefundsApi extends BaseAPI {
|
|
|
457
457
|
}
|
|
458
458
|
|
|
459
459
|
/**
|
|
460
|
-
* Returns a list of refunds you have previously created.
|
|
460
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
461
461
|
* @summary List refunds
|
|
462
462
|
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
463
463
|
* @param {*} [options] Override http request option.
|
|
@@ -181,16 +181,16 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
|
|
|
181
181
|
};
|
|
182
182
|
},
|
|
183
183
|
/**
|
|
184
|
-
* Returns a list of tenant bank accounts you have previously created.
|
|
184
|
+
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
185
185
|
* @summary List tenant bank accounts
|
|
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, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</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: id, iban, bankName, accountName</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, createdAt, bankName, accountName</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: bankTransactions<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, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
|
|
194
194
|
* @param {*} [options] Override http request option.
|
|
195
195
|
* @throws {RequiredError}
|
|
196
196
|
*/
|
|
@@ -355,16 +355,16 @@ export const TenantBankAccountApiFp = function(configuration?: Configuration) {
|
|
|
355
355
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
356
356
|
},
|
|
357
357
|
/**
|
|
358
|
-
* Returns a list of tenant bank accounts you have previously created.
|
|
358
|
+
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
359
359
|
* @summary List tenant bank accounts
|
|
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, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</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: id, iban, bankName, accountName</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, createdAt, bankName, accountName</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: bankTransactions<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, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
|
|
368
368
|
* @param {*} [options] Override http request option.
|
|
369
369
|
* @throws {RequiredError}
|
|
370
370
|
*/
|
|
@@ -430,16 +430,16 @@ export const TenantBankAccountApiFactory = function (configuration?: Configurati
|
|
|
430
430
|
return localVarFp.getTenantBankAccount(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
431
431
|
},
|
|
432
432
|
/**
|
|
433
|
-
* Returns a list of tenant bank accounts you have previously created.
|
|
433
|
+
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
434
434
|
* @summary List tenant bank accounts
|
|
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, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</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: id, iban, bankName, accountName</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, createdAt, bankName, accountName</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: bankTransactions<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, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
|
|
443
443
|
* @param {*} [options] Override http request option.
|
|
444
444
|
* @throws {RequiredError}
|
|
445
445
|
*/
|
|
@@ -559,7 +559,7 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
|
|
|
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, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
|
|
563
563
|
* @type {string}
|
|
564
564
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
565
565
|
*/
|
|
@@ -587,7 +587,7 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
|
|
|
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, iban, bankName, accountName, sepaPainVersion, payoutPainVersion</i>
|
|
591
591
|
* @type {string}
|
|
592
592
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
593
593
|
*/
|
|
@@ -666,7 +666,7 @@ export class TenantBankAccountApi extends BaseAPI {
|
|
|
666
666
|
}
|
|
667
667
|
|
|
668
668
|
/**
|
|
669
|
-
* Returns a list of tenant bank accounts you have previously created.
|
|
669
|
+
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
670
670
|
* @summary List tenant bank accounts
|
|
671
671
|
* @param {TenantBankAccountApiListTenantBankAccountsRequest} requestParameters Request parameters.
|
|
672
672
|
* @param {*} [options] Override http request option.
|
package/api.ts
CHANGED
|
@@ -27,7 +27,9 @@ import { BillingAddressesApi } from './api';
|
|
|
27
27
|
import { CreditAllocationApi } from './api';
|
|
28
28
|
import { ExceedingCreditsApi } from './api';
|
|
29
29
|
import { HealthCheckApi } from './api';
|
|
30
|
+
import { IBANValidatorApi } from './api';
|
|
30
31
|
import { PaymentMethodsApi } from './api';
|
|
32
|
+
import { PaymentReceiptsApi } from './api';
|
|
31
33
|
import { PaymentRemindersApi } from './api';
|
|
32
34
|
import { PaymentRequestsApi } from './api';
|
|
33
35
|
import { PaymentSetupApi } from './api';
|
|
@@ -46,7 +48,9 @@ export * from './api/billing-addresses-api';
|
|
|
46
48
|
export * from './api/credit-allocation-api';
|
|
47
49
|
export * from './api/exceeding-credits-api';
|
|
48
50
|
export * from './api/health-check-api';
|
|
51
|
+
export * from './api/ibanvalidator-api';
|
|
49
52
|
export * from './api/payment-methods-api';
|
|
53
|
+
export * from './api/payment-receipts-api';
|
|
50
54
|
export * from './api/payment-reminders-api';
|
|
51
55
|
export * from './api/payment-requests-api';
|
|
52
56
|
export * from './api/payment-setup-api';
|
|
@@ -53,16 +53,16 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
|
|
|
53
53
|
*/
|
|
54
54
|
getBankAccount: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of bank accounts you have previously created.
|
|
56
|
+
* 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\"
|
|
57
57
|
* @summary List bank accounts
|
|
58
58
|
* @param {string} [authorization] Bearer Token
|
|
59
59
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
60
60
|
* @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.
|
|
61
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
62
|
-
* @param {string} [search]
|
|
61
|
+
* @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>
|
|
62
|
+
* @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>
|
|
63
63
|
* @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>
|
|
64
64
|
* @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>
|
|
65
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
65
|
+
* @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>
|
|
66
66
|
* @param {*} [options] Override http request option.
|
|
67
67
|
* @throws {RequiredError}
|
|
68
68
|
*/
|
|
@@ -122,16 +122,16 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
|
|
|
122
122
|
*/
|
|
123
123
|
getBankAccount(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankAccountResponseClass>>;
|
|
124
124
|
/**
|
|
125
|
-
* Returns a list of bank accounts you have previously created.
|
|
125
|
+
* 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\"
|
|
126
126
|
* @summary List bank accounts
|
|
127
127
|
* @param {string} [authorization] Bearer Token
|
|
128
128
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
129
129
|
* @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.
|
|
130
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
131
|
-
* @param {string} [search]
|
|
130
|
+
* @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>
|
|
131
|
+
* @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>
|
|
132
132
|
* @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>
|
|
133
133
|
* @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>
|
|
134
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
134
|
+
* @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>
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
@@ -191,16 +191,16 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
|
|
|
191
191
|
*/
|
|
192
192
|
getBankAccount(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankAccountResponseClass>;
|
|
193
193
|
/**
|
|
194
|
-
* Returns a list of bank accounts you have previously created.
|
|
194
|
+
* 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\"
|
|
195
195
|
* @summary List bank accounts
|
|
196
196
|
* @param {string} [authorization] Bearer Token
|
|
197
197
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
198
198
|
* @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.
|
|
199
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
200
|
-
* @param {string} [search]
|
|
199
|
+
* @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>
|
|
200
|
+
* @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>
|
|
201
201
|
* @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>
|
|
202
202
|
* @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>
|
|
203
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
203
|
+
* @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>
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
@@ -314,13 +314,13 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
314
314
|
*/
|
|
315
315
|
readonly pageToken?: string;
|
|
316
316
|
/**
|
|
317
|
-
* Filter the response by one or multiple fields.
|
|
317
|
+
* 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>
|
|
318
318
|
* @type {string}
|
|
319
319
|
* @memberof BankAccountsApiListBankAccounts
|
|
320
320
|
*/
|
|
321
321
|
readonly filter?: string;
|
|
322
322
|
/**
|
|
323
|
-
*
|
|
323
|
+
* 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>
|
|
324
324
|
* @type {string}
|
|
325
325
|
* @memberof BankAccountsApiListBankAccounts
|
|
326
326
|
*/
|
|
@@ -338,7 +338,7 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
338
338
|
*/
|
|
339
339
|
readonly expand?: string;
|
|
340
340
|
/**
|
|
341
|
-
* Filters the response by one or multiple fields.
|
|
341
|
+
* 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>
|
|
342
342
|
* @type {string}
|
|
343
343
|
* @memberof BankAccountsApiListBankAccounts
|
|
344
344
|
*/
|
|
@@ -429,7 +429,7 @@ export declare class BankAccountsApi extends BaseAPI {
|
|
|
429
429
|
*/
|
|
430
430
|
getBankAccount(requestParameters: BankAccountsApiGetBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankAccountResponseClass, any, {}>>;
|
|
431
431
|
/**
|
|
432
|
-
* Returns a list of bank accounts you have previously created.
|
|
432
|
+
* 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\"
|
|
433
433
|
* @summary List bank accounts
|
|
434
434
|
* @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
|
|
435
435
|
* @param {*} [options] Override http request option.
|
|
@@ -242,16 +242,16 @@ var BankAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
242
242
|
});
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
245
|
-
* Returns a list of bank accounts you have previously created.
|
|
245
|
+
* 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\"
|
|
246
246
|
* @summary List bank accounts
|
|
247
247
|
* @param {string} [authorization] Bearer Token
|
|
248
248
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
249
249
|
* @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.
|
|
250
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
251
|
-
* @param {string} [search]
|
|
250
|
+
* @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>
|
|
251
|
+
* @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>
|
|
252
252
|
* @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>
|
|
253
253
|
* @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>
|
|
254
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
254
|
+
* @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>
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
256
256
|
* @throws {RequiredError}
|
|
257
257
|
*/
|
|
@@ -494,16 +494,16 @@ var BankAccountsApiFp = function (configuration) {
|
|
|
494
494
|
});
|
|
495
495
|
},
|
|
496
496
|
/**
|
|
497
|
-
* Returns a list of bank accounts you have previously created.
|
|
497
|
+
* 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\"
|
|
498
498
|
* @summary List bank accounts
|
|
499
499
|
* @param {string} [authorization] Bearer Token
|
|
500
500
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
501
501
|
* @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.
|
|
502
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
503
|
-
* @param {string} [search]
|
|
502
|
+
* @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>
|
|
503
|
+
* @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>
|
|
504
504
|
* @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>
|
|
505
505
|
* @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>
|
|
506
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
506
|
+
* @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>
|
|
507
507
|
* @param {*} [options] Override http request option.
|
|
508
508
|
* @throws {RequiredError}
|
|
509
509
|
*/
|
|
@@ -609,16 +609,16 @@ var BankAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
609
609
|
return localVarFp.getBankAccount(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
610
610
|
},
|
|
611
611
|
/**
|
|
612
|
-
* Returns a list of bank accounts you have previously created.
|
|
612
|
+
* 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\"
|
|
613
613
|
* @summary List bank accounts
|
|
614
614
|
* @param {string} [authorization] Bearer Token
|
|
615
615
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
616
616
|
* @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.
|
|
617
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
618
|
-
* @param {string} [search]
|
|
617
|
+
* @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>
|
|
618
|
+
* @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>
|
|
619
619
|
* @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>
|
|
620
620
|
* @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>
|
|
621
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
621
|
+
* @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>
|
|
622
622
|
* @param {*} [options] Override http request option.
|
|
623
623
|
* @throws {RequiredError}
|
|
624
624
|
*/
|
|
@@ -700,7 +700,7 @@ var BankAccountsApi = /** @class */ (function (_super) {
|
|
|
700
700
|
return (0, exports.BankAccountsApiFp)(this.configuration).getBankAccount(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
701
701
|
};
|
|
702
702
|
/**
|
|
703
|
-
* Returns a list of bank accounts you have previously created.
|
|
703
|
+
* 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\"
|
|
704
704
|
* @summary List bank accounts
|
|
705
705
|
* @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
|
|
706
706
|
* @param {*} [options] Override http request option.
|
|
@@ -24,7 +24,7 @@ import { UpdateBankOrderResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
27
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
28
28
|
* @summary Create the bank order
|
|
29
29
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
30
30
|
* @param {string} [authorization] Bearer Token
|
|
@@ -52,16 +52,16 @@ export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
52
52
|
*/
|
|
53
53
|
getBankOrder: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of bank orders you have previously created.
|
|
55
|
+
* 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\"
|
|
56
56
|
* @summary List bank orders
|
|
57
57
|
* @param {string} [authorization] Bearer Token
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
59
|
* @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.
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
60
|
+
* @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>
|
|
61
61
|
* @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>
|
|
62
62
|
* @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>
|
|
63
63
|
* @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>
|
|
64
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
64
|
+
* @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>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -83,7 +83,7 @@ export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
83
83
|
*/
|
|
84
84
|
export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
85
85
|
/**
|
|
86
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
86
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
87
87
|
* @summary Create the bank order
|
|
88
88
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
89
89
|
* @param {string} [authorization] Bearer Token
|
|
@@ -111,16 +111,16 @@ export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
|
111
111
|
*/
|
|
112
112
|
getBankOrder(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankOrderResponseClass>>;
|
|
113
113
|
/**
|
|
114
|
-
* Returns a list of bank orders you have previously created.
|
|
114
|
+
* 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\"
|
|
115
115
|
* @summary List bank orders
|
|
116
116
|
* @param {string} [authorization] Bearer Token
|
|
117
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
118
|
* @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.
|
|
119
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
119
|
+
* @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>
|
|
120
120
|
* @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>
|
|
121
121
|
* @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>
|
|
122
122
|
* @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>
|
|
123
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
123
|
+
* @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>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
@@ -142,7 +142,7 @@ export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
|
142
142
|
*/
|
|
143
143
|
export declare const BankOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
144
144
|
/**
|
|
145
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
145
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
146
146
|
* @summary Create the bank order
|
|
147
147
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
148
148
|
* @param {string} [authorization] Bearer Token
|
|
@@ -170,16 +170,16 @@ export declare const BankOrdersApiFactory: (configuration?: Configuration, baseP
|
|
|
170
170
|
*/
|
|
171
171
|
getBankOrder(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankOrderResponseClass>;
|
|
172
172
|
/**
|
|
173
|
-
* Returns a list of bank orders you have previously created.
|
|
173
|
+
* 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\"
|
|
174
174
|
* @summary List bank orders
|
|
175
175
|
* @param {string} [authorization] Bearer Token
|
|
176
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
177
|
* @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.
|
|
178
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
178
|
+
* @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>
|
|
179
179
|
* @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>
|
|
180
180
|
* @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>
|
|
181
181
|
* @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>
|
|
182
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
182
|
+
* @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>
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
@@ -283,7 +283,7 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
283
283
|
*/
|
|
284
284
|
readonly pageToken?: string;
|
|
285
285
|
/**
|
|
286
|
-
* Filter the response by one or multiple fields.
|
|
286
|
+
* 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>
|
|
287
287
|
* @type {string}
|
|
288
288
|
* @memberof BankOrdersApiListBankOrders
|
|
289
289
|
*/
|
|
@@ -307,7 +307,7 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
307
307
|
*/
|
|
308
308
|
readonly expand?: string;
|
|
309
309
|
/**
|
|
310
|
-
* Filters the response by one or multiple fields.
|
|
310
|
+
* 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>
|
|
311
311
|
* @type {string}
|
|
312
312
|
* @memberof BankOrdersApiListBankOrders
|
|
313
313
|
*/
|
|
@@ -346,7 +346,7 @@ export interface BankOrdersApiUpdateBankOrderRequest {
|
|
|
346
346
|
*/
|
|
347
347
|
export declare class BankOrdersApi extends BaseAPI {
|
|
348
348
|
/**
|
|
349
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
349
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
350
350
|
* @summary Create the bank order
|
|
351
351
|
* @param {BankOrdersApiCreateBankOrderRequest} requestParameters Request parameters.
|
|
352
352
|
* @param {*} [options] Override http request option.
|
|
@@ -373,7 +373,7 @@ export declare class BankOrdersApi extends BaseAPI {
|
|
|
373
373
|
*/
|
|
374
374
|
getBankOrder(requestParameters: BankOrdersApiGetBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankOrderResponseClass, any, {}>>;
|
|
375
375
|
/**
|
|
376
|
-
* Returns a list of bank orders you have previously created.
|
|
376
|
+
* 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\"
|
|
377
377
|
* @summary List bank orders
|
|
378
378
|
* @param {BankOrdersApiListBankOrdersRequest} requestParameters Request parameters.
|
|
379
379
|
* @param {*} [options] Override http request option.
|