@emilgroup/payment-sdk 1.4.1-beta.4 → 1.4.1-beta.40

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 (129) hide show
  1. package/.openapi-generator/FILES +15 -7
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +501 -89
  4. package/api/bank-transaction-api.ts +303 -97
  5. package/api/{default-api.ts → health-check-api.ts} +23 -19
  6. package/api/payment-methods-api.ts +62 -243
  7. package/api/payment-reminders-api.ts +58 -100
  8. package/api/payment-setup-api.ts +18 -10
  9. package/api/payments-api.ts +73 -136
  10. package/api/refunds-api.ts +436 -0
  11. package/api/tenant-bank-account-api.ts +100 -102
  12. package/api/webhooks-api.ts +18 -14
  13. package/api.ts +6 -4
  14. package/base.ts +23 -11
  15. package/common.ts +4 -4
  16. package/configuration.ts +2 -2
  17. package/dist/api/bank-accounts-api.d.ts +293 -70
  18. package/dist/api/bank-accounts-api.js +433 -63
  19. package/dist/api/bank-transaction-api.d.ts +193 -83
  20. package/dist/api/bank-transaction-api.js +253 -66
  21. package/dist/api/health-check-api.d.ts +70 -0
  22. package/dist/api/{default-api.js → health-check-api.js} +32 -28
  23. package/dist/api/payment-methods-api.d.ts +52 -152
  24. package/dist/api/payment-methods-api.js +49 -179
  25. package/dist/api/payment-reminders-api.d.ts +53 -80
  26. package/dist/api/payment-reminders-api.js +45 -63
  27. package/dist/api/payment-setup-api.d.ts +18 -10
  28. package/dist/api/payment-setup-api.js +18 -10
  29. package/dist/api/payments-api.d.ts +63 -99
  30. package/dist/api/payments-api.js +56 -86
  31. package/dist/api/refunds-api.d.ts +251 -0
  32. package/dist/api/refunds-api.js +439 -0
  33. package/dist/api/tenant-bank-account-api.d.ts +94 -89
  34. package/dist/api/tenant-bank-account-api.js +72 -64
  35. package/dist/api/webhooks-api.d.ts +18 -14
  36. package/dist/api/webhooks-api.js +16 -12
  37. package/dist/api.d.ts +4 -3
  38. package/dist/api.js +4 -3
  39. package/dist/base.d.ts +7 -4
  40. package/dist/base.js +32 -23
  41. package/dist/common.d.ts +4 -4
  42. package/dist/common.js +2 -2
  43. package/dist/configuration.d.ts +2 -2
  44. package/dist/configuration.js +2 -2
  45. package/dist/index.d.ts +2 -2
  46. package/dist/index.js +2 -2
  47. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +32 -34
  48. package/dist/models/{bank-transaction-response-class.js → bank-transaction-class-without-expand-properties.js} +2 -2
  49. package/dist/models/create-bank-account-request-dto.d.ts +42 -0
  50. package/dist/models/{get-request-dto.js → create-bank-account-request-dto.js} +2 -2
  51. package/dist/models/create-payment-reminder-request-dto.d.ts +2 -2
  52. package/dist/models/create-payment-reminder-request-dto.js +2 -2
  53. package/dist/models/create-payment-request-dto.d.ts +4 -4
  54. package/dist/models/create-payment-request-dto.js +2 -2
  55. package/dist/models/create-refund-request-dto.d.ts +24 -0
  56. package/dist/models/{get-bank-transactions-response-class.js → create-refund-request-dto.js} +2 -2
  57. package/dist/models/create-tenant-bank-account-request-dto.d.ts +2 -2
  58. package/dist/models/create-tenant-bank-account-request-dto.js +2 -2
  59. package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
  60. package/dist/models/{list-bank-transactions-response-class.js → create-tenant-bank-account-response-class.js} +2 -2
  61. package/dist/models/deactivate-payment-reminder-request-dto.d.ts +2 -2
  62. package/dist/models/deactivate-payment-reminder-request-dto.js +2 -2
  63. package/dist/models/get-tenant-bank-account-response-class.d.ts +6 -6
  64. package/dist/models/get-tenant-bank-account-response-class.js +2 -2
  65. package/dist/models/index.d.ts +13 -6
  66. package/dist/models/index.js +13 -6
  67. package/dist/models/inline-response200.d.ts +2 -2
  68. package/dist/models/inline-response200.js +2 -2
  69. package/dist/models/inline-response503.d.ts +2 -2
  70. package/dist/models/inline-response503.js +2 -2
  71. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +24 -0
  72. package/dist/models/link-bank-transaction-request-dto-rest.js +15 -0
  73. package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
  74. package/dist/models/list-tenant-bank-account-response-class.js +15 -0
  75. package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
  76. package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
  77. package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +78 -0
  78. package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
  79. package/dist/models/tenant-bank-account-class.d.ts +85 -0
  80. package/dist/models/tenant-bank-account-class.js +15 -0
  81. package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +24 -0
  82. package/dist/models/unlink-bank-transaction-request-dto-rest.js +15 -0
  83. package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
  84. package/dist/models/update-bank-account-request-dto-rest.js +15 -0
  85. package/dist/models/update-bank-account-request-dto.d.ts +36 -0
  86. package/dist/models/update-bank-account-request-dto.js +15 -0
  87. package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
  88. package/dist/models/update-tenant-bank-account-response-class.js +15 -0
  89. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +2 -2
  90. package/dist/models/update-tenant-bank-account-rest-request-dto.js +2 -2
  91. package/dist/models/validate-pspconfig-request-dto.d.ts +2 -2
  92. package/dist/models/validate-pspconfig-request-dto.js +2 -2
  93. package/index.ts +2 -2
  94. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +32 -34
  95. package/models/create-bank-account-request-dto.ts +48 -0
  96. package/models/create-payment-reminder-request-dto.ts +2 -2
  97. package/models/create-payment-request-dto.ts +4 -4
  98. package/models/create-refund-request-dto.ts +30 -0
  99. package/models/create-tenant-bank-account-request-dto.ts +2 -2
  100. package/models/create-tenant-bank-account-response-class.ts +31 -0
  101. package/models/deactivate-payment-reminder-request-dto.ts +2 -2
  102. package/models/get-tenant-bank-account-response-class.ts +6 -6
  103. package/models/index.ts +13 -6
  104. package/models/inline-response200.ts +2 -2
  105. package/models/inline-response503.ts +2 -2
  106. package/models/link-bank-transaction-request-dto-rest.ts +30 -0
  107. package/models/list-tenant-bank-account-response-class.ts +37 -0
  108. package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
  109. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +24 -12
  110. package/models/tenant-bank-account-class.ts +91 -0
  111. package/models/unlink-bank-transaction-request-dto-rest.ts +30 -0
  112. package/models/update-bank-account-request-dto-rest.ts +36 -0
  113. package/models/update-bank-account-request-dto.ts +42 -0
  114. package/models/update-tenant-bank-account-response-class.ts +31 -0
  115. package/models/update-tenant-bank-account-rest-request-dto.ts +2 -2
  116. package/models/validate-pspconfig-request-dto.ts +2 -2
  117. package/package.json +1 -1
  118. package/dist/api/default-api.d.ts +0 -66
  119. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  120. package/dist/models/get-request-dto.d.ts +0 -30
  121. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  122. package/dist/models/tenant-bank-account-response-class.d.ts +0 -66
  123. package/dist/models/tenant-bank-account-response-class.js +0 -15
  124. package/dist/models/transaction-class.d.ts +0 -54
  125. package/dist/models/transaction-class.js +0 -15
  126. package/models/get-bank-transactions-response-class.ts +0 -31
  127. package/models/get-request-dto.ts +0 -36
  128. package/models/list-bank-transactions-response-class.ts +0 -37
  129. package/models/transaction-class.ts +0 -60
