@emilgroup/payment-sdk 1.4.1-beta.9 → 1.5.1-beta.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 (140) hide show
  1. package/.openapi-generator/FILES +11 -11
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +500 -88
  4. package/api/bank-transaction-api.ts +93 -123
  5. package/api/{default-api.ts → health-check-api.ts} +22 -18
  6. package/api/payment-methods-api.ts +61 -242
  7. package/api/payment-reminders-api.ts +57 -99
  8. package/api/payment-setup-api.ts +17 -9
  9. package/api/payments-api.ts +72 -135
  10. package/api/refunds-api.ts +80 -120
  11. package/api/tenant-bank-account-api.ts +96 -118
  12. package/api/webhooks-api.ts +38 -21
  13. package/api.ts +3 -3
  14. package/base.ts +22 -10
  15. package/common.ts +2 -2
  16. package/configuration.ts +1 -1
  17. package/dist/api/bank-accounts-api.d.ts +292 -69
  18. package/dist/api/bank-accounts-api.js +432 -62
  19. package/dist/api/bank-transaction-api.d.ts +84 -104
  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 +51 -151
  24. package/dist/api/payment-methods-api.js +48 -178
  25. package/dist/api/payment-reminders-api.d.ts +52 -79
  26. package/dist/api/payment-reminders-api.js +44 -62
  27. package/dist/api/payment-setup-api.d.ts +17 -9
  28. package/dist/api/payment-setup-api.js +17 -9
  29. package/dist/api/payments-api.d.ts +62 -98
  30. package/dist/api/payments-api.js +55 -85
  31. package/dist/api/refunds-api.d.ts +73 -91
  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 +29 -16
  36. package/dist/api/webhooks-api.js +29 -19
  37. package/dist/api.d.ts +2 -2
  38. package/dist/api.js +2 -2
  39. package/dist/base.d.ts +6 -3
  40. package/dist/base.js +31 -22
  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} +31 -33
  48. package/dist/models/{bank-transaction-response-class.js → bank-transaction-class-without-expand-properties.js} +1 -1
  49. package/dist/models/create-bank-account-request-dto.d.ts +42 -0
  50. package/dist/models/{get-refund-response-class.js → 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 +3 -3
  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/{create-refund-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 +10 -10
  66. package/dist/models/index.js +10 -10
  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 +1 -1
  72. package/dist/models/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/{get-bank-transactions-response-class.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} +23 -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 +85 -0
  80. package/dist/models/tenant-bank-account-class.js +15 -0
  81. package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +2 -2
  82. package/dist/models/unlink-bank-transaction-request-dto-rest.js +1 -1
  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 +1 -1
  92. package/dist/models/validate-pspconfig-request-dto.js +1 -1
  93. package/index.ts +1 -1
  94. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +31 -33
  95. package/models/create-bank-account-request-dto.ts +48 -0
  96. package/models/create-payment-reminder-request-dto.ts +1 -1
  97. package/models/create-payment-request-dto.ts +3 -3
  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 +10 -10
  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 +1 -1
  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} +23 -11
  110. package/models/tenant-bank-account-class.ts +91 -0
  111. package/models/unlink-bank-transaction-request-dto-rest.ts +2 -2
  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 +1 -1
  117. package/package.json +1 -1
  118. package/dist/api/default-api.d.ts +0 -66
  119. package/dist/models/create-refund-response-class.d.ts +0 -25
  120. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  121. package/dist/models/get-refund-response-class.d.ts +0 -25
  122. package/dist/models/get-request-dto.d.ts +0 -30
  123. package/dist/models/get-request-dto.js +0 -15
  124. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  125. package/dist/models/list-bank-transactions-response-class.js +0 -15
  126. package/dist/models/list-refunds-response-class.d.ts +0 -31
  127. package/dist/models/list-refunds-response-class.js +0 -15
  128. package/dist/models/refund-class.d.ts +0 -104
  129. package/dist/models/refund-class.js +0 -28
  130. package/dist/models/tenant-bank-account-response-class.js +0 -15
  131. package/dist/models/transaction-class.d.ts +0 -54
  132. package/dist/models/transaction-class.js +0 -15
  133. package/models/create-refund-response-class.ts +0 -31
  134. package/models/get-bank-transactions-response-class.ts +0 -31
  135. package/models/get-refund-response-class.ts +0 -31
  136. package/models/get-request-dto.ts +0 -36
  137. package/models/list-bank-transactions-response-class.ts +0 -37
  138. package/models/list-refunds-response-class.ts +0 -37
  139. package/models/refund-class.ts +0 -114
  140. package/models/transaction-class.ts +0 -60
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Emil Payment Service
5
- * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
8
  * Contact: kontakt@emil.de
@@ -22,12 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
24
  import { CreateRefundRequestDto } from '../models';
25
- // @ts-ignore
26
- import { CreateRefundResponseClass } from '../models';
27
- // @ts-ignore
28
- import { GetRefundResponseClass } from '../models';
29
- // @ts-ignore
30
- import { ListRefundsResponseClass } from '../models';
31
25
  /**
32
26
  * RefundsApi - axios parameter creator
33
27
  * @export
@@ -35,7 +29,8 @@ import { ListRefundsResponseClass } from '../models';
35
29
  export const RefundsApiAxiosParamCreator = function (configuration?: Configuration) {
36
30
  return {
37
31
  /**
38
- *
32
+ * This will create a refund in the database.
33
+ * @summary Create the refund
39
34
  * @param {CreateRefundRequestDto} createRefundRequestDto
40
35
  * @param {string} [authorization] Bearer Token
41
36
  * @param {*} [options] Override http request option.
@@ -81,21 +76,17 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
81
76
  };
82
77
  },
83
78
  /**
84
- *
79
+ * 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.
80
+ * @summary Retrieve the refund
85
81
  * @param {string} code
86
- * @param {string} code2 Unique identifier for the object.
87
- * @param {string} expand Fields to expand response by
88
82
  * @param {string} [authorization] Bearer Token
83
+ * @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: refundItems<i>
89
84
  * @param {*} [options] Override http request option.
90
85
  * @throws {RequiredError}
91
86
  */
92
- getRefund: async (code: string, code2: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
87
+ getRefund: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
93
88
  // verify required parameter 'code' is not null or undefined
94
89
  assertParamExists('getRefund', 'code', code)
95
- // verify required parameter 'code2' is not null or undefined
96
- assertParamExists('getRefund', 'code2', code2)
97
- // verify required parameter 'expand' is not null or undefined
98
- assertParamExists('getRefund', 'expand', expand)
99
90
  const localVarPath = `/paymentservice/v1/refunds/{code}`
100
91
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
101
92
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -115,10 +106,6 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
115
106
  // http bearer authentication required
116
107
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
117
108
 
118
- if (code2 !== undefined) {
119
- localVarQueryParameter['code'] = code2;
120
- }
121
-
122
109
  if (expand !== undefined) {
123
110
  localVarQueryParameter['expand'] = expand;
124
111
  }
@@ -139,19 +126,18 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
139
126
  };
140
127
  },
