@emilgroup/payment-sdk 1.4.1-beta.3 → 1.4.1-beta.31

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 (224) hide show
  1. package/.openapi-generator/FILES +12 -39
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +497 -47
  4. package/api/bank-transaction-api.ts +128 -96
  5. package/api/{default-api.ts → health-check-api.ts} +22 -18
  6. package/api/payment-methods-api.ts +74 -203
  7. package/api/payment-reminders-api.ts +76 -66
  8. package/api/payment-setup-api.ts +29 -37
  9. package/api/payments-api.ts +66 -89
  10. package/api/refunds-api.ts +74 -84
  11. package/api/tenant-bank-account-api.ts +88 -62
  12. package/api/webhooks-api.ts +17 -13
  13. package/api.ts +3 -3
  14. package/base.ts +6 -2
  15. package/common.ts +2 -2
  16. package/configuration.ts +1 -1
  17. package/dist/api/bank-accounts-api.d.ts +297 -49
  18. package/dist/api/bank-accounts-api.js +416 -28
  19. package/dist/api/bank-transaction-api.d.ts +109 -91
  20. package/dist/api/bank-transaction-api.js +83 -68
  21. package/dist/api/health-check-api.d.ts +70 -0
  22. package/dist/api/{default-api.js → health-check-api.js} +31 -27
  23. package/dist/api/payment-methods-api.d.ts +66 -134
  24. package/dist/api/payment-methods-api.js +55 -157
  25. package/dist/api/payment-reminders-api.d.ts +72 -65
  26. package/dist/api/payment-reminders-api.js +48 -42
  27. package/dist/api/payment-setup-api.d.ts +19 -23
  28. package/dist/api/payment-setup-api.js +25 -25
  29. package/dist/api/payments-api.d.ts +64 -76
  30. package/dist/api/payments-api.js +47 -55
  31. package/dist/api/refunds-api.d.ts +74 -74
  32. package/dist/api/refunds-api.js +52 -48
  33. package/dist/api/tenant-bank-account-api.d.ts +89 -66
  34. package/dist/api/tenant-bank-account-api.js +59 -39
  35. package/dist/api/webhooks-api.d.ts +17 -13
  36. package/dist/api/webhooks-api.js +15 -11
  37. package/dist/api.d.ts +2 -2
  38. package/dist/api.js +2 -2
  39. package/dist/base.d.ts +2 -1
  40. package/dist/base.js +5 -2
  41. package/dist/common.d.ts +2 -2
  42. package/dist/common.js +1 -1
  43. package/dist/configuration.d.ts +1 -1
  44. package/dist/configuration.js +1 -1
  45. package/dist/index.d.ts +1 -1
  46. package/dist/index.js +1 -1
  47. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +26 -34
  48. package/dist/models/{bank-account-class.js → bank-transaction-class-without-expand-properties.js} +1 -1
  49. package/dist/models/create-bank-account-request-dto.d.ts +15 -3
  50. package/dist/models/create-bank-account-request-dto.js +1 -1
  51. package/dist/models/create-payment-reminder-request-dto.d.ts +1 -1
  52. package/dist/models/create-payment-reminder-request-dto.js +1 -1
  53. package/dist/models/create-payment-request-dto.d.ts +4 -4
  54. package/dist/models/create-payment-request-dto.js +1 -1
  55. package/dist/models/create-refund-request-dto.d.ts +1 -1
  56. package/dist/models/create-refund-request-dto.js +1 -1
  57. package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
  58. package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
  59. package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
  60. package/dist/models/{bank-transaction-response-class.js → create-tenant-bank-account-response-class.js} +1 -1
  61. package/dist/models/deactivate-payment-reminder-request-dto.d.ts +1 -1
  62. package/dist/models/deactivate-payment-reminder-request-dto.js +1 -1
  63. package/dist/models/get-tenant-bank-account-response-class.d.ts +5 -5
  64. package/dist/models/get-tenant-bank-account-response-class.js +1 -1
  65. package/dist/models/index.d.ts +11 -38
  66. package/dist/models/index.js +11 -38
  67. package/dist/models/inline-response200.d.ts +1 -1
  68. package/dist/models/inline-response200.js +1 -1
  69. package/dist/models/inline-response503.d.ts +1 -1
  70. package/dist/models/inline-response503.js +1 -1
  71. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +24 -0
  72. package/dist/models/{billing-profile-limited-response-dto.js → link-bank-transaction-request-dto-rest.js} +1 -1
  73. package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
  74. package/dist/models/{billing-profile-dto.js → list-tenant-bank-account-response-class.js} +1 -1
  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-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +11 -11
  78. package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
  79. package/dist/models/tenant-bank-account-class.d.ts +73 -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 +1 -1
  90. package/dist/models/update-tenant-bank-account-rest-request-dto.js +1 -1
  91. package/dist/models/validate-pspconfig-request-dto.d.ts +2 -9
  92. package/dist/models/validate-pspconfig-request-dto.js +1 -8
  93. package/index.ts +1 -1
  94. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +26 -34
  95. package/models/create-bank-account-request-dto.ts +15 -3
  96. package/models/create-payment-reminder-request-dto.ts +1 -1
  97. package/models/create-payment-request-dto.ts +4 -4
  98. package/models/create-refund-request-dto.ts +1 -1
  99. package/models/create-tenant-bank-account-request-dto.ts +1 -1
  100. package/models/create-tenant-bank-account-response-class.ts +31 -0
  101. package/models/deactivate-payment-reminder-request-dto.ts +1 -1
  102. package/models/get-tenant-bank-account-response-class.ts +5 -5
  103. package/models/index.ts +11 -38
  104. package/models/inline-response200.ts +1 -1
  105. package/models/inline-response503.ts +1 -1
  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} +11 -11
  110. package/models/tenant-bank-account-class.ts +79 -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 +1 -1
  116. package/models/validate-pspconfig-request-dto.ts +2 -12
  117. package/package.json +1 -1
  118. package/dist/api/default-api.d.ts +0 -66
  119. package/dist/models/bank-account-class.d.ts +0 -54
  120. package/dist/models/billing-profile-dto.d.ts +0 -38
  121. package/dist/models/billing-profile-limited-response-dto.d.ts +0 -54
  122. package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +0 -48
  123. package/dist/models/complete-braintree-payment-setup-request-dto.js +0 -15
  124. package/dist/models/complete-payment-setup-request-dto.d.ts +0 -32
  125. package/dist/models/complete-payment-setup-request-dto.js +0 -15
  126. package/dist/models/complete-payment-setup-response-class.d.ts +0 -25
  127. package/dist/models/complete-payment-setup-response-class.js +0 -15
  128. package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +0 -60
  129. package/dist/models/complete-stripe-payment-setup-request-dto.js +0 -15
  130. package/dist/models/create-payment-method-response-class.d.ts +0 -25
  131. package/dist/models/create-payment-method-response-class.js +0 -15
  132. package/dist/models/create-payment-response-class.d.ts +0 -25
  133. package/dist/models/create-payment-response-class.js +0 -15
  134. package/dist/models/create-psp-payment-method-request-dto.d.ts +0 -61
  135. package/dist/models/create-psp-payment-method-request-dto.js +0 -32
  136. package/dist/models/create-refund-response-class.d.ts +0 -25
  137. package/dist/models/create-refund-response-class.js +0 -15
  138. package/dist/models/deactivate-payment-reminder-response-class.d.ts +0 -25
  139. package/dist/models/deactivate-payment-reminder-response-class.js +0 -15
  140. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  141. package/dist/models/get-bank-transactions-response-class.js +0 -15
  142. package/dist/models/get-payment-method-response-class.d.ts +0 -25
  143. package/dist/models/get-payment-method-response-class.js +0 -15
  144. package/dist/models/get-payment-response-class.d.ts +0 -25
  145. package/dist/models/get-payment-response-class.js +0 -15
  146. package/dist/models/get-refund-response-class.d.ts +0 -25
  147. package/dist/models/get-refund-response-class.js +0 -15
  148. package/dist/models/get-request-dto.d.ts +0 -30
  149. package/dist/models/get-request-dto.js +0 -15
  150. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +0 -30
  151. package/dist/models/initiate-braintree-payment-setup-request-dto.js +0 -15
  152. package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +0 -24
  153. package/dist/models/initiate-braintree-payment-setup-response-class.js +0 -15
  154. package/dist/models/initiate-payment-setup-request-dto.d.ts +0 -44
  155. package/dist/models/initiate-payment-setup-request-dto.js +0 -15
  156. package/dist/models/initiate-payment-setup-response-class.d.ts +0 -32
  157. package/dist/models/initiate-payment-setup-response-class.js +0 -15
  158. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +0 -30
  159. package/dist/models/initiate-stripe-payment-setup-request-dto.js +0 -15
  160. package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +0 -30
  161. package/dist/models/initiate-stripe-payment-setup-response-class.js +0 -15
  162. package/dist/models/list-bank-accounts-response-class.d.ts +0 -31
  163. package/dist/models/list-bank-accounts-response-class.js +0 -15
  164. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  165. package/dist/models/list-bank-transactions-response-class.js +0 -15
  166. package/dist/models/list-payment-methods-response-class.d.ts +0 -31
  167. package/dist/models/list-payment-methods-response-class.js +0 -15
  168. package/dist/models/list-payment-reminders-response-class.d.ts +0 -31
  169. package/dist/models/list-payment-reminders-response-class.js +0 -15
  170. package/dist/models/list-payments-response-class.d.ts +0 -31
  171. package/dist/models/list-payments-response-class.js +0 -15
  172. package/dist/models/list-refunds-response-class.d.ts +0 -31
  173. package/dist/models/list-refunds-response-class.js +0 -15
  174. package/dist/models/payment-class.d.ts +0 -103
  175. package/dist/models/payment-class.js +0 -15
  176. package/dist/models/payment-method-class.d.ts +0 -66
  177. package/dist/models/payment-method-class.js +0 -15
  178. package/dist/models/payment-reminder-class.d.ts +0 -112
  179. package/dist/models/payment-reminder-class.js +0 -36
  180. package/dist/models/refund-class.d.ts +0 -104
  181. package/dist/models/refund-class.js +0 -28
  182. package/dist/models/sepa-direct-dto.d.ts +0 -24
  183. package/dist/models/sepa-direct-dto.js +0 -15
  184. package/dist/models/symphony-profile-limited-response-dto.d.ts +0 -42
  185. package/dist/models/symphony-profile-limited-response-dto.js +0 -15
  186. package/dist/models/tenant-bank-account-response-class.js +0 -15
  187. package/dist/models/transaction-class.d.ts +0 -54
  188. package/dist/models/transaction-class.js +0 -15
  189. package/models/bank-account-class.ts +0 -60
  190. package/models/billing-profile-dto.ts +0 -44
  191. package/models/billing-profile-limited-response-dto.ts +0 -60
  192. package/models/complete-braintree-payment-setup-request-dto.ts +0 -54
  193. package/models/complete-payment-setup-request-dto.ts +0 -38
  194. package/models/complete-payment-setup-response-class.ts +0 -31
  195. package/models/complete-stripe-payment-setup-request-dto.ts +0 -66
  196. package/models/create-payment-method-response-class.ts +0 -31
  197. package/models/create-payment-response-class.ts +0 -31
  198. package/models/create-psp-payment-method-request-dto.ts +0 -70
  199. package/models/create-refund-response-class.ts +0 -31
  200. package/models/deactivate-payment-reminder-response-class.ts +0 -31
  201. package/models/get-bank-transactions-response-class.ts +0 -31
  202. package/models/get-payment-method-response-class.ts +0 -31
  203. package/models/get-payment-response-class.ts +0 -31
  204. package/models/get-refund-response-class.ts +0 -31
  205. package/models/get-request-dto.ts +0 -36
  206. package/models/initiate-braintree-payment-setup-request-dto.ts +0 -36
  207. package/models/initiate-braintree-payment-setup-response-class.ts +0 -30
  208. package/models/initiate-payment-setup-request-dto.ts +0 -50
  209. package/models/initiate-payment-setup-response-class.ts +0 -38
  210. package/models/initiate-stripe-payment-setup-request-dto.ts +0 -36
  211. package/models/initiate-stripe-payment-setup-response-class.ts +0 -36
  212. package/models/list-bank-accounts-response-class.ts +0 -37
  213. package/models/list-bank-transactions-response-class.ts +0 -37
  214. package/models/list-payment-methods-response-class.ts +0 -37
  215. package/models/list-payment-reminders-response-class.ts +0 -37
  216. package/models/list-payments-response-class.ts +0 -37
  217. package/models/list-refunds-response-class.ts +0 -37
  218. package/models/payment-class.ts +0 -109
  219. package/models/payment-method-class.ts +0 -72
  220. package/models/payment-reminder-class.ts +0 -122
  221. package/models/refund-class.ts +0 -114
  222. package/models/sepa-direct-dto.ts +0 -30
  223. package/models/symphony-profile-limited-response-dto.ts +0 -48
  224. package/models/transaction-class.ts +0 -60
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Emil Payment Service
6
- * 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
+ * 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.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0
9
9
  * Contact: kontakt@emil.de