@@ -2,10 +2,10 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Emil Payment Service
5
- * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- * Contact: z
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -23,8 +23,14 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
23
23
  // @ts-ignore
24
24
  import { CreateTenantBankAccountRequestDto } from '../models';
25
25
  // @ts-ignore
26
+ import { CreateTenantBankAccountResponseClass } from '../models';
27
+ // @ts-ignore
26
28
  import { GetTenantBankAccountResponseClass } from '../models';
27
29
  // @ts-ignore
30
+ import { ListTenantBankAccountResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { UpdateTenantBankAccountResponseClass } from '../models';
33
+ // @ts-ignore
28
34
  import { UpdateTenantBankAccountRestRequestDto } from '../models';
29
35
  /**
30
36
  * TenantBankAccountApi - axios parameter creator
@@ -33,7 +39,8 @@ import { UpdateTenantBankAccountRestRequestDto } from '../models';
33
39
  export const TenantBankAccountApiAxiosParamCreator = function (configuration?: Configuration) {
34
40
  return {
35
41
  /**
36
- *
42
+ * This will create a new tenant bank account
43
+ * @summary Create the tenant bank account
37
44
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
38
45
  * @param {string} [authorization] Bearer Token
39
46
  * @param {*} [options] Override http request option.
@@ -79,7 +86,8 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
79
86
  };
80
87
  },
81
88
  /**
82
- *
89
+ * Deletes a tenant bank account by code
90
+ * @summary Delete the tenant bank account
83
91
  * @param {string} code Unique identifier for the object.
84
92
  * @param {string} [authorization] Bearer Token
85
93
  * @param {*} [options] Override http request option.
@@ -123,10 +131,11 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
123
131
  };
124
132
  },
125
133
  /**
126
- *
127
- * @param {string} code Unique identifier for the object.
134
+ * Retrieves the details of the tenant bank account that was previously created. Supply the unique tenant bank account code that was returned when you created it and Emil Api will return the corresponding tenant bank account information.
135
+ * @summary Retrieve the tenant bank account
136
+ * @param {string} code
128
137
  * @param {string} [authorization] Bearer Token
129
- * @param {string} [expand] Expand the response with additional entities
138
+ * @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>
130
139
  * @param {*} [options] Override http request option.
131
140
  * @throws {RequiredError}
132
141
  */
@@ -172,19 +181,18 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
172
181
  };