141
128
  /**
142
- *
129
+ * 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.
130
+ * @summary List refunds
143
131
  * @param {string} [authorization] Bearer Token
144
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
145
- * @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.
146
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
147
- * @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.
148
- * @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.
149
- * @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.
150
- * @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.
132
+ * @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;
133
+ * @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;
134
+ * @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;
135
+ * @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;
136
+ * @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: refundItems&lt;i&gt;
151
137
  * @param {*} [options] Override http request option.
152
138
  * @throws {RequiredError}
153
139
  */
154
- listRefunds: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
140
+ listRefunds: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
155
141
  const localVarPath = `/paymentservice/v1/refunds`;
156
142
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
157
143
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -170,18 +156,14 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
170
156
  // http bearer authentication required
171
157
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
172
158
 
173
- if (pageSize !== undefined) {
174
- localVarQueryParameter['pageSize'] = pageSize;
175
- }
176
-
177
- if (pageToken !== undefined) {
178
- localVarQueryParameter['pageToken'] = pageToken;
179
- }
180
-
181
159
  if (filter !== undefined) {
182
160
  localVarQueryParameter['filter'] = filter;
183
161
  }
184
162
 
163
+ if (filters !== undefined) {
164
+ localVarQueryParameter['filters'] = filters;
165
+ }
166
+
185
167
  if (search !== undefined) {
186
168
  localVarQueryParameter['search'] = search;
187
169
  }
@@ -194,10 +176,6 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
194
176
  localVarQueryParameter['expand'] = expand;
195
177
  }
196
178
 
