@emilgroup/payment-sdk 1.13.1-beta.2 → 1.13.1-beta.21

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.
Files changed (102) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +79 -37
  4. package/api/bank-orders-api.ts +691 -0
  5. package/api/bank-transaction-api.ts +187 -56
  6. package/api/payment-methods-api.ts +67 -25
  7. package/api/payment-reminders-api.ts +85 -43
  8. package/api/payment-setup-api.ts +8 -8
  9. package/api/payments-api.ts +67 -25
  10. package/api/refunds-api.ts +57 -29
  11. package/api/tenant-bank-account-api.ts +45 -17
  12. package/api/webhooks-api.ts +4 -4
  13. package/api.ts +2 -0
  14. package/base.ts +1 -1
  15. package/dist/api/bank-accounts-api.d.ts +59 -32
  16. package/dist/api/bank-accounts-api.js +53 -35
  17. package/dist/api/bank-orders-api.d.ts +393 -0
  18. package/dist/api/bank-orders-api.js +642 -0
  19. package/dist/api/bank-transaction-api.d.ts +123 -49
  20. package/dist/api/bank-transaction-api.js +151 -47
  21. package/dist/api/payment-methods-api.d.ts +47 -20
  22. package/dist/api/payment-methods-api.js +41 -23
  23. package/dist/api/payment-reminders-api.d.ts +61 -34
  24. package/dist/api/payment-reminders-api.js +54 -36
  25. package/dist/api/payment-setup-api.d.ts +8 -8
  26. package/dist/api/payment-setup-api.js +8 -8
  27. package/dist/api/payments-api.d.ts +47 -20
  28. package/dist/api/payments-api.js +41 -23
  29. package/dist/api/refunds-api.d.ts +40 -22
  30. package/dist/api/refunds-api.js +36 -24
  31. package/dist/api/tenant-bank-account-api.d.ts +28 -10
  32. package/dist/api/tenant-bank-account-api.js +24 -12
  33. package/dist/api/webhooks-api.d.ts +4 -4
  34. package/dist/api/webhooks-api.js +4 -4
  35. package/dist/api.d.ts +1 -0
  36. package/dist/api.js +1 -0
  37. package/dist/models/bank-order-class.d.ts +115 -0
  38. package/dist/models/bank-order-class.js +15 -0
  39. package/dist/models/bank-transaction-class-without-expand-properties.d.ts +8 -2
  40. package/dist/models/bank-transaction-class.d.ts +22 -2
  41. package/dist/models/create-bank-order-request-dto.d.ts +74 -0
  42. package/dist/models/create-bank-order-request-dto.js +28 -0
  43. package/dist/models/create-bank-order-response-class.d.ts +25 -0
  44. package/dist/models/create-bank-order-response-class.js +15 -0
  45. package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
  46. package/dist/models/create-payment-request-dto.d.ts +7 -1
  47. package/dist/models/create-psp-payment-method-request-dto.d.ts +7 -1
  48. package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
  49. package/dist/models/financial-account-class.d.ts +111 -0
  50. package/dist/models/financial-account-class.js +24 -0
  51. package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
  52. package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
  53. package/dist/models/get-bank-order-response-class.d.ts +25 -0
  54. package/dist/models/get-bank-order-response-class.js +15 -0
  55. package/dist/models/index.d.ts +11 -0
  56. package/dist/models/index.js +11 -0
  57. package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
  58. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
  59. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
  60. package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
  61. package/dist/models/invoice-match-suggestion-class.js +15 -0
  62. package/dist/models/list-bank-orders-response-class.d.ts +31 -0
  63. package/dist/models/list-bank-orders-response-class.js +15 -0
  64. package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
  65. package/dist/models/payment-class.d.ts +7 -1
  66. package/dist/models/payment-reminder-class.d.ts +7 -1
  67. package/dist/models/refund-class.d.ts +7 -1
  68. package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
  69. package/dist/models/suggestion-generation-progress-class.js +22 -0
  70. package/dist/models/unlinked-bank-transaction-response-class.d.ts +8 -2
  71. package/dist/models/update-bank-order-request-dto.d.ts +56 -0
  72. package/dist/models/update-bank-order-request-dto.js +23 -0
  73. package/dist/models/update-bank-order-response-class.d.ts +25 -0
  74. package/dist/models/update-bank-order-response-class.js +15 -0
  75. package/models/bank-order-class.ts +121 -0
  76. package/models/bank-transaction-class-without-expand-properties.ts +8 -2
  77. package/models/bank-transaction-class.ts +22 -2
  78. package/models/create-bank-order-request-dto.ts +84 -0
  79. package/models/create-bank-order-response-class.ts +31 -0
  80. package/models/create-payment-reminder-request-dto.ts +7 -1
  81. package/models/create-payment-request-dto.ts +7 -1
  82. package/models/create-psp-payment-method-request-dto.ts +7 -1
  83. package/models/deactivated-payment-reminder-class.ts +7 -1
  84. package/models/financial-account-class.ts +120 -0
  85. package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
  86. package/models/get-bank-order-response-class.ts +31 -0
  87. package/models/index.ts +11 -0
  88. package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
  89. package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
  90. package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
  91. package/models/invoice-match-suggestion-class.ts +66 -0
  92. package/models/list-bank-orders-response-class.ts +37 -0
  93. package/models/payment-class-without-expand-properties.ts +7 -1
  94. package/models/payment-class.ts +7 -1
  95. package/models/payment-reminder-class.ts +7 -1
  96. package/models/refund-class.ts +7 -1
  97. package/models/suggestion-generation-progress-class.ts +52 -0
  98. package/models/unlinked-bank-transaction-response-class.ts +8 -2
  99. package/models/update-bank-order-request-dto.ts +65 -0
  100. package/models/update-bank-order-response-class.ts +31 -0
  101. package/package.json +1 -1
  102. package/tsconfig.json +1 -0