173
182
  },
174
183
  /**
175
- *
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
+ * @summary List tenant bank accounts
176
186
  * @param {string} [authorization] Bearer Token
177
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
178
- * @param {any} [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.
179
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
180
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
181
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
182
- * @param {string} [expand] Expand the response with additional entities
183
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
187
+ * @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
+ * @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
+ * @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
+ * @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>
184
192
  * @param {*} [options] Override http request option.
185
193
  * @throws {RequiredError}
186
194
  */
187
- listTenantBankAccounts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
195
+ listTenantBankAccounts: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
188
196
  const localVarPath = `/paymentservice/v1/tenant/bank-accounts`;
189
197
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
190
198
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -203,18 +211,14 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
203
211
  // http bearer authentication required
204
212
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
205
213
 
206
- if (pageSize !== undefined) {
207
- localVarQueryParameter['pageSize'] = pageSize;
208
- }
209
-
210
- if (pageToken !== undefined) {
211
- localVarQueryParameter['pageToken'] = pageToken;
212
- }
213
-
214
214
  if (filter !== undefined) {
215
215
  localVarQueryParameter['filter'] = filter;
216
216
  }
217
217
 
218
+ if (filters !== undefined) {
219
+ localVarQueryParameter['filters'] = filters;
220
+ }
221
+
218
222
  if (search !== undefined) {
219
223
  localVarQueryParameter['search'] = search;
220
224
  }
@@ -227,10 +231,6 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
227
231
  localVarQueryParameter['expand'] = expand;
228
232
  }
229
233
 
230
- if (filters !== undefined) {
231
- localVarQueryParameter['filters'] = filters;
232
- }
233
-
234
234
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
235
235
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
236
236
  }
@@ -247,7 +247,8 @@ export const TenantBankAccountApiAxiosParamCreator = function (configuration?: C
247
247
  };
248
248
  },
