@emilgroup/payment-sdk 1.16.1-beta.7 → 1.16.1-beta.76
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/webhooks-api.ts +125 -14
- package/api.ts +4 -0
- package/base.ts +1 -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/webhooks-api.d.ts +73 -9
- package/dist/api/webhooks-api.js +100 -11
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -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 +53 -10
- 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/credit-allocation-class.d.ts +6 -0
- package/dist/models/credit-allocation-entity.d.ts +6 -0
- 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 +68 -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 +52 -10
- 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/credit-allocation-class.ts +6 -0
- package/models/credit-allocation-entity.ts +6 -0
- 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 +67 -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/webhooks-api.ts
CHANGED
|
@@ -31,20 +31,66 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
31
31
|
* @summary Handle the webhook from PSP
|
|
32
32
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
33
33
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
34
|
-
* @param {string} productSlug
|
|
35
34
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
36
35
|
* @param {*} [options] Override http request option.
|
|
37
36
|
* @throws {RequiredError}
|
|
38
37
|
*/
|
|
39
|
-
postWebhook: async (pspType: string, tenantSlug: string,
|
|
38
|
+
postWebhook: async (pspType: string, tenantSlug: string, body: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40
39
|
// verify required parameter 'pspType' is not null or undefined
|
|
41
40
|
assertParamExists('postWebhook', 'pspType', pspType)
|
|
42
41
|
// verify required parameter 'tenantSlug' is not null or undefined
|
|
43
42
|
assertParamExists('postWebhook', 'tenantSlug', tenantSlug)
|
|
44
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
45
|
-
assertParamExists('postWebhook', 'productSlug', productSlug)
|
|
46
43
|
// verify required parameter 'body' is not null or undefined
|
|
47
44
|
assertParamExists('postWebhook', 'body', body)
|
|
45
|
+
const localVarPath = `/paymentservice/v1/webhooks/{pspType}/{tenantSlug}`
|
|
46
|
+
.replace(`{${"pspType"}}`, encodeURIComponent(String(pspType)))
|
|
47
|
+
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)));
|
|
48
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
49
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50
|
+
let baseOptions;
|
|
51
|
+
let baseAccessToken;
|
|
52
|
+
if (configuration) {
|
|
53
|
+
baseOptions = configuration.baseOptions;
|
|
54
|
+
baseAccessToken = configuration.accessToken;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
58
|
+
const localVarHeaderParameter = {} as any;
|
|
59
|
+
const localVarQueryParameter = {} as any;
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
64
|
+
|
|
65
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
67
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
68
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
69
|
+
|
|
70
|
+
return {
|
|
71
|
+
url: toPathString(localVarUrlObj),
|
|
72
|
+
options: localVarRequestOptions,
|
|
73
|
+
};
|
|
74
|
+
},
|
|
75
|
+
/**
|
|
76
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
77
|
+
* @summary Handle the webhook from PSP
|
|
78
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
79
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
80
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
81
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
postWebhookWithProductSlug: async (pspType: string, tenantSlug: string, productSlug: string, body: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
86
|
+
// verify required parameter 'pspType' is not null or undefined
|
|
87
|
+
assertParamExists('postWebhookWithProductSlug', 'pspType', pspType)
|
|
88
|
+
// verify required parameter 'tenantSlug' is not null or undefined
|
|
89
|
+
assertParamExists('postWebhookWithProductSlug', 'tenantSlug', tenantSlug)
|
|
90
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
91
|
+
assertParamExists('postWebhookWithProductSlug', 'productSlug', productSlug)
|
|
92
|
+
// verify required parameter 'body' is not null or undefined
|
|
93
|
+
assertParamExists('postWebhookWithProductSlug', 'body', body)
|
|
48
94
|
const localVarPath = `/paymentservice/v1/webhooks/{pspType}/{tenantSlug}/{productSlug}`
|
|
49
95
|
.replace(`{${"pspType"}}`, encodeURIComponent(String(pspType)))
|
|
50
96
|
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)))
|
|
@@ -91,13 +137,26 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
|
|
|
91
137
|
* @summary Handle the webhook from PSP
|
|
92
138
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
93
139
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
94
|
-
* @param {string} productSlug
|
|
95
140
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
96
141
|
* @param {*} [options] Override http request option.
|
|
97
142
|
* @throws {RequiredError}
|
|
98
143
|
*/
|
|
99
|
-
async postWebhook(pspType: string, tenantSlug: string,
|
|
100
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhook(pspType, tenantSlug,
|
|
144
|
+
async postWebhook(pspType: string, tenantSlug: string, body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
145
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhook(pspType, tenantSlug, body, options);
|
|
146
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
147
|
+
},
|
|
148
|
+
/**
|
|
149
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
150
|
+
* @summary Handle the webhook from PSP
|
|
151
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
152
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
153
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
154
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
*/
|
|
158
|
+
async postWebhookWithProductSlug(pspType: string, tenantSlug: string, productSlug: string, body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
159
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhookWithProductSlug(pspType, tenantSlug, productSlug, body, options);
|
|
101
160
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
102
161
|
},
|
|
103
162
|
}
|
|
@@ -115,13 +174,25 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
|
|
|
115
174
|
* @summary Handle the webhook from PSP
|
|
116
175
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
117
176
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
118
|
-
* @param {string} productSlug
|
|
119
177
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
120
178
|
* @param {*} [options] Override http request option.
|
|
121
179
|
* @throws {RequiredError}
|
|
122
180
|
*/
|
|
123
|
-
postWebhook(pspType: string, tenantSlug: string,
|
|
124
|
-
return localVarFp.postWebhook(pspType, tenantSlug,
|
|
181
|
+
postWebhook(pspType: string, tenantSlug: string, body: object, options?: any): AxiosPromise<void> {
|
|
182
|
+
return localVarFp.postWebhook(pspType, tenantSlug, body, options).then((request) => request(axios, basePath));
|
|
183
|
+
},
|
|
184
|
+
/**
|
|
185
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
186
|
+
* @summary Handle the webhook from PSP
|
|
187
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
188
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
189
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
190
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
*/
|
|
194
|
+
postWebhookWithProductSlug(pspType: string, tenantSlug: string, productSlug: string, body: object, options?: any): AxiosPromise<void> {
|
|
195
|
+
return localVarFp.postWebhookWithProductSlug(pspType, tenantSlug, productSlug, body, options).then((request) => request(axios, basePath));
|
|
125
196
|
},
|
|
126
197
|
};
|
|
127
198
|
};
|
|
@@ -147,16 +218,44 @@ export interface WebhooksApiPostWebhookRequest {
|
|
|
147
218
|
readonly tenantSlug: string
|
|
148
219
|
|
|
149
220
|
/**
|
|
150
|
-
*
|
|
151
|
-
* @type {
|
|
221
|
+
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
222
|
+
* @type {object}
|
|
152
223
|
* @memberof WebhooksApiPostWebhook
|
|
153
224
|
*/
|
|
225
|
+
readonly body: object
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* Request parameters for postWebhookWithProductSlug operation in WebhooksApi.
|
|
230
|
+
* @export
|
|
231
|
+
* @interface WebhooksApiPostWebhookWithProductSlugRequest
|
|
232
|
+
*/
|
|
233
|
+
export interface WebhooksApiPostWebhookWithProductSlugRequest {
|
|
234
|
+
/**
|
|
235
|
+
* The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
236
|
+
* @type {string}
|
|
237
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
238
|
+
*/
|
|
239
|
+
readonly pspType: string
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Unique slug identifier representing a tenant.
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
245
|
+
*/
|
|
246
|
+
readonly tenantSlug: string
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Optional product slug associated with the webhook.
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
252
|
+
*/
|
|
154
253
|
readonly productSlug: string
|
|
155
254
|
|
|
156
255
|
/**
|
|
157
256
|
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
158
257
|
* @type {object}
|
|
159
|
-
* @memberof
|
|
258
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
160
259
|
*/
|
|
161
260
|
readonly body: object
|
|
162
261
|
}
|
|
@@ -177,6 +276,18 @@ export class WebhooksApi extends BaseAPI {
|
|
|
177
276
|
* @memberof WebhooksApi
|
|
178
277
|
*/
|
|
179
278
|
public postWebhook(requestParameters: WebhooksApiPostWebhookRequest, options?: AxiosRequestConfig) {
|
|
180
|
-
return WebhooksApiFp(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.
|
|
279
|
+
return WebhooksApiFp(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
284
|
+
* @summary Handle the webhook from PSP
|
|
285
|
+
* @param {WebhooksApiPostWebhookWithProductSlugRequest} requestParameters Request parameters.
|
|
286
|
+
* @param {*} [options] Override http request option.
|
|
287
|
+
* @throws {RequiredError}
|
|
288
|
+
* @memberof WebhooksApi
|
|
289
|
+
*/
|
|
290
|
+
public postWebhookWithProductSlug(requestParameters: WebhooksApiPostWebhookWithProductSlugRequest, options?: AxiosRequestConfig) {
|
|
291
|
+
return WebhooksApiFp(this.configuration).postWebhookWithProductSlug(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.productSlug, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
181
292
|
}
|
|
182
293
|
}
|
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';
|
package/base.ts
CHANGED
|
@@ -53,6 +53,7 @@ export enum Environment {
|
|
|
53
53
|
Staging = 'https://apiv2-staging.emil.de',
|
|
54
54
|
Development = 'https://apiv2-dev.emil.de',
|
|
55
55
|
ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
|
|
56
|
+
StagingZurich = 'https://eu-central-2.apiv2-staging.emil.de',
|
|
56
57
|
}
|
|
57
58
|
|
|
58
59
|
let _retry_count = 0
|
|
@@ -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.
|