@@ -184,15 +184,17 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
184
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
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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.
187
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</i>
188
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName</i>
189
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>
190
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</i>
191
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. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName</i>
192
194
  * @param {*} [options] Override http request option.
193
195
  * @throws {RequiredError}
194
196
  */
195
- listTenantBankAccounts: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
197
+ listTenantBankAccounts: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
196
198
  const localVarPath = `/paymentservice/v1/tenant/bank-accounts`;
197
199
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
198
200
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -211,12 +213,16 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
211
213
  // http bearer authentication required
212
214
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
213
215
 
214
- if (filter !== undefined) {
215
- localVarQueryParameter['filter'] = filter;
216
+ if (pageSize !== undefined) {
217
+ localVarQueryParameter['pageSize'] = pageSize;
216
218
  }
217
219
 
218
- if (filters !== undefined) {
219
- localVarQueryParameter['filters'] = filters;
220
+ if (pageToken !== undefined) {
221
+ localVarQueryParameter['pageToken'] = pageToken;
222
+ }
223
+
224
+ if (filter !== undefined) {
225
+ localVarQueryParameter['filter'] = filter;
220
226
  }
221
227
 
222
228
  if (search !== undefined) {
@@ -231,6 +237,10 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
231
237
  localVarQueryParameter['expand'] = expand;
232
238
  }
233
239
 
240
+ if (filters !== undefined) {
241
+ localVarQueryParameter['filters'] = filters;
242
+ }
243
+
234
244
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
235
245
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
236
246
  }
@@ -348,16 +358,18 @@ export const TenantBankAccountApiFp = function(configuration?: Configuration) {
348
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.
349
359
  * @summary List tenant bank accounts
350
360
  * @param {string} [authorization] Bearer Token
361
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
351
363
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
352
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
353
364
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, iban, bankName, accountName&lt;/i&gt;
354
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
355
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankTransactions&lt;i&gt;
367
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
356
368
  * @param {*} [options] Override http request option.
357
369
  * @throws {RequiredError}
358
370
  */
359
- async listTenantBankAccounts(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTenantBankAccountResponseClass>> {
360
- const localVarAxiosArgs = await localVarAxiosParamCreator.listTenantBankAccounts(authorization, filter, filters, search, order, expand, options);
371
+ async listTenantBankAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTenantBankAccountResponseClass>> {
372
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTenantBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
361
373
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
362
374
  },
363
375
  /**
@@ -421,16 +433,18 @@ export const TenantBankAccountApiFactory = function (configuration?: Configurati
421
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.
422
434
  * @summary List tenant bank accounts
423
435
  * @param {string} [authorization] Bearer Token
436
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
424
438
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
425
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
426
439
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, iban, bankName, accountName&lt;/i&gt;
427
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
428
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankTransactions&lt;i&gt;
442
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
429
443
  * @param {*} [options] Override http request option.
430
444
  * @throws {RequiredError}
431
445
  */
432
- listTenantBankAccounts(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListTenantBankAccountResponseClass> {
433
- return localVarFp.listTenantBankAccounts(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
446
+ listTenantBankAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTenantBankAccountResponseClass> {
447
+ return localVarFp.listTenantBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
434
448
  },
435
449
  /**
436
450
  * Update a tenant bank account by code
@@ -531,18 +545,25 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
531
545
  readonly authorization?: string
532
546
 
533
547
  /**
534
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
548
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
549
+ * @type {number}
550
+ * @memberof TenantBankAccountApiListTenantBankAccounts
551
+ */
552
+ readonly pageSize?: number
553
+
554
+ /**
555
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
535
556
  * @type {string}
536
557
  * @memberof TenantBankAccountApiListTenantBankAccounts
537
558
  */
538
- readonly filter?: string
559
+ readonly pageToken?: string
539
560
 
540
561
  /**
541
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
562
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
542
563
  * @type {string}
543
564
  * @memberof TenantBankAccountApiListTenantBankAccounts
544
565
  */
545
- readonly filters?: string
566
+ readonly filter?: string
546
567
 
547
568
  /**
548
569
  * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, iban, bankName, accountName&lt;/i&gt;
@@ -564,6 +585,13 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
564
585
  * @memberof TenantBankAccountApiListTenantBankAccounts
565
586
  */
566
587
  readonly expand?: string
588
+
589
+ /**
590
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, iban, bankName, accountName&lt;/i&gt;
591
+ * @type {string}
592
+ * @memberof TenantBankAccountApiListTenantBankAccounts
593
+ */
594
+ readonly filters?: string
567
595
  }
568
596
 
569
597
  /**
@@ -646,7 +674,7 @@ export class TenantBankAccountApi extends BaseAPI {
646
674
  * @memberof TenantBankAccountApi
647
675
  */
648
676
  public listTenantBankAccounts(requestParameters: TenantBankAccountApiListTenantBankAccountsRequest = {}, options?: AxiosRequestConfig) {
649
- return TenantBankAccountApiFp(this.configuration).listTenantBankAccounts(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
677
+ return TenantBankAccountApiFp(this.configuration).listTenantBankAccounts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
650
678
  }
651
679
 
652
680
  /**
@@ -27,7 +27,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
27
27
  export const WebhooksApiAxiosParamCreator = function (configuration?: Configuration) {
28
28
  return {
29
29
  /**
30
- * This will processes the webhook from external payment service provider.
30
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
31
31
  * @summary Handle the webhook from PSP
32
32
  * @param {string} pspType The type of the payment service provider (PSP).&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Supported PSP: braintree, stripe, b4u, eis, adyen&lt;/i&gt;
33
33
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -87,7 +87,7 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
87
87
  const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration)
88
88
  return {
89
89
  /**
90
- * This will processes the webhook from external payment service provider.
90
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
91
91
  * @summary Handle the webhook from PSP
92
92
  * @param {string} pspType The type of the payment service provider (PSP).&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Supported PSP: braintree, stripe, b4u, eis, adyen&lt;/i&gt;
93
93
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -111,7 +111,7 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
111
111
  const localVarFp = WebhooksApiFp(configuration)
112
112
  return {
113
113
  /**
114
- * This will processes the webhook from external payment service provider.
114
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
115
115
  * @summary Handle the webhook from PSP
116
116
  * @param {string} pspType The type of the payment service provider (PSP).&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Supported PSP: braintree, stripe, b4u, eis, adyen&lt;/i&gt;
117
117
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -169,7 +169,7 @@ export interface WebhooksApiPostWebhookRequest {
169
169
  */
170
170
  export class WebhooksApi extends BaseAPI {
171
171
  /**
172
- * This will processes the webhook from external payment service provider.
172
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
173
173
  * @summary Handle the webhook from PSP
174
174
  * @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
175
175
  * @param {*} [options] Override http request option.
package/api.ts CHANGED
@@ -21,6 +21,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
23
  import { BankAccountsApi } from './api';
24
+ import { BankOrdersApi } from './api';
24
25
  import { BankTransactionApi } from './api';
25
26
  import { HealthCheckApi } from './api';
26
27
  import { PaymentMethodsApi } from './api';
@@ -33,6 +34,7 @@ import { WebhooksApi } from './api';
33
34
 
34
35
 
35
36
  export * from './api/bank-accounts-api';
37
+ export * from './api/bank-orders-api';
36
38
  export * from './api/bank-transaction-api';
37
39
  export * from './api/health-check-api';
38
40
  export * from './api/payment-methods-api';
package/base.ts CHANGED
@@ -270,7 +270,7 @@ export class BaseAPI {
270
270
  * @extends {Error}
271
271
  */
272
272
  export class RequiredError extends Error {
273
- name: "RequiredError" = "RequiredError";
273
+ override name: "RequiredError" = "RequiredError";
274
274
  constructor(public field: string, msg?: string) {
275
275
  super(msg);
276
276
  }
@@ -25,7 +25,7 @@ import { UpdateBankAccountResponseClass } from '../models';
25
25
  */
26
26
  export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
27
27
  /**
28
- * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary.
28
+ * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary. **Required Permissions** \"payment-management.bank-accounts.create\"
29
29
  * @summary Create the bank account
30
30
  * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
31
31
  * @param {string} [authorization] Bearer Token
@@ -34,7 +34,7 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
34
34
  */
35
35
  createBankAccount: (createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
36
  /**
37
- * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary.
37
+ * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary. **Required Permissions** \"payment-management.bank-accounts.delete\"
38
38
  * @summary Delete the bank account
39
39
  * @param {string} code Unique identifier for the object.
40
40
  * @param {string} [authorization] Bearer Token
@@ -43,7 +43,7 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
43
43
  */
44
44
  deleteBankAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
45
  /**
46
- * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information.
46
+ * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information. **Required Permissions** \"payment-management.bank-accounts.view\"
47
47
  * @summary Retrieve the bank account
48
48
  * @param {string} code
49
49
  * @param {string} [authorization] Bearer Token
@@ -53,19 +53,22 @@ 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. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
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
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
59
61
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
60
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
62
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
61
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
62
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: primaryBankAccount&lt;i&gt;
65
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
63
66
  * @param {*} [options] Override http request option.
64
67
  * @throws {RequiredError}
65
68
  */
66
- listBankAccounts: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ listBankAccounts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
70
  /**
68
- * Set the primary bank account for the specified partner/account
71
+ * Set the primary bank account for the specified partner/account **Required Permissions** \"payment-management.bank-accounts.update\"
69
72
  * @summary Set primary bank account
70
73
  * @param {string} code Code of the bank account to set primary
71
74
  * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
@@ -75,7 +78,7 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
75
78
  */
76
79
  setPrimaryBankAccount: (code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
80
  /**
78
- * Update a bank account by code
81
+ * Update a bank account by code **Required Permissions** \"payment-management.bank-accounts.update\"
79
82
  * @summary Update the bank account
80
83
  * @param {string} code Unique identifier for the object.
81
84
  * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest
@@ -91,7 +94,7 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
91
94
  */
92
95
  export declare const BankAccountsApiFp: (configuration?: Configuration) => {
93
96
  /**
94
- * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary.
97
+ * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary. **Required Permissions** \"payment-management.bank-accounts.create\"
95
98
  * @summary Create the bank account
96
99
  * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
97
100
  * @param {string} [authorization] Bearer Token
@@ -100,7 +103,7 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
100
103
  */
101
104
  createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBankAccountResponseClass>>;
102
105
  /**
103
- * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary.
106
+ * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary. **Required Permissions** \"payment-management.bank-accounts.delete\"
104
107
  * @summary Delete the bank account
105
108
  * @param {string} code Unique identifier for the object.
106
109
  * @param {string} [authorization] Bearer Token
@@ -109,7 +112,7 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
109
112
  */
110
113
  deleteBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
111
114
  /**
112
- * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information.
115
+ * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information. **Required Permissions** \"payment-management.bank-accounts.view\"
113
116
  * @summary Retrieve the bank account
114
117
  * @param {string} code
115
118
  * @param {string} [authorization] Bearer Token
@@ -119,19 +122,22 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
119
122
  */
120
123
  getBankAccount(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankAccountResponseClass>>;
121
124
  /**
122
- * 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.
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\"
123
126
  * @summary List bank accounts
124
127
  * @param {string} [authorization] Bearer Token
128
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
125
130
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
126
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
131
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
127
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
128
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: primaryBankAccount&lt;i&gt;
134
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
129
135
  * @param {*} [options] Override http request option.
130
136
  * @throws {RequiredError}
131
137
  */
132
- listBankAccounts(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankAccountsResponseClass>>;
138
+ listBankAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankAccountsResponseClass>>;
133
139
  /**
134
- * Set the primary bank account for the specified partner/account
140
+ * Set the primary bank account for the specified partner/account **Required Permissions** \"payment-management.bank-accounts.update\"
135
141
  * @summary Set primary bank account
136
142
  * @param {string} code Code of the bank account to set primary
137
143
  * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
@@ -141,7 +147,7 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
141
147
  */
142
148
  setPrimaryBankAccount(code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
143
149
  /**
144
- * Update a bank account by code
150
+ * Update a bank account by code **Required Permissions** \"payment-management.bank-accounts.update\"
145
151
  * @summary Update the bank account
146
152
  * @param {string} code Unique identifier for the object.
147
153
  * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest
@@ -157,7 +163,7 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
157
163
  */
158
164
  export declare const BankAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
159
165
  /**
160
- * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary.
166
+ * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary. **Required Permissions** \"payment-management.bank-accounts.create\"
161
167
  * @summary Create the bank account
162
168
  * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
163
169
  * @param {string} [authorization] Bearer Token
@@ -166,7 +172,7 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
166
172
  */
167
173
  createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBankAccountResponseClass>;
168
174
  /**
169
- * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary.
175
+ * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary. **Required Permissions** \"payment-management.bank-accounts.delete\"
170
176
  * @summary Delete the bank account
171
177
  * @param {string} code Unique identifier for the object.
172
178
  * @param {string} [authorization] Bearer Token
@@ -175,7 +181,7 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
175
181
  */
176
182
  deleteBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<object>;
177
183
  /**
178
- * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information.
184
+ * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information. **Required Permissions** \"payment-management.bank-accounts.view\"
179
185
  * @summary Retrieve the bank account
180
186
  * @param {string} code
181
187
  * @param {string} [authorization] Bearer Token
@@ -185,19 +191,22 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
185
191
  */
186
192
  getBankAccount(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankAccountResponseClass>;
187
193
  /**
188
- * 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.
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\"
189
195
  * @summary List bank accounts
190
196
  * @param {string} [authorization] Bearer Token
197
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
191
199
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
192
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
200
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
193
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
194
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: primaryBankAccount&lt;i&gt;
203
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
195
204
  * @param {*} [options] Override http request option.
196
205
  * @throws {RequiredError}
197
206
  */
198
- listBankAccounts(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListBankAccountsResponseClass>;
207
+ listBankAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBankAccountsResponseClass>;
199
208
  /**
200
- * Set the primary bank account for the specified partner/account
209
+ * Set the primary bank account for the specified partner/account **Required Permissions** \"payment-management.bank-accounts.update\"
201
210
  * @summary Set primary bank account
202
211
  * @param {string} code Code of the bank account to set primary
203
212
  * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
@@ -207,7 +216,7 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
207
216
  */
208
217
  setPrimaryBankAccount(code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: any): AxiosPromise<object>;
209
218
  /**
210
- * Update a bank account by code
219
+ * Update a bank account by code **Required Permissions** \"payment-management.bank-accounts.update\"
211
220
  * @summary Update the bank account
212
221
  * @param {string} code Unique identifier for the object.
213
222
  * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest
@@ -292,6 +301,18 @@ export interface BankAccountsApiListBankAccountsRequest {
292
301
  * @memberof BankAccountsApiListBankAccounts
293
302
  */
294
303
  readonly authorization?: string;
304
+ /**
305
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
306
+ * @type {number}
307
+ * @memberof BankAccountsApiListBankAccounts
308
+ */
309
+ readonly pageSize?: number;
310
+ /**
311
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
312
+ * @type {string}
313
+ * @memberof BankAccountsApiListBankAccounts
314
+ */
315
+ readonly pageToken?: string;
295
316
  /**
296
317
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
297
318
  * @type {string}
@@ -299,11 +320,11 @@ export interface BankAccountsApiListBankAccountsRequest {
299
320
  */
300
321
  readonly filter?: string;
301
322
  /**
302
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
323
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
303
324
  * @type {string}
304
325
  * @memberof BankAccountsApiListBankAccounts
305
326
  */
306
- readonly filters?: string;
327
+ readonly search?: string;
307
328
  /**
308
329
  * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
309
330
  * @type {string}
@@ -316,6 +337,12 @@ export interface BankAccountsApiListBankAccountsRequest {
316
337
  * @memberof BankAccountsApiListBankAccounts
317
338
  */
318
339
  readonly expand?: string;
340
+ /**
341
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
342
+ * @type {string}
343
+ * @memberof BankAccountsApiListBankAccounts
344
+ */
345
+ readonly filters?: string;
319
346
  }
320
347
  /**
321
348
  * Request parameters for setPrimaryBankAccount operation in BankAccountsApi.
@@ -375,7 +402,7 @@ export interface BankAccountsApiUpdateBankAccountRequest {
375
402
  */
376
403
  export declare class BankAccountsApi extends BaseAPI {
377
404
  /**
378
- * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary.
405
+ * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary. **Required Permissions** \"payment-management.bank-accounts.create\"
379
406
  * @summary Create the bank account
380
407
  * @param {BankAccountsApiCreateBankAccountRequest} requestParameters Request parameters.
381
408
  * @param {*} [options] Override http request option.
@@ -384,7 +411,7 @@ export declare class BankAccountsApi extends BaseAPI {
384
411
  */
385
412
  createBankAccount(requestParameters: BankAccountsApiCreateBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBankAccountResponseClass, any>>;
386
413
  /**
387
- * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary.
414
+ * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary. **Required Permissions** \"payment-management.bank-accounts.delete\"
388
415
  * @summary Delete the bank account
389
416
  * @param {BankAccountsApiDeleteBankAccountRequest} requestParameters Request parameters.
390
417
  * @param {*} [options] Override http request option.
@@ -393,7 +420,7 @@ export declare class BankAccountsApi extends BaseAPI {
393
420
  */
394
421
  deleteBankAccount(requestParameters: BankAccountsApiDeleteBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
395
422
  /**
396
- * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information.
423
+ * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information. **Required Permissions** \"payment-management.bank-accounts.view\"
397
424
  * @summary Retrieve the bank account
398
425
  * @param {BankAccountsApiGetBankAccountRequest} requestParameters Request parameters.
399
426
  * @param {*} [options] Override http request option.
@@ -402,7 +429,7 @@ export declare class BankAccountsApi extends BaseAPI {
402
429
  */
403
430
  getBankAccount(requestParameters: BankAccountsApiGetBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankAccountResponseClass, any>>;
404
431
  /**
405
- * 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.
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\"
406
433
  * @summary List bank accounts
407
434
  * @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
408
435
  * @param {*} [options] Override http request option.
@@ -411,7 +438,7 @@ export declare class BankAccountsApi extends BaseAPI {
411
438
  */
412
439
  listBankAccounts(requestParameters?: BankAccountsApiListBankAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankAccountsResponseClass, any>>;
413
440
  /**
414
- * Set the primary bank account for the specified partner/account
441
+ * Set the primary bank account for the specified partner/account **Required Permissions** \"payment-management.bank-accounts.update\"
415
442
  * @summary Set primary bank account
416
443
  * @param {BankAccountsApiSetPrimaryBankAccountRequest} requestParameters Request parameters.
417
444
  * @param {*} [options] Override http request option.
@@ -420,7 +447,7 @@ export declare class BankAccountsApi extends BaseAPI {
420
447
  */
421
448
  setPrimaryBankAccount(requestParameters: BankAccountsApiSetPrimaryBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
422
449
  /**
423
- * Update a bank account by code
450
+ * Update a bank account by code **Required Permissions** \"payment-management.bank-accounts.update\"
424
451
  * @summary Update the bank account
425
452
  * @param {BankAccountsApiUpdateBankAccountRequest} requestParameters Request parameters.
426
453
  * @param {*} [options] Override http request option.