249
249
  /**
250
- *
250
+ * Update a tenant bank account by code
251
+ * @summary Update the tenant bank account
251
252
  * @param {string} code Unique identifier for the object.
252
253
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
253
254
  * @param {string} [authorization] Bearer Token
@@ -307,32 +308,35 @@ export const TenantBankAccountApiFp = function(configuration?: Configuration) {
307
308
  const localVarAxiosParamCreator = TenantBankAccountApiAxiosParamCreator(configuration)
308
309
  return {
309
310
  /**
310
- *
311
+ * This will create a new tenant bank account
312
+ * @summary Create the tenant bank account
311
313
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
312
314
  * @param {string} [authorization] Bearer Token
313
315
  * @param {*} [options] Override http request option.
314
316
  * @throws {RequiredError}
315
317
  */
316
- async createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
318
+ async createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTenantBankAccountResponseClass>> {
317
319
  const localVarAxiosArgs = await localVarAxiosParamCreator.createTenantBankAccount(createTenantBankAccountRequestDto, authorization, options);
318
320
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
319
321
  },
320
322
  /**
321
- *
323
+ * Deletes a tenant bank account by code
324
+ * @summary Delete the tenant bank account
322
325
  * @param {string} code Unique identifier for the object.
323
326
  * @param {string} [authorization] Bearer Token
324
327
  * @param {*} [options] Override http request option.
325
328
  * @throws {RequiredError}
326
329
  */
327
- async deleteTenantBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
330
+ async deleteTenantBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
328
331
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTenantBankAccount(code, authorization, options);
329
332
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
330
333
  },
331
334
  /**
332
- *
333
- * @param {string} code Unique identifier for the object.
335
+ * Retrieves the details of the tenant bank account that was previously created. Supply the unique tenant bank account code that was returned when you created it and Emil Api will return the corresponding tenant bank account information.
336
+ * @summary Retrieve the tenant bank account
337
+ * @param {string} code
334
338
  * @param {string} [authorization] Bearer Token
335
- * @param {string} [expand] Expand the response with additional entities
339
+ * @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;
336
340
  * @param {*} [options] Override http request option.
337
341
  * @throws {RequiredError}
338
342
  */
@@ -341,31 +345,31 @@ export const TenantBankAccountApiFp = function(configuration?: Configuration) {
341
345
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
342
346
  },
343
347
  /**
344
- *
348
+ * 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
+ * @summary List tenant bank accounts
345
350
  * @param {string} [authorization] Bearer Token
346
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
347
- * @param {any} [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.
348
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
349
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
350
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
351
- * @param {string} [expand] Expand the response with additional entities
352
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
351
+ * @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
+ * @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
+ * @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
+ * @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;
353
356
  * @param {*} [options] Override http request option.
354
357
  * @throws {RequiredError}
355
358
  */
356
- async listTenantBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
357
- const localVarAxiosArgs = await localVarAxiosParamCreator.listTenantBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
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);
358
361
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
359
362
  },
360
363
  /**
361
- *
364
+ * Update a tenant bank account by code
365
+ * @summary Update the tenant bank account
362
366
  * @param {string} code Unique identifier for the object.
363
367
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
364
368
  * @param {string} [authorization] Bearer Token
365
369
  * @param {*} [options] Override http request option.
366
370
  * @throws {RequiredError}
367
371
  */
368
- async updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
372
+ async updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTenantBankAccountResponseClass>> {
369
373
  const localVarAxiosArgs = await localVarAxiosParamCreator.updateTenantBankAccount(code, updateTenantBankAccountRestRequestDto, authorization, options);
370
374
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
371
375
  },