@@ -93,7 +93,8 @@ var RefundsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- *
96
+ * This will create a refund in the database.
97
+ * @summary Create the refund
97
98
  * @param {CreateRefundRequestDto} createRefundRequestDto
98
99
  * @param {string} [authorization] Bearer Token
99
100
  * @param {*} [options] Override http request option.
@@ -141,15 +142,15 @@ var RefundsApiAxiosParamCreator = function (configuration) {
141
142
  });
142
143
  },
143
144
  /**
144
- *
145
- * @param {string} code
146
- * @param {string} code2 Unique identifier for the object.
145
+ * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
146
+ * @summary Retrieve the refund
147
+ * @param {string} code Unique identifier for the object.
147
148
  * @param {string} [authorization] Bearer Token
148
- * @param {string} [expand] Fields to expand response by
149
+ * @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: .<i>
149
150
  * @param {*} [options] Override http request option.
150
151
  * @throws {RequiredError}
151
152
  */
152
- getRefund: function (code, code2, authorization, expand, options) {
153
+ getRefund: function (code, authorization, expand, options) {
153
154
  if (options === void 0) { options = {}; }
154
155
  return __awaiter(_this, void 0, void 0, function () {
155
156
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -158,8 +159,6 @@ var RefundsApiAxiosParamCreator = function (configuration) {
158
159
  case 0:
159
160
  // verify required parameter 'code' is not null or undefined
160
161
  (0, common_1.assertParamExists)('getRefund', 'code', code);
161
- // verify required parameter 'code2' is not null or undefined
162
- (0, common_1.assertParamExists)('getRefund', 'code2', code2);
163
162
  localVarPath = "/paymentservice/v1/refunds/{code}"
164
163
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
165
164
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -177,9 +176,6 @@ var RefundsApiAxiosParamCreator = function (configuration) {
177
176
  // authentication bearer required
178
177
  // http bearer authentication required
179
178
  _a.sent();
180
- if (code2 !== undefined) {
181
- localVarQueryParameter['code'] = code2;
182
- }
183
179
  if (expand !== undefined) {
184
180
  localVarQueryParameter['expand'] = expand;
185
181
  }
@@ -198,15 +194,16 @@ var RefundsApiAxiosParamCreator = function (configuration) {
198
194
  });
199
195
  },
200
196
  /**
201
- *
197
+ * Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
198
+ * @summary List refunds
202
199
  * @param {string} [authorization] Bearer Token
203
200
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
204
201
  * @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.
205
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
206
- * @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.
207
- * @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.
208
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
209
- * @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.
202
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
203
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
204
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
205
+ * @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: .<i>
206
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
210
207
  * @param {*} [options] Override http request option.
211
208
  * @throws {RequiredError}
212
209
  */
@@ -279,7 +276,8 @@ var RefundsApiFp = function (configuration) {
279
276
  var localVarAxiosParamCreator = (0, exports.RefundsApiAxiosParamCreator)(configuration);
280
277
  return {
281
278
  /**
282
- *
279
+ * This will create a refund in the database.
280
+ * @summary Create the refund
283
281
  * @param {CreateRefundRequestDto} createRefundRequestDto
284
282
  * @param {string} [authorization] Bearer Token
285
283
  * @param {*} [options] Override http request option.
@@ -299,20 +297,20 @@ var RefundsApiFp = function (configuration) {
299
297
  });
300
298
  },
301
299
  /**
302
- *
303
- * @param {string} code
304
- * @param {string} code2 Unique identifier for the object.
300
+ * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
301
+ * @summary Retrieve the refund
302
+ * @param {string} code Unique identifier for the object.
305
303
  * @param {string} [authorization] Bearer Token
306
- * @param {string} [expand] Fields to expand response by
304
+ * @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: .<i>
307
305
  * @param {*} [options] Override http request option.
308
306
  * @throws {RequiredError}
309
307
  */
310
- getRefund: function (code, code2, authorization, expand, options) {
308
+ getRefund: function (code, authorization, expand, options) {
311
309
  return __awaiter(this, void 0, void 0, function () {
312
310
  var localVarAxiosArgs;
313
311
  return __generator(this, function (_a) {
314
312
  switch (_a.label) {
315
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getRefund(code, code2, authorization, expand, options)];
313
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getRefund(code, authorization, expand, options)];
316
314
  case 1:
317
315
  localVarAxiosArgs = _a.sent();
318
316
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -321,15 +319,16 @@ var RefundsApiFp = function (configuration) {
321
319
  });
322
320
  },
323
321
  /**
324
- *
322
+ * Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
323
+ * @summary List refunds
325
324
  * @param {string} [authorization] Bearer Token
326
325
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
327
326
  * @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.
328
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
329
- * @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.
330
- * @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.
331
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
332
- * @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.
327
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
328
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
329
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
330
+ * @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: .<i>
331
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
333
332
  * @param {*} [options] Override http request option.
334
333
  * @throws {RequiredError}
335
334
  */
@@ -357,7 +356,8 @@ var RefundsApiFactory = function (configuration, basePath, axios) {
357
356
  var localVarFp = (0, exports.RefundsApiFp)(configuration);
358
357
  return {
359
358
  /**
360
- *
359
+ * This will create a refund in the database.
360
+ * @summary Create the refund
361
361
  * @param {CreateRefundRequestDto} createRefundRequestDto
362
362
  * @param {string} [authorization] Bearer Token
363
363
  * @param {*} [options] Override http request option.
@@ -367,27 +367,28 @@ var RefundsApiFactory = function (configuration, basePath, axios) {
367
367
  return localVarFp.createRefund(createRefundRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
368
368
  },
369
369
  /**
370
- *
371
- * @param {string} code
372
- * @param {string} code2 Unique identifier for the object.
370
+ * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
371
+ * @summary Retrieve the refund
372
+ * @param {string} code Unique identifier for the object.
373
373
  * @param {string} [authorization] Bearer Token
374
- * @param {string} [expand] Fields to expand response by
374
+ * @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: .<i>
375
375
  * @param {*} [options] Override http request option.
376
376
  * @throws {RequiredError}
377
377
  */
378
- getRefund: function (code, code2, authorization, expand, options) {
379
- return localVarFp.getRefund(code, code2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
378
+ getRefund: function (code, authorization, expand, options) {
379
+ return localVarFp.getRefund(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
380
380
  },
381
381
  /**
382
- *
382
+ * Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
383
+ * @summary List refunds
383
384
  * @param {string} [authorization] Bearer Token
384
385
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
385
386
  * @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.
386
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
387
- * @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.
388
- * @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.
389
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
390
- * @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.
387
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
388
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
389
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
390
+ * @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: .<i>
391
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
391
392
  * @param {*} [options] Override http request option.
392
393
  * @throws {RequiredError}
393
394
  */
@@ -409,7 +410,8 @@ var RefundsApi = /** @class */ (function (_super) {
409
410
  return _super !== null && _super.apply(this, arguments) || this;
410
411
  }
411
412
  /**
412
- *
413
+ * This will create a refund in the database.
414
+ * @summary Create the refund
413
415
  * @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
414
416
  * @param {*} [options] Override http request option.
415
417
  * @throws {RequiredError}
@@ -420,7 +422,8 @@ var RefundsApi = /** @class */ (function (_super) {
420
422
  return (0, exports.RefundsApiFp)(this.configuration).createRefund(requestParameters.createRefundRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
421
423
  };
422
424
  /**
423
- *
425
+ * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
426
+ * @summary Retrieve the refund
424
427
  * @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
425
428
  * @param {*} [options] Override http request option.
426
429
  * @throws {RequiredError}
@@ -428,10 +431,11 @@ var RefundsApi = /** @class */ (function (_super) {
428
431
  */
429
432
  RefundsApi.prototype.getRefund = function (requestParameters, options) {
430
433
  var _this = this;
431
- return (0, exports.RefundsApiFp)(this.configuration).getRefund(requestParameters.code, requestParameters.code2, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
434
+ return (0, exports.RefundsApiFp)(this.configuration).getRefund(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
432
435
  };
433
436
  /**
434
- *
437
+ * Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
438
+ * @summary List refunds
435
439
  * @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
436
440
  * @param {*} [options] Override http request option.
437
441
  * @throws {RequiredError}
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Emil Payment Service
3
- * 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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0
6
6
  * Contact: kontakt@emil.de
@@ -13,7 +13,10 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateTenantBankAccountRequestDto } from '../models';
16
+ import { CreateTenantBankAccountResponseClass } from '../models';
16
17
  import { GetTenantBankAccountResponseClass } from '../models';
18
+ import { ListTenantBankAccountResponseClass } from '../models';
19
+ import { UpdateTenantBankAccountResponseClass } from '../models';
17
20
  import { UpdateTenantBankAccountRestRequestDto } from '../models';
18
21
  /**
19
22
  * TenantBankAccountApi - axios parameter creator
@@ -21,7 +24,8 @@ import { UpdateTenantBankAccountRestRequestDto } from '../models';
21
24
  */
22
25
  export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Configuration) => {
23
26
  /**
24
- *
27
+ * This will create a new tenant bank account
28
+ * @summary Create the tenant bank account
25
29
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
26
30
  * @param {string} [authorization] Bearer Token
27
31
  * @param {*} [options] Override http request option.
@@ -29,7 +33,8 @@ export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Con
29
33
  */
30
34
  createTenantBankAccount: (createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
35
  /**
32
- *
36
+ * Deletes a tenant bank account by code
37
+ * @summary Delete the tenant bank account
33
38
  * @param {string} code Unique identifier for the object.
34
39
  * @param {string} [authorization] Bearer Token
35
40
  * @param {*} [options] Override http request option.
@@ -37,30 +42,33 @@ export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Con
37
42
  */
38
43
  deleteTenantBankAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
44
  /**
40
- *
45
+ * 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.
46
+ * @summary Retrieve the tenant bank account
41
47
  * @param {string} code Unique identifier for the object.
42
48
  * @param {string} [authorization] Bearer Token
43
- * @param {string} [expand] Expand the response with additional entities
49
+ * @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;
44
50
  * @param {*} [options] Override http request option.
45
51
  * @throws {RequiredError}
46
52
  */
47
53
  getTenantBankAccount: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48
54
  /**
49
- *
55
+ * 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.
56
+ * @summary List tenant bank accounts
50
57
  * @param {string} [authorization] Bearer Token
51
58
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
52
59
  * @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.
53
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
54
- * @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.
55
- * @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.
56
- * @param {string} [expand] Expand the response with additional entities
57
- * @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.
60
+ * @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;
61
+ * @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;
62
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
63
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankTransactions.&lt;i&gt;
64
+ * @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;
58
65
  * @param {*} [options] Override http request option.
59
66
  * @throws {RequiredError}
60
67
  */
61
- listTenantBankAccounts: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ listTenantBankAccounts: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
69
  /**
63
- *
70
+ * Update a tenant bank account by code
71
+ * @summary Update the tenant bank account
64
72
  * @param {string} code Unique identifier for the object.
65
73
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
66
74
  * @param {string} [authorization] Bearer Token
@@ -75,53 +83,58 @@ export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Con
75
83
  */
76
84
  export declare const TenantBankAccountApiFp: (configuration?: Configuration) => {
77
85
  /**
78
- *
86
+ * This will create a new tenant bank account
87
+ * @summary Create the tenant bank account
79
88
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
80
89
  * @param {string} [authorization] Bearer Token
81
90
  * @param {*} [options] Override http request option.
82
91
  * @throws {RequiredError}
83
92
  */
84
- createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
93
+ createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTenantBankAccountResponseClass>>;
85
94
  /**
86
- *
95
+ * Deletes a tenant bank account by code
96
+ * @summary Delete the tenant bank account
87
97
  * @param {string} code Unique identifier for the object.
88
98
  * @param {string} [authorization] Bearer Token
89
99
  * @param {*} [options] Override http request option.
90
100
  * @throws {RequiredError}
91
101
  */
92
- deleteTenantBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
102
+ deleteTenantBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
93
103
  /**
94
- *
104
+ * 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.
105
+ * @summary Retrieve the tenant bank account
95
106
  * @param {string} code Unique identifier for the object.
96
107
  * @param {string} [authorization] Bearer Token
97
- * @param {string} [expand] Expand the response with additional entities
108
+ * @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;
98
109
  * @param {*} [options] Override http request option.
99
110
  * @throws {RequiredError}
100
111
  */
101
112
  getTenantBankAccount(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTenantBankAccountResponseClass>>;
102
113
  /**
103
- *
114
+ * 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.
115
+ * @summary List tenant bank accounts
104
116
  * @param {string} [authorization] Bearer Token
105
117
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
106
118
  * @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.
107
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
108
- * @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.
109
- * @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.
110
- * @param {string} [expand] Expand the response with additional entities
111
- * @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.
119
+ * @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;
120
+ * @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;
121
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
122
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankTransactions.&lt;i&gt;
123
+ * @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;
112
124
  * @param {*} [options] Override http request option.
113
125
  * @throws {RequiredError}
114
126
  */
115
- 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>>;
127
+ listTenantBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTenantBankAccountResponseClass>>;
116
128
  /**
117
- *
129
+ * Update a tenant bank account by code
130
+ * @summary Update the tenant bank account
118
131
  * @param {string} code Unique identifier for the object.
119
132
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
120
133
  * @param {string} [authorization] Bearer Token
121
134
  * @param {*} [options] Override http request option.
122
135
  * @throws {RequiredError}
123
136
  */
124
- updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
137
+ updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTenantBankAccountResponseClass>>;
125
138
  };
126
139
  /**
127
140
  * TenantBankAccountApi - factory interface
@@ -129,53 +142,58 @@ export declare const TenantBankAccountApiFp: (configuration?: Configuration) =>
129
142
  */
130
143
  export declare const TenantBankAccountApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
131
144
  /**
132
- *
145
+ * This will create a new tenant bank account
146
+ * @summary Create the tenant bank account
133
147
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
134
148
  * @param {string} [authorization] Bearer Token
135
149
  * @param {*} [options] Override http request option.
136
150
  * @throws {RequiredError}
137
151
  */
138
- createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
152
+ createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTenantBankAccountResponseClass>;
139
153
  /**
140
- *
154
+ * Deletes a tenant bank account by code
155
+ * @summary Delete the tenant bank account
141
156
  * @param {string} code Unique identifier for the object.
142
157
  * @param {string} [authorization] Bearer Token
143
158
  * @param {*} [options] Override http request option.
144
159
  * @throws {RequiredError}
145
160
  */
146
- deleteTenantBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<void>;
161
+ deleteTenantBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<object>;
147
162
  /**
148
- *
163
+ * 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.
164
+ * @summary Retrieve the tenant bank account
149
165
  * @param {string} code Unique identifier for the object.
150
166
  * @param {string} [authorization] Bearer Token
151
- * @param {string} [expand] Expand the response with additional entities
167
+ * @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;
152
168
  * @param {*} [options] Override http request option.
153
169
  * @throws {RequiredError}
154
170
  */
155
171
  getTenantBankAccount(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetTenantBankAccountResponseClass>;
156
172
  /**
157
- *
173
+ * 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.
174
+ * @summary List tenant bank accounts
158
175
  * @param {string} [authorization] Bearer Token
159
176
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
160
177
  * @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.
161
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
162
- * @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.
163
- * @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.
164
- * @param {string} [expand] Expand the response with additional entities
165
- * @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.
178
+ * @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;
179
+ * @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;
180
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
181
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankTransactions.&lt;i&gt;
182
+ * @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;
166
183
  * @param {*} [options] Override http request option.
167
184
  * @throws {RequiredError}
168
185
  */
169
- listTenantBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, filters?: any, options?: any): AxiosPromise<void>;
186
+ listTenantBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTenantBankAccountResponseClass>;
170
187
  /**
171
- *
188
+ * Update a tenant bank account by code
189
+ * @summary Update the tenant bank account
172
190
  * @param {string} code Unique identifier for the object.
173
191
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
174
192
  * @param {string} [authorization] Bearer Token
175
193
  * @param {*} [options] Override http request option.
176
194
  * @throws {RequiredError}
177
195
  */
178
- updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
196
+ updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateTenantBankAccountResponseClass>;
179
197
  };
180
198
  /**
181
199
  * Request parameters for createTenantBankAccount operation in TenantBankAccountApi.
@@ -234,7 +252,7 @@ export interface TenantBankAccountApiGetTenantBankAccountRequest {
234
252
  */
235
253
  readonly authorization?: string;
236
254
  /**
237
- * Expand the response with additional entities
255
+ * 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;
238
256
  * @type {string}
239
257
  * @memberof TenantBankAccountApiGetTenantBankAccount
240
258
  */
@@ -265,35 +283,35 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
265
283
  */
266
284
  readonly pageToken?: any;
267
285
  /**
268
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
269
- * @type {any}
286
+ * 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;
287
+ * @type {string}
270
288
  * @memberof TenantBankAccountApiListTenantBankAccounts
271
289
  */
272
- readonly filter?: any;
290
+ readonly filter?: string;
273
291
  /**
274
- * 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.
275
- * @type {any}
292
+ * 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;
293
+ * @type {string}
276
294
  * @memberof TenantBankAccountApiListTenantBankAccounts
277
295
  */
278
- readonly search?: any;
296
+ readonly search?: string;
279
297
  /**
280
- * 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.
281
- * @type {any}
298
+ * 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;
299
+ * @type {string}
282
300
  * @memberof TenantBankAccountApiListTenantBankAccounts
283
301
  */
284
- readonly order?: any;
302
+ readonly order?: string;
285
303
  /**
286
- * Expand the response with additional entities
304
+ * 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;
287
305
  * @type {string}
288
306
  * @memberof TenantBankAccountApiListTenantBankAccounts
289
307
  */
290
308
  readonly expand?: string;
291
309
  /**
292
- * 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.
293
- * @type {any}
310
+ * 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;
311
+ * @type {string}
294
312
  * @memberof TenantBankAccountApiListTenantBankAccounts
295
313
  */
296
- readonly filters?: any;
314
+ readonly filters?: string;
297
315
  }
298
316
  /**
299
317
  * Request parameters for updateTenantBankAccount operation in TenantBankAccountApi.
@@ -328,23 +346,26 @@ export interface TenantBankAccountApiUpdateTenantBankAccountRequest {
328
346
  */
329
347
  export declare class TenantBankAccountApi extends BaseAPI {
330
348
  /**
331
- *
349
+ * This will create a new tenant bank account
350
+ * @summary Create the tenant bank account
332
351
  * @param {TenantBankAccountApiCreateTenantBankAccountRequest} requestParameters Request parameters.
333
352
  * @param {*} [options] Override http request option.
334
353
  * @throws {RequiredError}
335
354
  * @memberof TenantBankAccountApi
336
355
  */
337
- createTenantBankAccount(requestParameters: TenantBankAccountApiCreateTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
356
+ createTenantBankAccount(requestParameters: TenantBankAccountApiCreateTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTenantBankAccountResponseClass, any>>;
338
357
  /**
339
- *
358
+ * Deletes a tenant bank account by code
359
+ * @summary Delete the tenant bank account
340
360
  * @param {TenantBankAccountApiDeleteTenantBankAccountRequest} requestParameters Request parameters.
341
361
  * @param {*} [options] Override http request option.
342
362
  * @throws {RequiredError}
343
363
  * @memberof TenantBankAccountApi
344
364
  */
345
- deleteTenantBankAccount(requestParameters: TenantBankAccountApiDeleteTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
365
+ deleteTenantBankAccount(requestParameters: TenantBankAccountApiDeleteTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
346
366
  /**
347
- *
367
+ * 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.
368
+ * @summary Retrieve the tenant bank account
348
369
  * @param {TenantBankAccountApiGetTenantBankAccountRequest} requestParameters Request parameters.
349
370
  * @param {*} [options] Override http request option.
350
371
  * @throws {RequiredError}
@@ -352,19 +373,21 @@ export declare class TenantBankAccountApi extends BaseAPI {
352
373
  */
353
374
  getTenantBankAccount(requestParameters: TenantBankAccountApiGetTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTenantBankAccountResponseClass, any>>;
354
375
  /**
355
- *
376
+ * 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.
377
+ * @summary List tenant bank accounts
356
378
  * @param {TenantBankAccountApiListTenantBankAccountsRequest} requestParameters Request parameters.
357
379
  * @param {*} [options] Override http request option.
358
380
  * @throws {RequiredError}
359
381
  * @memberof TenantBankAccountApi
360
382
  */
361
- listTenantBankAccounts(requestParameters?: TenantBankAccountApiListTenantBankAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
383
+ listTenantBankAccounts(requestParameters?: TenantBankAccountApiListTenantBankAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTenantBankAccountResponseClass, any>>;
362
384
  /**
363
- *
385
+ * Update a tenant bank account by code
386
+ * @summary Update the tenant bank account
364
387
  * @param {TenantBankAccountApiUpdateTenantBankAccountRequest} requestParameters Request parameters.
365
388
  * @param {*} [options] Override http request option.
366
389
  * @throws {RequiredError}
367
390
  * @memberof TenantBankAccountApi
368
391
  */
369
- updateTenantBankAccount(requestParameters: TenantBankAccountApiUpdateTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
392
+ updateTenantBankAccount(requestParameters: TenantBankAccountApiUpdateTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTenantBankAccountResponseClass, any>>;
370
393
  }