@emilgroup/payment-sdk-node 1.13.1-beta.8 → 1.14.0

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 (272) hide show
  1. package/.openapi-generator/FILES +55 -5
  2. package/README.md +18 -2
  3. package/api/bank-accounts-api.ts +508 -88
  4. package/api/bank-transaction-api.ts +97 -117
  5. package/api/{default-api.ts → health-check-api.ts} +22 -18
  6. package/api/payment-methods-api.ts +83 -256
  7. package/api/payment-reminders-api.ts +71 -105
  8. package/api/payment-setup-api.ts +53 -37
  9. package/api/payments-api.ts +80 -137
  10. package/api/refunds-api.ts +78 -112
  11. package/api/tenant-bank-account-api.ts +96 -118
  12. package/api/webhooks-api.ts +17 -13
  13. package/api.ts +3 -3
  14. package/base.ts +17 -9
  15. package/common.ts +2 -2
  16. package/configuration.ts +1 -1
  17. package/dist/api/bank-accounts-api.d.ts +298 -71
  18. package/dist/api/bank-accounts-api.js +432 -62
  19. package/dist/api/bank-transaction-api.d.ts +85 -100
  20. package/dist/api/bank-transaction-api.js +63 -74
  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 -162
  24. package/dist/api/payment-methods-api.js +60 -190
  25. package/dist/api/payment-reminders-api.d.ts +66 -89
  26. package/dist/api/payment-reminders-api.js +44 -62
  27. package/dist/api/payment-setup-api.d.ts +39 -27
  28. package/dist/api/payment-setup-api.js +41 -33
  29. package/dist/api/payments-api.d.ts +70 -103
  30. package/dist/api/payments-api.js +55 -85
  31. package/dist/api/refunds-api.d.ts +68 -83
  32. package/dist/api/refunds-api.js +58 -68
  33. package/dist/api/tenant-bank-account-api.d.ts +90 -105
  34. package/dist/api/tenant-bank-account-api.js +63 -75
  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 +5 -3
  40. package/dist/base.js +27 -21
  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-account-class-without-expand-properties.d.ts +84 -0
  48. package/dist/models/{bank-transaction-response-class.js → bank-account-class-without-expand-properties.js} +1 -1
  49. package/dist/models/bank-account-class.d.ts +91 -0
  50. package/dist/models/{transaction-class.js → bank-account-class.js} +1 -1
  51. package/dist/models/bank-transaction-class-without-expand-properties.d.ts +126 -0
  52. package/dist/models/{get-request-dto.js → bank-transaction-class-without-expand-properties.js} +1 -1
  53. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class.d.ts} +41 -29
  54. package/dist/models/{tenant-bank-account-response-class.js → bank-transaction-class.js} +1 -1
  55. package/dist/models/billing-profile-dto.d.ts +38 -0
  56. package/dist/models/billing-profile-dto.js +15 -0
  57. package/dist/models/billing-profile-limited-response-dto.d.ts +54 -0
  58. package/dist/models/billing-profile-limited-response-dto.js +15 -0
  59. package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +48 -0
  60. package/dist/models/complete-braintree-payment-setup-request-dto.js +15 -0
  61. package/dist/models/complete-payment-setup-request-dto.d.ts +32 -0
  62. package/dist/models/complete-payment-setup-request-dto.js +15 -0
  63. package/dist/models/complete-payment-setup-response-class.d.ts +25 -0
  64. package/dist/models/complete-payment-setup-response-class.js +15 -0
  65. package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +77 -0
  66. package/dist/models/complete-stripe-payment-setup-request-dto.js +32 -0
  67. package/dist/models/create-bank-account-request-dto.d.ts +42 -0
  68. package/dist/models/create-bank-account-request-dto.js +15 -0
  69. package/dist/models/create-bank-account-response-class.d.ts +25 -0
  70. package/dist/models/create-bank-account-response-class.js +15 -0
  71. package/dist/models/create-payment-method-response-class.d.ts +25 -0
  72. package/dist/models/create-payment-method-response-class.js +15 -0
  73. package/dist/models/create-payment-reminder-request-dto.d.ts +1 -1
  74. package/dist/models/create-payment-reminder-request-dto.js +1 -1
  75. package/dist/models/create-payment-reminder-response-class.d.ts +25 -0
  76. package/dist/models/create-payment-reminder-response-class.js +15 -0
  77. package/dist/models/create-payment-request-dto.d.ts +4 -4
  78. package/dist/models/create-payment-request-dto.js +1 -1
  79. package/dist/models/create-payment-response-class.d.ts +25 -0
  80. package/dist/models/create-payment-response-class.js +15 -0
  81. package/dist/models/create-psp-payment-method-request-dto.d.ts +61 -0
  82. package/dist/models/create-psp-payment-method-request-dto.js +32 -0
  83. package/dist/models/create-refund-request-dto.d.ts +1 -1
  84. package/dist/models/create-refund-request-dto.js +1 -1
  85. package/dist/models/create-refund-response-class.d.ts +1 -1
  86. package/dist/models/create-refund-response-class.js +1 -1
  87. package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
  88. package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
  89. package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
  90. package/dist/models/create-tenant-bank-account-response-class.js +15 -0
  91. package/dist/models/deactivate-payment-reminder-request-dto.d.ts +1 -1
  92. package/dist/models/deactivate-payment-reminder-request-dto.js +1 -1
  93. package/dist/models/deactivate-payment-reminder-response-class.d.ts +25 -0
  94. package/dist/models/deactivate-payment-reminder-response-class.js +15 -0
  95. package/dist/models/deactivated-payment-reminder-class.d.ts +102 -0
  96. package/dist/models/deactivated-payment-reminder-class.js +15 -0
  97. package/dist/models/get-bank-account-response-class.d.ts +25 -0
  98. package/dist/models/get-bank-account-response-class.js +15 -0
  99. package/dist/models/get-bank-transactions-response-class.d.ts +4 -4
  100. package/dist/models/get-bank-transactions-response-class.js +1 -1
  101. package/dist/models/get-payment-method-response-class.d.ts +25 -0
  102. package/dist/models/get-payment-method-response-class.js +15 -0
  103. package/dist/models/get-payment-reminder-response-class.d.ts +25 -0
  104. package/dist/models/get-payment-reminder-response-class.js +15 -0
  105. package/dist/models/get-payment-response-class.d.ts +25 -0
  106. package/dist/models/get-payment-response-class.js +15 -0
  107. package/dist/models/get-refund-response-class.d.ts +1 -1
  108. package/dist/models/get-refund-response-class.js +1 -1
  109. package/dist/models/get-tenant-bank-account-response-class.d.ts +5 -5
  110. package/dist/models/get-tenant-bank-account-response-class.js +1 -1
  111. package/dist/models/import-bank-transactions-response-class.d.ts +25 -0
  112. package/dist/models/import-bank-transactions-response-class.js +15 -0
  113. package/dist/models/index.d.ts +54 -4
  114. package/dist/models/index.js +54 -4
  115. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +30 -0
  116. package/dist/models/initiate-braintree-payment-setup-request-dto.js +15 -0
  117. package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +24 -0
  118. package/dist/models/initiate-braintree-payment-setup-response-class.js +15 -0
  119. package/dist/models/initiate-payment-setup-request-dto.d.ts +44 -0
  120. package/dist/models/initiate-payment-setup-request-dto.js +15 -0
  121. package/dist/models/initiate-payment-setup-response-class.d.ts +32 -0
  122. package/dist/models/initiate-payment-setup-response-class.js +15 -0
  123. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +30 -0
  124. package/dist/models/initiate-stripe-payment-setup-request-dto.js +15 -0
  125. package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +30 -0
  126. package/dist/models/initiate-stripe-payment-setup-response-class.js +15 -0
  127. package/dist/models/inline-response200.d.ts +1 -1
  128. package/dist/models/inline-response200.js +1 -1
  129. package/dist/models/inline-response503.d.ts +1 -1
  130. package/dist/models/inline-response503.js +1 -1
  131. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +1 -1
  132. package/dist/models/link-bank-transaction-request-dto-rest.js +1 -1
  133. package/dist/models/link-bank-transactions-response-class.d.ts +25 -0
  134. package/dist/models/link-bank-transactions-response-class.js +15 -0
  135. package/dist/models/list-bank-accounts-response-class.d.ts +31 -0
  136. package/dist/models/list-bank-accounts-response-class.js +15 -0
  137. package/dist/models/list-bank-transactions-response-class.d.ts +6 -6
  138. package/dist/models/list-bank-transactions-response-class.js +1 -1
  139. package/dist/models/list-payment-methods-response-class.d.ts +31 -0
  140. package/dist/models/list-payment-methods-response-class.js +15 -0
  141. package/dist/models/list-payment-reminders-response-class.d.ts +31 -0
  142. package/dist/models/list-payment-reminders-response-class.js +15 -0
  143. package/dist/models/list-payments-response-class.d.ts +31 -0
  144. package/dist/models/list-payments-response-class.js +15 -0
  145. package/dist/models/list-refunds-response-class.d.ts +3 -3
  146. package/dist/models/list-refunds-response-class.js +1 -1
  147. package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
  148. package/dist/models/list-tenant-bank-account-response-class.js +15 -0
  149. package/dist/models/payment-class-without-expand-properties.d.ts +108 -0
  150. package/dist/models/payment-class-without-expand-properties.js +15 -0
  151. package/dist/models/payment-class.d.ts +115 -0
  152. package/dist/models/payment-class.js +15 -0
  153. package/dist/models/payment-method-class.d.ts +78 -0
  154. package/dist/models/payment-method-class.js +15 -0
  155. package/dist/models/payment-reminder-class.d.ts +102 -0
  156. package/dist/models/payment-reminder-class.js +15 -0
  157. package/dist/models/primary-bank-account-response-class.d.ts +54 -0
  158. package/dist/models/primary-bank-account-response-class.js +15 -0
  159. package/dist/models/refund-class.d.ts +18 -4
  160. package/dist/models/refund-class.js +3 -2
  161. package/dist/models/refund-item-class.d.ts +114 -0
  162. package/dist/models/refund-item-class.js +15 -0
  163. package/dist/models/sepa-direct-dto.d.ts +24 -0
  164. package/dist/models/sepa-direct-dto.js +15 -0
  165. package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
  166. package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
  167. package/dist/models/shared-transaction-class.d.ts +72 -0
  168. package/dist/models/shared-transaction-class.js +15 -0
  169. package/dist/models/symphony-profile-limited-response-dto.d.ts +42 -0
  170. package/dist/models/symphony-profile-limited-response-dto.js +15 -0
  171. package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +23 -11
  172. package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
  173. package/dist/models/tenant-bank-account-class.d.ts +85 -0
  174. package/dist/models/tenant-bank-account-class.js +15 -0
  175. package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +2 -2
  176. package/dist/models/unlink-bank-transaction-request-dto-rest.js +1 -1
  177. package/dist/models/unlink-bank-transactions-response-class.d.ts +25 -0
  178. package/dist/models/unlink-bank-transactions-response-class.js +15 -0
  179. package/dist/models/unlinked-bank-transaction-response-class.d.ts +108 -0
  180. package/dist/models/unlinked-bank-transaction-response-class.js +15 -0
  181. package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
  182. package/dist/models/update-bank-account-request-dto-rest.js +15 -0
  183. package/dist/models/update-bank-account-request-dto.d.ts +36 -0
  184. package/dist/models/update-bank-account-request-dto.js +15 -0
  185. package/dist/models/update-bank-account-response-class.d.ts +25 -0
  186. package/dist/models/update-bank-account-response-class.js +15 -0
  187. package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
  188. package/dist/models/update-tenant-bank-account-response-class.js +15 -0
  189. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +1 -1
  190. package/dist/models/update-tenant-bank-account-rest-request-dto.js +1 -1
  191. package/dist/models/validate-pspconfig-request-dto.d.ts +9 -2
  192. package/dist/models/validate-pspconfig-request-dto.js +8 -1
  193. package/index.ts +1 -1
  194. package/models/bank-account-class-without-expand-properties.ts +90 -0
  195. package/models/bank-account-class.ts +97 -0
  196. package/models/bank-transaction-class-without-expand-properties.ts +132 -0
  197. package/models/{bank-transaction-response-class.ts → bank-transaction-class.ts} +41 -29
  198. package/models/billing-profile-dto.ts +44 -0
  199. package/models/billing-profile-limited-response-dto.ts +60 -0
  200. package/models/complete-braintree-payment-setup-request-dto.ts +54 -0
  201. package/models/complete-payment-setup-request-dto.ts +38 -0
  202. package/models/complete-payment-setup-response-class.ts +31 -0
  203. package/models/complete-stripe-payment-setup-request-dto.ts +86 -0
  204. package/models/create-bank-account-request-dto.ts +48 -0
  205. package/models/create-bank-account-response-class.ts +31 -0
  206. package/models/create-payment-method-response-class.ts +31 -0
  207. package/models/create-payment-reminder-request-dto.ts +1 -1
  208. package/models/create-payment-reminder-response-class.ts +31 -0
  209. package/models/create-payment-request-dto.ts +4 -4
  210. package/models/create-payment-response-class.ts +31 -0
  211. package/models/create-psp-payment-method-request-dto.ts +70 -0
  212. package/models/create-refund-request-dto.ts +1 -1
  213. package/models/create-refund-response-class.ts +1 -1
  214. package/models/create-tenant-bank-account-request-dto.ts +1 -1
  215. package/models/create-tenant-bank-account-response-class.ts +31 -0
  216. package/models/deactivate-payment-reminder-request-dto.ts +1 -1
  217. package/models/deactivate-payment-reminder-response-class.ts +31 -0
  218. package/models/deactivated-payment-reminder-class.ts +108 -0
  219. package/models/get-bank-account-response-class.ts +31 -0
  220. package/models/get-bank-transactions-response-class.ts +4 -4
  221. package/models/get-payment-method-response-class.ts +31 -0
  222. package/models/get-payment-reminder-response-class.ts +31 -0
  223. package/models/get-payment-response-class.ts +31 -0
  224. package/models/get-refund-response-class.ts +1 -1
  225. package/models/get-tenant-bank-account-response-class.ts +5 -5
  226. package/models/import-bank-transactions-response-class.ts +31 -0
  227. package/models/index.ts +54 -4
  228. package/models/initiate-braintree-payment-setup-request-dto.ts +36 -0
  229. package/models/initiate-braintree-payment-setup-response-class.ts +30 -0
  230. package/models/initiate-payment-setup-request-dto.ts +50 -0
  231. package/models/initiate-payment-setup-response-class.ts +38 -0
  232. package/models/initiate-stripe-payment-setup-request-dto.ts +36 -0
  233. package/models/initiate-stripe-payment-setup-response-class.ts +36 -0
  234. package/models/inline-response200.ts +1 -1
  235. package/models/inline-response503.ts +1 -1
  236. package/models/link-bank-transaction-request-dto-rest.ts +1 -1
  237. package/models/link-bank-transactions-response-class.ts +31 -0
  238. package/models/list-bank-accounts-response-class.ts +37 -0
  239. package/models/list-bank-transactions-response-class.ts +6 -6
  240. package/models/list-payment-methods-response-class.ts +37 -0
  241. package/models/list-payment-reminders-response-class.ts +37 -0
  242. package/models/list-payments-response-class.ts +37 -0
  243. package/models/list-refunds-response-class.ts +3 -3
  244. package/models/list-tenant-bank-account-response-class.ts +37 -0
  245. package/models/payment-class-without-expand-properties.ts +114 -0
  246. package/models/payment-class.ts +121 -0
  247. package/models/payment-method-class.ts +84 -0
  248. package/models/payment-reminder-class.ts +108 -0
  249. package/models/primary-bank-account-response-class.ts +60 -0
  250. package/models/refund-class.ts +19 -5
  251. package/models/refund-item-class.ts +120 -0
  252. package/models/sepa-direct-dto.ts +30 -0
  253. package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
  254. package/models/shared-transaction-class.ts +78 -0
  255. package/models/symphony-profile-limited-response-dto.ts +48 -0
  256. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +23 -11
  257. package/models/tenant-bank-account-class.ts +91 -0
  258. package/models/unlink-bank-transaction-request-dto-rest.ts +2 -2
  259. package/models/unlink-bank-transactions-response-class.ts +31 -0
  260. package/models/unlinked-bank-transaction-response-class.ts +114 -0
  261. package/models/update-bank-account-request-dto-rest.ts +36 -0
  262. package/models/update-bank-account-request-dto.ts +42 -0
  263. package/models/update-bank-account-response-class.ts +31 -0
  264. package/models/update-tenant-bank-account-response-class.ts +31 -0
  265. package/models/update-tenant-bank-account-rest-request-dto.ts +1 -1
  266. package/models/validate-pspconfig-request-dto.ts +12 -2
  267. package/package.json +1 -1
  268. package/dist/api/default-api.d.ts +0 -66
  269. package/dist/models/get-request-dto.d.ts +0 -30
  270. package/dist/models/transaction-class.d.ts +0 -54
  271. package/models/get-request-dto.ts +0 -36
  272. 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