@@ -380,30 +384,33 @@ export const TenantBankAccountApiFactory = function (configuration?: Configurati
380
384
  const localVarFp = TenantBankAccountApiFp(configuration)
381
385
  return {
382
386
  /**
383
- *
387
+ * This will create a new tenant bank account
388
+ * @summary Create the tenant bank account
384
389
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
385
390
  * @param {string} [authorization] Bearer Token
386
391
  * @param {*} [options] Override http request option.
387
392
  * @throws {RequiredError}
388
393
  */
389
- createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
394
+ createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTenantBankAccountResponseClass> {
390
395
  return localVarFp.createTenantBankAccount(createTenantBankAccountRequestDto, authorization, options).then((request) => request(axios, basePath));
391
396
  },
392
397
  /**
393
- *
398
+ * Deletes a tenant bank account by code
399
+ * @summary Delete the tenant bank account
394
400
  * @param {string} code Unique identifier for the object.
395
401
  * @param {string} [authorization] Bearer Token
396
402
  * @param {*} [options] Override http request option.
397
403
  * @throws {RequiredError}
398
404
  */
399
- deleteTenantBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<void> {
405
+ deleteTenantBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<object> {
400
406
  return localVarFp.deleteTenantBankAccount(code, authorization, options).then((request) => request(axios, basePath));
401
407
  },
402
408
  /**
403
- *
404
- * @param {string} code Unique identifier for the object.
409
+ * Retrieves the details of the tenant bank account that was previously created. Supply the unique tenant bank account code that was returned when you created it and Emil Api will return the corresponding tenant bank account information.
410
+ * @summary Retrieve the tenant bank account
411
+ * @param {string} code
405
412
  * @param {string} [authorization] Bearer Token
406
- * @param {string} [expand] Expand the response with additional entities
413
+ * @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;
407
414
  * @param {*} [options] Override http request option.
408
415
  * @throws {RequiredError}
409
416
  */
@@ -411,30 +418,30 @@ export const TenantBankAccountApiFactory = function (configuration?: Configurati
411
418
  return localVarFp.getTenantBankAccount(code, authorization, expand, options).then((request) => request(axios, basePath));
412
419
  },
413
420
  /**
414
- *
421
+ * 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
+ * @summary List tenant bank accounts
415
423
  * @param {string} [authorization] Bearer Token
416
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
417
- * @param {any} [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.
418
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
419
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
420
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
421
- * @param {string} [expand] Expand the response with additional entities
422
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
424
+ * @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
+ * @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
+ * @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
+ * @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;
423
429
  * @param {*} [options] Override http request option.
424
430
  * @throws {RequiredError}
425
431
  */
426
- listTenantBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, filters?: any, options?: any): AxiosPromise<void> {
427
- return localVarFp.listTenantBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
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));
428
434
  },
429
435
  /**
430
- *
436
+ * Update a tenant bank account by code
437
+ * @summary Update the tenant bank account
431
438
  * @param {string} code Unique identifier for the object.
432
439
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
433
440
  * @param {string} [authorization] Bearer Token
434
441
  * @param {*} [options] Override http request option.
435
442
  * @throws {RequiredError}
436
443
  */
437
- updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
444
+ updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateTenantBankAccountResponseClass> {
438
445
  return localVarFp.updateTenantBankAccount(code, updateTenantBankAccountRestRequestDto, authorization, options).then((request) => request(axios, basePath));
439
446
  },
440
447
  };