197
- if (filters !== undefined) {
198
- localVarQueryParameter['filters'] = filters;
199
- }
200
-
201
179
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
202
180
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
203
181
  }
@@ -224,44 +202,44 @@ export const RefundsApiFp = function(configuration?: Configuration) {
224
202
  const localVarAxiosParamCreator = RefundsApiAxiosParamCreator(configuration)
225
203
  return {
226
204
  /**
227
- *
205
+ * This will create a refund in the database.
206
+ * @summary Create the refund
228
207
  * @param {CreateRefundRequestDto} createRefundRequestDto
229
208
  * @param {string} [authorization] Bearer Token
230
209
  * @param {*} [options] Override http request option.
231
210
  * @throws {RequiredError}
232
211
  */
233
- async createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRefundResponseClass>> {
212
+ async createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
234
213
  const localVarAxiosArgs = await localVarAxiosParamCreator.createRefund(createRefundRequestDto, authorization, options);
235
214
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
236
215
  },
237
216
  /**
238
- *
217
+ * 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.
218
+ * @summary Retrieve the refund
239
219
  * @param {string} code
240
- * @param {string} code2 Unique identifier for the object.
241
- * @param {string} expand Fields to expand response by
242
220
  * @param {string} [authorization] Bearer Token
221
+ * @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: refundItems&lt;i&gt;
243
222
  * @param {*} [options] Override http request option.
244
223
  * @throws {RequiredError}
245
224
  */
246
- async getRefund(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>> {
247
- const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code, code2, expand, authorization, options);
225
+ async getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
226
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code, authorization, expand, options);
248
227
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
249
228
  },
250
229
  /**
251
- *
230
+ * 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.
231
+ * @summary List refunds
252
232
  * @param {string} [authorization] Bearer Token
253
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
254
- * @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.
255
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
256
- * @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.
257
- * @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.
258
- * @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.
259
- * @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.
233
+ * @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;
234
+ * @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;
235
+ * @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;
236
+ * @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;
237
+ * @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: refundItems&lt;i&gt;
260
238
  * @param {*} [options] Override http request option.
261
239
  * @throws {RequiredError}
262
240
  */
263
- async 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>> {
264
- const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
241
+ async listRefunds(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
242
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization, filter, filters, search, order, expand, options);
265
243
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
266
244
  },
267
245
  }
@@ -275,42 +253,42 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
275
253
  const localVarFp = RefundsApiFp(configuration)