@@ -97,8 +97,8 @@ var TenantBankAccountApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * Create a new tenant bank account
101
- * @summary Create the Create Tenant Bank Account
100
+ * This will create a new tenant bank account
101
+ * @summary Create the tenant bank account
102
102
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
103
103
  * @param {string} [authorization] Bearer Token
104
104
  * @param {*} [options] Override http request option.
@@ -147,7 +147,7 @@ var TenantBankAccountApiAxiosParamCreator = function (configuration) {
147
147
  },
148
148
  /**
149
149
  * Deletes a tenant bank account by code
150
- * @summary Deletes a tenant bank account
150
+ * @summary Delete the tenant bank account
151
151
  * @param {string} code Unique identifier for the object.
152
152
  * @param {string} [authorization] Bearer Token
153
153
  * @param {*} [options] Override http request option.
@@ -194,11 +194,11 @@ var TenantBankAccountApiAxiosParamCreator = function (configuration) {
194
194
  });
195
195
  },
196
196
  /**
197
- * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
198
- * @summary Retrieve the Bank Transaction
199
- * @param {string} code Unique identifier for the object.
197
+ * 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.
198
+ * @summary Retrieve the tenant bank account
199
+ * @param {string} code
200
200
  * @param {string} [authorization] Bearer Token
201
- * @param {'bankTransactions'} [expand] Expand the response with additional entities
201
+ * @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>
202
202
  * @param {*} [options] Override http request option.
203
203
  * @throws {RequiredError}
204
204
  */