@@ -489,7 +496,7 @@ export interface TenantBankAccountApiDeleteTenantBankAccountRequest {
489
496
  */
490
497
  export interface TenantBankAccountApiGetTenantBankAccountRequest {
491
498
  /**
492
- * Unique identifier for the object.
499
+ *
493
500
  * @type {string}
494
501
  * @memberof TenantBankAccountApiGetTenantBankAccount
495
502
  */
@@ -503,7 +510,7 @@ export interface TenantBankAccountApiGetTenantBankAccountRequest {
503
510
  readonly authorization?: string
504
511
 
505
512
  /**
506
- * Expand the response with additional entities
513
+ * 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;
507
514
  * @type {string}
508
515
  * @memberof TenantBankAccountApiGetTenantBankAccount
509
516
  */
@@ -524,53 +531,39 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
524
531
  readonly authorization?: string
525
532
 
526
533
  /**
527
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
528
- * @type {any}
529
- * @memberof TenantBankAccountApiListTenantBankAccounts
530
- */
531
- readonly pageSize?: any
532
-
533
- /**
534
- * 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
- * @type {any}
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;
535
+ * @type {string}
536
536
  * @memberof TenantBankAccountApiListTenantBankAccounts
537
537
  */
538
- readonly pageToken?: any
538
+ readonly filter?: string
539
539
 
540
540
  /**
541
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
542
- * @type {any}
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;
542
+ * @type {string}
543
543
  * @memberof TenantBankAccountApiListTenantBankAccounts
544
544
  */
545
- readonly filter?: any
545
+ readonly filters?: string
546
546
 
547
547
  /**
548
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
549
- * @type {any}
548
+ * 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;
549
+ * @type {string}
550
550
  * @memberof TenantBankAccountApiListTenantBankAccounts
551
551
  */
552
- readonly search?: any
552
+ readonly search?: string
553
553
 
554
554
  /**
555
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
556
- * @type {any}
555
+ * 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;
556
+ * @type {string}
557
557
  * @memberof TenantBankAccountApiListTenantBankAccounts
558
558
  */
559
- readonly order?: any
559
+ readonly order?: string
560
560
 
561
561
  /**
562
- * Expand the response with additional entities
562
+ * 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;
563
563
  * @type {string}
564
564
  * @memberof TenantBankAccountApiListTenantBankAccounts
565
565
  */
566
566
  readonly expand?: string
567
-
568
- /**
569
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
570
- * @type {any}
571
- * @memberof TenantBankAccountApiListTenantBankAccounts
572
- */
573
- readonly filters?: any
574
567
  }
575
568
 
576
569
  /**
@@ -609,7 +602,8 @@ export interface TenantBankAccountApiUpdateTenantBankAccountRequest {
609
602
  */
610
603
  export class TenantBankAccountApi extends BaseAPI {
611
604
  /**
612
- *
605
+ * This will create a new tenant bank account
606
+ * @summary Create the tenant bank account
613
607
  * @param {TenantBankAccountApiCreateTenantBankAccountRequest} requestParameters Request parameters.
614
608
  * @param {*} [options] Override http request option.
615
609
  * @throws {RequiredError}
@@ -620,7 +614,8 @@ export class TenantBankAccountApi extends BaseAPI {
620
614
  }
621
615
 
622
616
  /**
623
- *
617
+ * Deletes a tenant bank account by code
618
+ * @summary Delete the tenant bank account
624
619
  * @param {TenantBankAccountApiDeleteTenantBankAccountRequest} requestParameters Request parameters.
625
620
  * @param {*} [options] Override http request option.
626
621
  * @throws {RequiredError}
@@ -631,7 +626,8 @@ export class TenantBankAccountApi extends BaseAPI {
631
626
  }
632
627
 
633
628
  /**
634
- *
629
+ * Retrieves the details of the tenant bank account that was previously created. Supply the unique tenant bank account code that was returned when you created it and Emil Api will return the corresponding tenant bank account information.
630
+ * @summary Retrieve the tenant bank account
635
631
  * @param {TenantBankAccountApiGetTenantBankAccountRequest} requestParameters Request parameters.
636
632
  * @param {*} [options] Override http request option.
637
633
  * @throws {RequiredError}
@@ -642,18 +638,20 @@ export class TenantBankAccountApi extends BaseAPI {
642
638
  }
643
639
 
644
640
  /**
645
- *
641
+ * 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.
642
+ * @summary List tenant bank accounts
646
643
  * @param {TenantBankAccountApiListTenantBankAccountsRequest} requestParameters Request parameters.
647
644
  * @param {*} [options] Override http request option.
648
645
  * @throws {RequiredError}
649
646
  * @memberof TenantBankAccountApi
650
647
  */
651
648
  public listTenantBankAccounts(requestParameters: TenantBankAccountApiListTenantBankAccountsRequest = {}, options?: AxiosRequestConfig) {
652
- 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));
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));
653
650
  }
654
651
 