276
254
  return {
277
255
  /**
278
- *
256
+ * This will create a refund in the database.
257
+ * @summary Create the refund
279
258
  * @param {CreateRefundRequestDto} createRefundRequestDto
280
259
  * @param {string} [authorization] Bearer Token
281
260
  * @param {*} [options] Override http request option.
282
261
  * @throws {RequiredError}
283
262
  */
284
- createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<CreateRefundResponseClass> {
263
+ createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
285
264
  return localVarFp.createRefund(createRefundRequestDto, authorization, options).then((request) => request(axios, basePath));
286
265
  },
287
266
  /**
288
- *
267
+ * 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.
268
+ * @summary Retrieve the refund
289
269
  * @param {string} code
290
- * @param {string} code2 Unique identifier for the object.
291
- * @param {string} expand Fields to expand response by
292
270
  * @param {string} [authorization] Bearer Token
271
+ * @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: refundItems&lt;i&gt;
293
272
  * @param {*} [options] Override http request option.
294
273
  * @throws {RequiredError}
295
274
  */
296
- getRefund(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetRefundResponseClass> {
297
- return localVarFp.getRefund(code, code2, expand, authorization, options).then((request) => request(axios, basePath));
275
+ getRefund(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
276
+ return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
298
277
  },
299
278
  /**
300
- *
279
+ * 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.
280
+ * @summary List refunds
301
281
  * @param {string} [authorization] Bearer Token
302
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
303
- * @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.
304
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
305
- * @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.
306
- * @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.
307
- * @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.
308
- * @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.
282
+ * @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;
283
+ * @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;
284
+ * @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;
285
+ * @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;
286
+ * @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: refundItems&lt;i&gt;
309
287
  * @param {*} [options] Override http request option.
310
288
  * @throws {RequiredError}
311
289
  */
312
- listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListRefundsResponseClass> {
313
- return localVarFp.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
290
+ listRefunds(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<void> {
291
+ return localVarFp.listRefunds(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
314
292
  },
315
293
  };
316
294
  };
@@ -350,25 +328,18 @@ export interface RefundsApiGetRefundRequest {
350
328
  readonly code: string
351
329
 
352
330
  /**
353
- * Unique identifier for the object.
354
- * @type {string}
355
- * @memberof RefundsApiGetRefund
356
- */
357
- readonly code2: string
358
-
359
- /**
360
- * Fields to expand response by
331
+ * Bearer Token
361
332
  * @type {string}
362
333
  * @memberof RefundsApiGetRefund
363
334
  */
364
- readonly expand: string
335
+ readonly authorization?: string
365
336
 
366
337
  /**
367
- * Bearer Token
338
+ * 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: refundItems&lt;i&gt;
368
339
  * @type {string}
369
340
  * @memberof RefundsApiGetRefund
370
341
  */
371
- readonly authorization?: string
342
+ readonly expand?: string
372
343
  }
373
344
 
374
345
  /**
@@ -385,53 +356,39 @@ export interface RefundsApiListRefundsRequest {
385
356
  readonly authorization?: string
386
357
 
387
358
  /**
388
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
389
- * @type {any}
390
- * @memberof RefundsApiListRefunds
391
- */
392
- readonly pageSize?: any
393
-
394
- /**
395
- * 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.
396
- * @type {any}
397
- * @memberof RefundsApiListRefunds
398
- */
399
- readonly pageToken?: any
400
-
401
- /**
402
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
403
- * @type {any}
359
+ * 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;
360
+ * @type {string}
404
361
  * @memberof RefundsApiListRefunds
405
362
  */
406
- readonly filter?: any
363
+ readonly filter?: string
407
364
 
408
365
  /**
409
- * 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.
410
- * @type {any}
366
+ * 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;
367
+ * @type {string}
411
368
  * @memberof RefundsApiListRefunds
412
369
  */
413
- readonly search?: any
370
+ readonly filters?: string
414
371
 
415
372
  /**
416
- * 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.
417
- * @type {any}
373
+ * 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;
374
+ * @type {string}
418
375
  * @memberof RefundsApiListRefunds
419
376
  */
420
- readonly order?: any
377
+ readonly search?: string
421
378
 
422
379
  /**
423
- * 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.
424
- * @type {any}
380
+ * 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;
381
+ * @type {string}
425
382
  * @memberof RefundsApiListRefunds
426
383
  */
427
- readonly expand?: any
384
+ readonly order?: string
428
385
 
429
386
  /**
430
- * 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.
431
- * @type {any}
387
+ * 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: refundItems&lt;i&gt;
388
+ * @type {string}
432
389
  * @memberof RefundsApiListRefunds
433
390
  */
434
- readonly filters?: any
391
+ readonly expand?: string
435
392
  }
436
393
 
437
394
  /**
@@ -442,7 +399,8 @@ export interface RefundsApiListRefundsRequest {
442
399
  */
443
400
  export class RefundsApi extends BaseAPI {
444
401
  /**
445
- *
402
+ * This will create a refund in the database.
403
+ * @summary Create the refund
446
404
  * @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
447
405
  * @param {*} [options] Override http request option.
448
406
  * @throws {RequiredError}
@@ -453,24 +411,26 @@ export class RefundsApi extends BaseAPI {
453
411
  }
454
412
 
455
413
  /**
456
- *
414
+ * 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.
415
+ * @summary Retrieve the refund
457
416
  * @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
458
417
  * @param {*} [options] Override http request option.
459
418
  * @throws {RequiredError}
460
419
  * @memberof RefundsApi
461
420
  */
462
421
  public getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig) {
463
- return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.code2, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
422
+ return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
464
423
  }
465
424
 
466
425
  /**
467
- *
426
+ * 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.
427
+ * @summary List refunds
468
428
  * @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
469
429
  * @param {*} [options] Override http request option.
470
430
  * @throws {RequiredError}
471
431
  * @memberof RefundsApi
472
432
  */
473
433
  public listRefunds(requestParameters: RefundsApiListRefundsRequest = {}, options?: AxiosRequestConfig) {
474
- return RefundsApiFp(this.configuration).listRefunds(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
434
+ return RefundsApiFp(this.configuration).listRefunds(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
475
435
  }
476
436
  }