@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,8 +93,8 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * Creates a payment for a specified account. This function is idempotent.
97
- * @summary Create a payment
96
+ * This will create a payment for a specified account. This function is idempotent.
97
+ * @summary Create the payment
98
98
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
99
99
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
100
100
  * @param {string} [authorization] Bearer Token
@@ -148,16 +148,15 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
148
148
  });
149
149
  },
150
150
  /**
151
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
152
- * @summary Retrieve a payment
151
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
152
+ * @summary Retrieve the payment
153
153
  * @param {string} code Unique identifier for the object.
154
154
  * @param {string} [authorization] Bearer Token
155
- * @param {string} [expand] Fields to expand response by
156
- * @param {string} [expand2] Fields to expand response by
155
+ * @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: transactions.<i>
157
156
  * @param {*} [options] Override http request option.
158
157
  * @throws {RequiredError}
159
158
  */
160
- getPayment: function (code, authorization, expand, expand2, options) {
159
+ getPayment: function (code, authorization, expand, options) {
161
160
  if (options === void 0) { options = {}; }
162
161
  return __awaiter(_this, void 0, void 0, function () {
163
162
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -166,7 +165,8 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
166
165
  case 0:
167
166
  // verify required parameter 'code' is not null or undefined
168
167
  (0, common_1.assertParamExists)('getPayment', 'code', code);
169
- localVarPath = "/paymentservice/v1/payments/{code}";
168
+ localVarPath = "/paymentservice/v1/payments/{code}"
169
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
170
170
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
171
171
  if (configuration) {
172
172
  baseOptions = configuration.baseOptions;
@@ -182,15 +182,9 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
182
182
  // authentication bearer required
183
183
  // http bearer authentication required
184
184
  _a.sent();
185
- if (code !== undefined) {
186
- localVarQueryParameter['code'] = code;
187
- }
188
185
  if (expand !== undefined) {
189
186
  localVarQueryParameter['expand'] = expand;
190
187
  }
191
- if (expand2 !== undefined) {
192
- localVarQueryParameter['expand'] = expand2;
193
- }
194
188
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
195
189
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
196
190
  }
@@ -206,16 +200,16 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
206
200
  });
207
201
  },
208
202
  /**
209
- * Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
203
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
210
204
  * @summary List payments
211
205
  * @param {string} [authorization] Bearer Token
212
206
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
213
207
  * @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.
214
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
215
- * @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.
216
- * @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.
217
- * @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.
218
- * @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.
208
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
209
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
210
+ * @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, code, amount</i>
211
+ * @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: transactions.<i>
212
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
219
213
  * @param {*} [options] Override http request option.
220
214
  * @throws {RequiredError}
221
215
  */
@@ -288,8 +282,8 @@ var PaymentsApiFp = function (configuration) {
288
282
  var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
289
283
  return {
290
284
  /**
291
- * Creates a payment for a specified account. This function is idempotent.
292
- * @summary Create a payment
285
+ * This will create a payment for a specified account. This function is idempotent.
286
+ * @summary Create the payment
293
287
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
294
288
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
295
289
  * @param {string} [authorization] Bearer Token
@@ -310,21 +304,20 @@ var PaymentsApiFp = function (configuration) {
310
304
  });
311
305
  },
312
306
  /**
313
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
314
- * @summary Retrieve a payment
307
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
308
+ * @summary Retrieve the payment
315
309
  * @param {string} code Unique identifier for the object.
316
310
  * @param {string} [authorization] Bearer Token
317
- * @param {string} [expand] Fields to expand response by
318
- * @param {string} [expand2] Fields to expand response by
311
+ * @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: transactions.<i>
319
312
  * @param {*} [options] Override http request option.
320
313
  * @throws {RequiredError}
321
314
  */
322
- getPayment: function (code, authorization, expand, expand2, options) {
315
+ getPayment: function (code, authorization, expand, options) {
323
316
  return __awaiter(this, void 0, void 0, function () {
324
317
  var localVarAxiosArgs;
325
318
  return __generator(this, function (_a) {
326
319
  switch (_a.label) {
327
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPayment(code, authorization, expand, expand2, options)];
320
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPayment(code, authorization, expand, options)];
328
321
  case 1:
329
322
  localVarAxiosArgs = _a.sent();
330
323
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -333,16 +326,16 @@ var PaymentsApiFp = function (configuration) {
333
326
  });
334
327
  },
335
328
  /**
336
- * Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
329
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
337
330
  * @summary List payments
338
331
  * @param {string} [authorization] Bearer Token
339
332
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
340
333
  * @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.
341
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
342
- * @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.
343
- * @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.
344
- * @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.
345
- * @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.
334
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
335
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
336
+ * @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, code, amount</i>
337
+ * @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: transactions.<i>
338
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
346
339
  * @param {*} [options] Override http request option.
347
340
  * @throws {RequiredError}
348
341
  */
@@ -370,8 +363,8 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
370
363
  var localVarFp = (0, exports.PaymentsApiFp)(configuration);
371
364
  return {
372
365
  /**
373
- * Creates a payment for a specified account. This function is idempotent.
374
- * @summary Create a payment
366
+ * This will create a payment for a specified account. This function is idempotent.
367
+ * @summary Create the payment
375
368
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
376
369
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
377
370
  * @param {string} [authorization] Bearer Token
@@ -382,29 +375,28 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
382
375
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
383
376
  },
384
377
  /**
385
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
386
- * @summary Retrieve a payment
378
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
379
+ * @summary Retrieve the payment
387
380
  * @param {string} code Unique identifier for the object.
388
381
  * @param {string} [authorization] Bearer Token
389
- * @param {string} [expand] Fields to expand response by
390
- * @param {string} [expand2] Fields to expand response by
382
+ * @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: transactions.<i>
391
383
  * @param {*} [options] Override http request option.
392
384
  * @throws {RequiredError}
393
385
  */
394
- getPayment: function (code, authorization, expand, expand2, options) {
395
- return localVarFp.getPayment(code, authorization, expand, expand2, options).then(function (request) { return request(axios, basePath); });
386
+ getPayment: function (code, authorization, expand, options) {
387
+ return localVarFp.getPayment(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
396
388
  },
397
389
  /**
398
- * Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
390
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
399
391
  * @summary List payments
400
392
  * @param {string} [authorization] Bearer Token
401
393
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
402
394
  * @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.
403
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
404
- * @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.
405
- * @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.
406
- * @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.
407
- * @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.
395
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
396
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
397
+ * @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, code, amount</i>
398
+ * @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: transactions.<i>
399
+ * @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
408
400
  * @param {*} [options] Override http request option.
409
401
  * @throws {RequiredError}
410
402
  */
@@ -426,8 +418,8 @@ var PaymentsApi = /** @class */ (function (_super) {
426
418
  return _super !== null && _super.apply(this, arguments) || this;
427
419
  }
428
420
  /**
429
- * Creates a payment for a specified account. This function is idempotent.
430
- * @summary Create a payment
421
+ * This will create a payment for a specified account. This function is idempotent.
422
+ * @summary Create the payment
431
423
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
432
424
  * @param {*} [options] Override http request option.
433
425
  * @throws {RequiredError}
@@ -438,8 +430,8 @@ var PaymentsApi = /** @class */ (function (_super) {
438
430
  return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
439
431
  };
440
432
  /**
441
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
442
- * @summary Retrieve a payment
433
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
434
+ * @summary Retrieve the payment
443
435
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
444
436
  * @param {*} [options] Override http request option.
445
437
  * @throws {RequiredError}
@@ -447,10 +439,10 @@ var PaymentsApi = /** @class */ (function (_super) {
447
439
  */
448
440
  PaymentsApi.prototype.getPayment = function (requestParameters, options) {
449
441
  var _this = this;
450
- return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, requestParameters.expand2, options).then(function (request) { return request(_this.axios, _this.basePath); });
442
+ return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
451
443
  };
452
444
  /**
453
- * Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
445
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
454
446
  * @summary List payments
455
447
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
456
448
  * @param {*} [options] Override http request option.
@@ -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,16 +13,14 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateRefundRequestDto } from '../models';
16
- import { CreateRefundResponseClass } from '../models';
17
- import { GetRefundResponseClass } from '../models';
18
- import { ListRefundsResponseClass } from '../models';
19
16
  /**
20
17
  * RefundsApi - axios parameter creator
21
18
  * @export
22
19
  */
23
20
  export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration) => {
24
21
  /**
25
- *
22
+ * This will create a refund in the database.
23
+ * @summary Create the refund
26
24
  * @param {CreateRefundRequestDto} createRefundRequestDto
27
25
  * @param {string} [authorization] Bearer Token
28
26
  * @param {*} [options] Override http request option.
@@ -30,29 +28,30 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
30
28
  */
31
29
  createRefund: (createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
30
  /**
33
- *
34
- * @param {string} code
35
- * @param {string} code2 Unique identifier for the object.
31
+ * 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.
32
+ * @summary Retrieve the refund
33
+ * @param {string} code Unique identifier for the object.
36
34
  * @param {string} [authorization] Bearer Token
37
- * @param {string} [expand] Fields to expand response by
35
+ * @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: .&lt;i&gt;
38
36
  * @param {*} [options] Override http request option.
39
37
  * @throws {RequiredError}
40
38
  */
41
- getRefund: (code: string, code2: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
+ getRefund: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
40
  /**
43
- *
41
+ * 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.
42
+ * @summary List refunds
44
43
  * @param {string} [authorization] Bearer Token
45
44
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
46
45
  * @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.
47
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
48
- * @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.
49
- * @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.
50
- * @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.
51
- * @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.
46
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
47
+ * @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, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status&lt;/i&gt;
48
+ * @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, updatedAt, amount&lt;/i&gt;
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: .&lt;i&gt;
50
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
52
51
  * @param {*} [options] Override http request option.
53
52
  * @throws {RequiredError}
54
53
  */
55
- listRefunds: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
+ listRefunds: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
55
  };
57
56
  /**
58
57
  * RefundsApi - functional programming interface
@@ -60,37 +59,39 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
60
59
  */
61
60
  export declare const RefundsApiFp: (configuration?: Configuration) => {
62
61
  /**
63
- *
62
+ * This will create a refund in the database.
63
+ * @summary Create the refund
64
64
  * @param {CreateRefundRequestDto} createRefundRequestDto
65
65
  * @param {string} [authorization] Bearer Token
66
66
  * @param {*} [options] Override http request option.
67
67
  * @throws {RequiredError}
68
68
  */
69
- createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRefundResponseClass>>;
69
+ createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
70
70
  /**
71
- *
72
- * @param {string} code
73
- * @param {string} code2 Unique identifier for the object.
71
+ * 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.
72
+ * @summary Retrieve the refund
73
+ * @param {string} code Unique identifier for the object.
74
74
  * @param {string} [authorization] Bearer Token
75
- * @param {string} [expand] Fields to expand response by
75
+ * @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: .&lt;i&gt;
76
76
  * @param {*} [options] Override http request option.
77
77
  * @throws {RequiredError}
78
78
  */
79
- getRefund(code: string, code2: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>>;
79
+ getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
80
80
  /**
81
- *
81
+ * 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.
82
+ * @summary List refunds
82
83
  * @param {string} [authorization] Bearer Token
83
84
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
84
85
  * @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.
85
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
86
- * @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.
87
- * @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.
88
- * @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.
89
- * @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.
86
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
87
+ * @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, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status&lt;/i&gt;
88
+ * @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, updatedAt, amount&lt;/i&gt;
89
+ * @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: .&lt;i&gt;
90
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
90
91
  * @param {*} [options] Override http request option.
91
92
  * @throws {RequiredError}
92
93
  */
93
- listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRefundsResponseClass>>;
94
+ listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
94
95
  };
95
96
  /**
96
97
  * RefundsApi - factory interface
@@ -98,37 +99,39 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
98
99
  */
99
100
  export declare const RefundsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
100
101
  /**
101
- *
102
+ * This will create a refund in the database.
103
+ * @summary Create the refund
102
104
  * @param {CreateRefundRequestDto} createRefundRequestDto
103
105
  * @param {string} [authorization] Bearer Token
104
106
  * @param {*} [options] Override http request option.
105
107
  * @throws {RequiredError}
106
108
  */
107
- createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<CreateRefundResponseClass>;
109
+ createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
108
110
  /**
109
- *
110
- * @param {string} code
111
- * @param {string} code2 Unique identifier for the object.
111
+ * 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.
112
+ * @summary Retrieve the refund
113
+ * @param {string} code Unique identifier for the object.
112
114
  * @param {string} [authorization] Bearer Token
113
- * @param {string} [expand] Fields to expand response by
115
+ * @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: .&lt;i&gt;
114
116
  * @param {*} [options] Override http request option.
115
117
  * @throws {RequiredError}
116
118
  */
117
- getRefund(code: string, code2: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetRefundResponseClass>;
119
+ getRefund(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
118
120
  /**
119
- *
121
+ * 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.
122
+ * @summary List refunds
120
123
  * @param {string} [authorization] Bearer Token
121
124
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
122
125
  * @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.
123
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
124
- * @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.
125
- * @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.
126
- * @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.
127
- * @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.
126
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
127
+ * @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, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status&lt;/i&gt;
128
+ * @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, updatedAt, amount&lt;/i&gt;
129
+ * @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: .&lt;i&gt;
130
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
128
131
  * @param {*} [options] Override http request option.
129
132
  * @throws {RequiredError}
130
133
  */
131
- listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListRefundsResponseClass>;
134
+ listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
132
135
  };
133
136
  /**
134
137
  * Request parameters for createRefund operation in RefundsApi.
@@ -155,18 +158,12 @@ export interface RefundsApiCreateRefundRequest {
155
158
  * @interface RefundsApiGetRefundRequest
156
159
  */
157
160
  export interface RefundsApiGetRefundRequest {
158
- /**
159
- *
160
- * @type {string}
161
- * @memberof RefundsApiGetRefund
162
- */
163
- readonly code: string;
164
161
  /**
165
162
  * Unique identifier for the object.
166
163
  * @type {string}
167
164
  * @memberof RefundsApiGetRefund
168
165
  */
169
- readonly code2: string;
166
+ readonly code: string;
170
167
  /**
171
168
  * Bearer Token
172
169
  * @type {string}
@@ -174,7 +171,7 @@ export interface RefundsApiGetRefundRequest {
174
171
  */
175
172
  readonly authorization?: string;
176
173
  /**
177
- * Fields to expand response by
174
+ * 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: .&lt;i&gt;
178
175
  * @type {string}
179
176
  * @memberof RefundsApiGetRefund
180
177
  */
@@ -205,35 +202,35 @@ export interface RefundsApiListRefundsRequest {
205
202
  */
206
203
  readonly pageToken?: any;
207
204
  /**
208
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
209
- * @type {any}
205
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
206
+ * @type {string}
210
207
  * @memberof RefundsApiListRefunds
211
208
  */
212
- readonly filter?: any;
209
+ readonly filter?: string;
213
210
  /**
214
- * 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.
215
- * @type {any}
211
+ * 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, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status&lt;/i&gt;
212
+ * @type {string}
216
213
  * @memberof RefundsApiListRefunds
217
214
  */
218
- readonly search?: any;
215
+ readonly search?: string;
219
216
  /**
220
- * 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.
221
- * @type {any}
217
+ * 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, updatedAt, amount&lt;/i&gt;
218
+ * @type {string}
222
219
  * @memberof RefundsApiListRefunds
223
220
  */
224
- readonly order?: any;
221
+ readonly order?: string;
225
222
  /**
226
- * 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.
227
- * @type {any}
223
+ * 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: .&lt;i&gt;
224
+ * @type {string}
228
225
  * @memberof RefundsApiListRefunds
229
226
  */
230
- readonly expand?: any;
227
+ readonly expand?: string;
231
228
  /**
232
- * 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.
233
- * @type {any}
229
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
230
+ * @type {string}
234
231
  * @memberof RefundsApiListRefunds
235
232
  */
236
- readonly filters?: any;
233
+ readonly filters?: string;
237
234
  }
238
235
  /**
239
236
  * RefundsApi - object-oriented interface
@@ -243,27 +240,30 @@ export interface RefundsApiListRefundsRequest {
243
240
  */
244
241
  export declare class RefundsApi extends BaseAPI {
245
242
  /**
246
- *
243
+ * This will create a refund in the database.
244
+ * @summary Create the refund
247
245
  * @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
248
246
  * @param {*} [options] Override http request option.
249
247
  * @throws {RequiredError}
250
248
  * @memberof RefundsApi
251
249
  */
252
- createRefund(requestParameters: RefundsApiCreateRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRefundResponseClass, any>>;
250
+ createRefund(requestParameters: RefundsApiCreateRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
253
251
  /**
254
- *
252
+ * 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.
253
+ * @summary Retrieve the refund
255
254
  * @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
256
255
  * @param {*} [options] Override http request option.
257
256
  * @throws {RequiredError}
258
257
  * @memberof RefundsApi
259
258
  */
260
- getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRefundResponseClass, any>>;
259
+ getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
261
260
  /**
262
- *
261
+ * 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.
262
+ * @summary List refunds
263
263
  * @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
264
264
  * @param {*} [options] Override http request option.
265
265
  * @throws {RequiredError}
266
266
  * @memberof RefundsApi
267
267
  */
268
- listRefunds(requestParameters?: RefundsApiListRefundsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRefundsResponseClass, any>>;
268
+ listRefunds(requestParameters?: RefundsApiListRefundsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
269
269
  }