655
652
  /**
656
- *
653
+ * Update a tenant bank account by code
654
+ * @summary Update the tenant bank account
657
655
  * @param {TenantBankAccountApiUpdateTenantBankAccountRequest} requestParameters Request parameters.
658
656
  * @param {*} [options] Override http request option.
659
657
  * @throws {RequiredError}
@@ -2,10 +2,10 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Emil Payment Service
5
- * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- * Contact: z
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -27,9 +27,10 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
27
27
  export const WebhooksApiAxiosParamCreator = function (configuration?: Configuration) {
28
28
  return {
29
29
  /**
30
- *
31
- * @param {string} pspType
32
- * @param {string} tenantSlug
30
+ * This will processes the webhook from external payment service provider.
31
+ * @summary Handle the webhook from PSP
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&lt;/i&gt;
33
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
33
34
  * @param {*} [options] Override http request option.
34
35
  * @throws {RequiredError}
35
36
  */
@@ -76,9 +77,10 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
76
77
  const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration)
77
78
  return {
78
79
  /**
79
- *
80
- * @param {string} pspType
81
- * @param {string} tenantSlug
80
+ * This will processes the webhook from external payment service provider.
81
+ * @summary Handle the webhook from PSP
82
+ * @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&lt;/i&gt;
83
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
82
84
  * @param {*} [options] Override http request option.
83
85
  * @throws {RequiredError}
84
86
  */
@@ -97,9 +99,10 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
97
99
  const localVarFp = WebhooksApiFp(configuration)
98
100
  return {
99
101
  /**
100
- *
101
- * @param {string} pspType
102
- * @param {string} tenantSlug
102
+ * This will processes the webhook from external payment service provider.
103
+ * @summary Handle the webhook from PSP
104
+ * @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&lt;/i&gt;
105
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
103
106
  * @param {*} [options] Override http request option.
104
107
  * @throws {RequiredError}
105
108
  */
@@ -116,14 +119,14 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
116
119
  */
117
120
  export interface WebhooksApiPostWebhookRequest {
118
121
  /**
119
- *
122
+ * The type of the payment service provider (PSP).&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Supported PSP: braintree, stripe, b4u, eis&lt;/i&gt;
120
123
  * @type {string}
121
124
  * @memberof WebhooksApiPostWebhook
122
125
  */
123
126
  readonly pspType: string
124
127
 
125
128
  /**
126
- *
129
+ * Unique slug identifier representing a tenant.
127
130
  * @type {string}
128
131
  * @memberof WebhooksApiPostWebhook
129
132
  */
@@ -138,7 +141,8 @@ export interface WebhooksApiPostWebhookRequest {
138
141
  */
139
142
  export class WebhooksApi extends BaseAPI {
140
143
  /**
141
- *
144
+ * This will processes the webhook from external payment service provider.
145
+ * @summary Handle the webhook from PSP
142
146
  * @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
143
147
  * @param {*} [options] Override http request option.
144
148
  * @throws {RequiredError}
package/api.ts CHANGED
@@ -2,10 +2,10 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Emil Payment Service
5
- * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- * Contact: z
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -22,22 +22,24 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
23
  import { BankAccountsApi } from './api';
24
24
  import { BankTransactionApi } from './api';
25
- import { DefaultApi } from './api';
25
+ import { HealthCheckApi } from './api';
26
26
  import { PaymentMethodsApi } from './api';
27
27
  import { PaymentRemindersApi } from './api';
28
28
  import { PaymentSetupApi } from './api';
29
29
  import { PaymentsApi } from './api';
30
+ import { RefundsApi } from './api';
30
31
  import { TenantBankAccountApi } from './api';
31
32
  import { WebhooksApi } from './api';
32
33
 
33
34
 
34
35
  export * from './api/bank-accounts-api';
35
36
  export * from './api/bank-transaction-api';
36
- export * from './api/default-api';
37
+ export * from './api/health-check-api';
37
38
  export * from './api/payment-methods-api';
38
39
  export * from './api/payment-reminders-api';
39
40
  export * from './api/payment-setup-api';
40
41
  export * from './api/payments-api';
42
+ export * from './api/refunds-api';
41
43
  export * from './api/tenant-bank-account-api';
42
44
  export * from './api/webhooks-api';
43
45