@@ -246,20 +246,18 @@ var TenantBankAccountApiAxiosParamCreator = function (configuration) {
246
246
  });
247
247
  },
248
248
  /**
249
- * 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.
250
- * @summary List Tenant Bank Accounts
249
+ * 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.
250
+ * @summary List tenant bank accounts
251
251
  * @param {string} [authorization] Bearer Token
252
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
253
- * @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.
254
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
255
- * @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.
256
- * @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.
257
- * @param {string} [expand] Expand the response with additional entities
258
- * @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.
252
+ * @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>
253
+ * @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>
254
+ * @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>
255
+ * @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>
256
+ * @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>
259
257
  * @param {*} [options] Override http request option.
260
258
  * @throws {RequiredError}
261
259
  */
262
- listTenantBankAccounts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
260
+ listTenantBankAccounts: function (authorization, filter, filters, search, order, expand, options) {
263
261
  if (options === void 0) { options = {}; }
264
262
  return __awaiter(_this, void 0, void 0, function () {
265
263
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -282,15 +280,12 @@ var TenantBankAccountApiAxiosParamCreator = function (configuration) {
282
280
  // authentication bearer required
283
281
  // http bearer authentication required
284
282
  _a.sent();
285
- if (pageSize !== undefined) {
286
- localVarQueryParameter['pageSize'] = pageSize;
287
- }
288
- if (pageToken !== undefined) {
289
- localVarQueryParameter['pageToken'] = pageToken;
290
- }
291
283
  if (filter !== undefined) {
292
284
  localVarQueryParameter['filter'] = filter;
293
285
  }
286
+ if (filters !== undefined) {
287
+ localVarQueryParameter['filters'] = filters;
288
+ }
294
289
  if (search !== undefined) {
295
290
  localVarQueryParameter['search'] = search;
296
291
  }
@@ -300,9 +295,6 @@ var TenantBankAccountApiAxiosParamCreator = function (configuration) {
300
295
  if (expand !== undefined) {
301
296
  localVarQueryParameter['expand'] = expand;
302
297
  }
303
- if (filters !== undefined) {
304
- localVarQueryParameter['filters'] = filters;
305
- }
306
298
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
307
299
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
308
300
  }
@@ -319,7 +311,7 @@ var TenantBankAccountApiAxiosParamCreator = function (configuration) {
319
311
  },
320
312
  /**
321
313
  * Update a tenant bank account by code
322
- * @summary Update a tenant bank account
314
+ * @summary Update the tenant bank account
323
315
  * @param {string} code Unique identifier for the object.
324
316
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
325
317
  * @param {string} [authorization] Bearer Token
@@ -381,8 +373,8 @@ var TenantBankAccountApiFp = function (configuration) {
381
373
  var localVarAxiosParamCreator = (0, exports.TenantBankAccountApiAxiosParamCreator)(configuration);
382
374
  return {
383
375
  /**
384
- * Create a new tenant bank account
385
- * @summary Create the Create Tenant Bank Account
376
+ * This will create a new tenant bank account
377
+ * @summary Create the tenant bank account
386
378
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
387
379
  * @param {string} [authorization] Bearer Token
388
380
  * @param {*} [options] Override http request option.
@@ -403,7 +395,7 @@ var TenantBankAccountApiFp = function (configuration) {
403
395
  },
404
396
  /**
405
397
  * Deletes a tenant bank account by code
406
- * @summary Deletes a tenant bank account
398
+ * @summary Delete the tenant bank account
407
399
  * @param {string} code Unique identifier for the object.
408
400
  * @param {string} [authorization] Bearer Token
409
401
  * @param {*} [options] Override http request option.
@@ -423,11 +415,11 @@ var TenantBankAccountApiFp = function (configuration) {
423
415
  });
424
416
  },
425
417
  /**
426
- * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
427
- * @summary Retrieve the Bank Transaction
428
- * @param {string} code Unique identifier for the object.
418
+ * 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.
419
+ * @summary Retrieve the tenant bank account
420
+ * @param {string} code
429
421
  * @param {string} [authorization] Bearer Token
430
- * @param {'bankTransactions'} [expand] Expand the response with additional entities
422
+ * @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>
431
423
  * @param {*} [options] Override http request option.
432
424
  * @throws {RequiredError}
433
425
  */
@@ -445,25 +437,23 @@ var TenantBankAccountApiFp = function (configuration) {
445
437
  });
446
438
  },
447
439
  /**
448
- * 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.
449
- * @summary List Tenant Bank Accounts
440
+ * 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.
441
+ * @summary List tenant bank accounts
450
442
  * @param {string} [authorization] Bearer Token
451
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
452
- * @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.
453
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
454
- * @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.
455
- * @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.
456
- * @param {string} [expand] Expand the response with additional entities
457
- * @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.
443
+ * @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>
444
+ * @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>
445
+ * @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>
446
+ * @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>
447
+ * @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>
458
448
  * @param {*} [options] Override http request option.
459
449
  * @throws {RequiredError}
460
450
  */
461
- listTenantBankAccounts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
451
+ listTenantBankAccounts: function (authorization, filter, filters, search, order, expand, options) {
462
452
  return __awaiter(this, void 0, void 0, function () {
463
453
  var localVarAxiosArgs;
464
454
  return __generator(this, function (_a) {
465
455
  switch (_a.label) {
466
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTenantBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
456
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTenantBankAccounts(authorization, filter, filters, search, order, expand, options)];
467
457
  case 1:
468
458
  localVarAxiosArgs = _a.sent();
469
459
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -473,7 +463,7 @@ var TenantBankAccountApiFp = function (configuration) {
473
463
  },
474
464
  /**
475
465
  * Update a tenant bank account by code
476
- * @summary Update a tenant bank account
466
+ * @summary Update the tenant bank account
477
467
  * @param {string} code Unique identifier for the object.
478
468
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
479
469
  * @param {string} [authorization] Bearer Token
@@ -504,8 +494,8 @@ var TenantBankAccountApiFactory = function (configuration, basePath, axios) {
504
494
  var localVarFp = (0, exports.TenantBankAccountApiFp)(configuration);
505
495
  return {
506
496
  /**
507
- * Create a new tenant bank account
508
- * @summary Create the Create Tenant Bank Account
497
+ * This will create a new tenant bank account
498
+ * @summary Create the tenant bank account
509
499
  * @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
510
500
  * @param {string} [authorization] Bearer Token
511
501
  * @param {*} [options] Override http request option.
@@ -516,7 +506,7 @@ var TenantBankAccountApiFactory = function (configuration, basePath, axios) {
516
506
  },
517
507
  /**
518
508
  * Deletes a tenant bank account by code
519
- * @summary Deletes a tenant bank account
509
+ * @summary Delete the tenant bank account
520
510
  * @param {string} code Unique identifier for the object.
521
511
  * @param {string} [authorization] Bearer Token
522
512
  * @param {*} [options] Override http request option.
@@ -526,11 +516,11 @@ var TenantBankAccountApiFactory = function (configuration, basePath, axios) {
526
516
  return localVarFp.deleteTenantBankAccount(code, authorization, options).then(function (request) { return request(axios, basePath); });
527
517
  },
528
518
  /**
529
- * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
530
- * @summary Retrieve the Bank Transaction
531
- * @param {string} code Unique identifier for the object.
519
+ * 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.
520
+ * @summary Retrieve the tenant bank account
521
+ * @param {string} code
532
522
  * @param {string} [authorization] Bearer Token
533
- * @param {'bankTransactions'} [expand] Expand the response with additional entities
523
+ * @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>
534
524
  * @param {*} [options] Override http request option.
535
525
  * @throws {RequiredError}
536
526
  */
@@ -538,25 +528,23 @@ var TenantBankAccountApiFactory = function (configuration, basePath, axios) {
538
528
  return localVarFp.getTenantBankAccount(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
539
529
  },
540
530
  /**
541
- * 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.
542
- * @summary List Tenant Bank Accounts
531
+ * 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.
532
+ * @summary List tenant bank accounts
543
533
  * @param {string} [authorization] Bearer Token
544
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
545
- * @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.
546
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
547
- * @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.
548
- * @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.
549
- * @param {string} [expand] Expand the response with additional entities
550
- * @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.
534
+ * @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>
535
+ * @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>
536
+ * @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>
537
+ * @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>
538
+ * @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>
551
539
  * @param {*} [options] Override http request option.
552
540
  * @throws {RequiredError}
553
541
  */
554
- listTenantBankAccounts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
555
- return localVarFp.listTenantBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
542
+ listTenantBankAccounts: function (authorization, filter, filters, search, order, expand, options) {
543
+ return localVarFp.listTenantBankAccounts(authorization, filter, filters, search, order, expand, options).then(function (request) { return request(axios, basePath); });
556
544
  },
557
545
  /**
558
546
  * Update a tenant bank account by code
559
- * @summary Update a tenant bank account
547
+ * @summary Update the tenant bank account
560
548
  * @param {string} code Unique identifier for the object.
561
549
  * @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
562
550
  * @param {string} [authorization] Bearer Token
@@ -581,8 +569,8 @@ var TenantBankAccountApi = /** @class */ (function (_super) {
581
569
  return _super !== null && _super.apply(this, arguments) || this;
582
570
  }
583
571
  /**
584
- * Create a new tenant bank account
585
- * @summary Create the Create Tenant Bank Account
572
+ * This will create a new tenant bank account
573
+ * @summary Create the tenant bank account
586
574
  * @param {TenantBankAccountApiCreateTenantBankAccountRequest} requestParameters Request parameters.
587
575
  * @param {*} [options] Override http request option.
588
576
  * @throws {RequiredError}
@@ -594,7 +582,7 @@ var TenantBankAccountApi = /** @class */ (function (_super) {
594
582
  };
595
583
  /**
596
584
  * Deletes a tenant bank account by code
597
- * @summary Deletes a tenant bank account
585
+ * @summary Delete the tenant bank account
598
586
  * @param {TenantBankAccountApiDeleteTenantBankAccountRequest} requestParameters Request parameters.
599
587
  * @param {*} [options] Override http request option.
600
588
  * @throws {RequiredError}
@@ -605,8 +593,8 @@ var TenantBankAccountApi = /** @class */ (function (_super) {
605
593
  return (0, exports.TenantBankAccountApiFp)(this.configuration).deleteTenantBankAccount(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
606
594
  };
607
595
  /**
608
- * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
609
- * @summary Retrieve the Bank Transaction
596
+ * 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.
597
+ * @summary Retrieve the tenant bank account
610
598
  * @param {TenantBankAccountApiGetTenantBankAccountRequest} requestParameters Request parameters.
611
599
  * @param {*} [options] Override http request option.
612
600
  * @throws {RequiredError}
@@ -617,8 +605,8 @@ var TenantBankAccountApi = /** @class */ (function (_super) {
617
605
  return (0, exports.TenantBankAccountApiFp)(this.configuration).getTenantBankAccount(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
618
606
  };
619
607
  /**
620
- * 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.
621
- * @summary List Tenant Bank Accounts
608
+ * 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.
609
+ * @summary List tenant bank accounts
622
610
  * @param {TenantBankAccountApiListTenantBankAccountsRequest} requestParameters Request parameters.
623
611
  * @param {*} [options] Override http request option.
624
612
  * @throws {RequiredError}
@@ -627,11 +615,11 @@ var TenantBankAccountApi = /** @class */ (function (_super) {
627
615
  TenantBankAccountApi.prototype.listTenantBankAccounts = function (requestParameters, options) {
628
616
  var _this = this;
629
617
  if (requestParameters === void 0) { requestParameters = {}; }
630
- return (0, exports.TenantBankAccountApiFp)(this.configuration).listTenantBankAccounts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
618
+ return (0, exports.TenantBankAccountApiFp)(this.configuration).listTenantBankAccounts(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
631
619
  };
632
620
  /**
633
621
  * Update a tenant bank account by code
634
- * @summary Update a tenant bank account
622
+ * @summary Update the tenant bank account
635
623
  * @param {TenantBankAccountApiUpdateTenantBankAccountRequest} requestParameters Request parameters.
636
624
  * @param {*} [options] Override http request option.
637
625
  * @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
@@ -18,9 +18,10 @@ import { RequestArgs, BaseAPI } from '../base';
18
18
  */
19
19
  export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
20
20
  /**
21
- *
22
- * @param {string} pspType
23
- * @param {string} tenantSlug
21
+ * This will processes the webhook from external payment service provider.
22
+ * @summary Handle the webhook from PSP
23
+ * @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis</i>
24
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
24
25
  * @param {*} [options] Override http request option.
25
26
  * @throws {RequiredError}
26
27
  */
@@ -32,9 +33,10 @@ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuratio
32
33
  */
33
34
  export declare const WebhooksApiFp: (configuration?: Configuration) => {
34
35
  /**
35
- *
36
- * @param {string} pspType
37
- * @param {string} tenantSlug
36
+ * This will processes the webhook from external payment service provider.
37
+ * @summary Handle the webhook from PSP
38
+ * @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis</i>
39
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
38
40
  * @param {*} [options] Override http request option.
39
41
  * @throws {RequiredError}
40
42
  */
@@ -46,9 +48,10 @@ export declare const WebhooksApiFp: (configuration?: Configuration) => {
46
48
  */
47
49
  export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
48
50
  /**
49
- *
50
- * @param {string} pspType
51
- * @param {string} tenantSlug
51
+ * This will processes the webhook from external payment service provider.
52
+ * @summary Handle the webhook from PSP
53
+ * @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis</i>
54
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
52
55
  * @param {*} [options] Override http request option.
53
56
  * @throws {RequiredError}
54
57
  */
@@ -61,13 +64,13 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
61
64
  */
62
65
  export interface WebhooksApiPostWebhookRequest {
63
66
  /**
64
- *
67
+ * The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis</i>
65
68
  * @type {string}
66
69
  * @memberof WebhooksApiPostWebhook
67
70
  */
68
71
  readonly pspType: string;
69
72
  /**
70
- *
73
+ * Unique slug identifier representing a tenant.
71
74
  * @type {string}
72
75
  * @memberof WebhooksApiPostWebhook
73
76
  */
@@ -81,7 +84,8 @@ export interface WebhooksApiPostWebhookRequest {
81
84
  */
82
85
  export declare class WebhooksApi extends BaseAPI {
83
86
  /**
84
- *
87
+ * This will processes the webhook from external payment service provider.
88
+ * @summary Handle the webhook from PSP
85
89
  * @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
86
90
  * @param {*} [options] Override http request option.
87
91
  * @throws {RequiredError}
@@ -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
@@ -97,9 +97,10 @@ var WebhooksApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
101
- * @param {string} pspType
102
- * @param {string} tenantSlug
100
+ * This will processes the webhook from external payment service provider.
101
+ * @summary Handle the webhook from PSP
102
+ * @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis</i>
103
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
103
104
  * @param {*} [options] Override http request option.
104
105
  * @throws {RequiredError}
105
106
  */
@@ -144,9 +145,10 @@ var WebhooksApiFp = function (configuration) {
144
145
  var localVarAxiosParamCreator = (0, exports.WebhooksApiAxiosParamCreator)(configuration);
145
146
  return {
146
147
  /**
147
- *
148
- * @param {string} pspType
149
- * @param {string} tenantSlug
148
+ * This will processes the webhook from external payment service provider.
149
+ * @summary Handle the webhook from PSP
150
+ * @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis</i>
151
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
150
152
  * @param {*} [options] Override http request option.
151
153
  * @throws {RequiredError}
152
154
  */
@@ -174,9 +176,10 @@ var WebhooksApiFactory = function (configuration, basePath, axios) {
174
176
  var localVarFp = (0, exports.WebhooksApiFp)(configuration);
175
177
  return {
176
178
  /**
177
- *
178
- * @param {string} pspType
179
- * @param {string} tenantSlug
179
+ * This will processes the webhook from external payment service provider.
180
+ * @summary Handle the webhook from PSP
181
+ * @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis</i>
182
+ * @param {string} tenantSlug Unique slug identifier representing a tenant.
180
183
  * @param {*} [options] Override http request option.
181
184
  * @throws {RequiredError}
182
185
  */
@@ -198,7 +201,8 @@ var WebhooksApi = /** @class */ (function (_super) {
198
201
  return _super !== null && _super.apply(this, arguments) || this;
199
202
  }
200
203
  /**
201
- *
204
+ * This will processes the webhook from external payment service provider.
205
+ * @summary Handle the webhook from PSP
202
206
  * @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
203
207
  * @param {*} [options] Override http request option.
204
208
  * @throws {RequiredError}
package/dist/api.d.ts CHANGED
@@ -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
@@ -11,7 +11,7 @@
11
11
  */
12
12
  export * from './api/bank-accounts-api';
13
13
  export * from './api/bank-transaction-api';
14
- export * from './api/default-api';
14
+ export * from './api/health-check-api';
15
15
  export * from './api/payment-methods-api';
16
16
  export * from './api/payment-reminders-api';
17
17
  export * from './api/payment-setup-api';
package/dist/api.js CHANGED
@@ -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
@@ -29,7 +29,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
29
29
  Object.defineProperty(exports, "__esModule", { value: true });
30
30
  __exportStar(require("./api/bank-accounts-api"), exports);
31
31
  __exportStar(require("./api/bank-transaction-api"), exports);
32
- __exportStar(require("./api/default-api"), exports);
32
+ __exportStar(require("./api/health-check-api"), exports);
33
33
  __exportStar(require("./api/payment-methods-api"), exports);
34
34
  __exportStar(require("./api/payment-reminders-api"), exports);
35
35
  __exportStar(require("./api/payment-setup-api"), exports);
package/dist/base.d.ts CHANGED
@@ -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
@@ -24,7 +24,7 @@ export declare const COLLECTION_FORMATS: {
24
24
  };
25
25
  export interface LoginClass {
26
26
  accessToken: string;
27
- permissions: Array<string>;
27
+ permissions: string;
28
28
  }
29
29
  export declare enum Environment {
30
30
  Production = "https://apiv2.emil.de",
@@ -53,14 +53,16 @@ export declare class BaseAPI {
53
53
  protected configuration: Configuration;
54
54
  private username?;
55
55
  private password?;
56
+ private permissions?;
56
57
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
57
58
  initialize(env?: Environment): Promise<void>;
58
59
  private loadCredentials;
59
60
  private readConfigFile;
60
61
  private readEnvVariables;
61
62
  selectEnvironment(env: Environment): void;
63
+ getPermissions(): Array<string>;
62
64
  authorize(username: string, password: string): Promise<void>;
63
- refreshTokenInternal(): Promise<string>;
65
+ refreshTokenInternal(): Promise<LoginClass>;
64
66
  private extractRefreshToken;
65
67
  getConfiguration(): Configuration;
66
68
  private attachInterceptor;