@emilgroup/payment-sdk 1.14.1-beta.58 → 1.14.1-beta.59

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 (31) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/api/payout-methods-api.ts +672 -0
  4. package/api.ts +2 -0
  5. package/dist/api/payout-methods-api.d.ts +382 -0
  6. package/dist/api/payout-methods-api.js +635 -0
  7. package/dist/api.d.ts +1 -0
  8. package/dist/api.js +1 -0
  9. package/dist/models/create-billing-address-request-dto.d.ts +1 -7
  10. package/dist/models/create-payout-method-request-dto.d.ts +60 -0
  11. package/dist/models/create-payout-method-request-dto.js +15 -0
  12. package/dist/models/create-payout-method-response-class.d.ts +25 -0
  13. package/dist/models/create-payout-method-response-class.js +15 -0
  14. package/dist/models/get-payout-method-response-class.d.ts +25 -0
  15. package/dist/models/get-payout-method-response-class.js +15 -0
  16. package/dist/models/index.d.ts +5 -0
  17. package/dist/models/index.js +5 -0
  18. package/dist/models/list-payout-methods-response-class.d.ts +43 -0
  19. package/dist/models/list-payout-methods-response-class.js +15 -0
  20. package/dist/models/payout-method-class.d.ts +115 -0
  21. package/dist/models/payout-method-class.js +15 -0
  22. package/dist/models/update-billing-address-request-dto.d.ts +1 -7
  23. package/models/create-billing-address-request-dto.ts +1 -7
  24. package/models/create-payout-method-request-dto.ts +66 -0
  25. package/models/create-payout-method-response-class.ts +31 -0
  26. package/models/get-payout-method-response-class.ts +31 -0
  27. package/models/index.ts +5 -0
  28. package/models/list-payout-methods-response-class.ts +49 -0
  29. package/models/payout-method-class.ts +121 -0
  30. package/models/update-billing-address-request-dto.ts +1 -7
  31. package/package.json +1 -1
@@ -0,0 +1,672 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { CreatePayoutMethodRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreatePayoutMethodResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { GetPayoutMethodResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListPayoutMethodsResponseClass } from '../models';
31
+ /**
32
+ * PayoutMethodsApi - axios parameter creator
33
+ * @export
34
+ */
35
+ export const PayoutMethodsApiAxiosParamCreator = function (configuration?: Configuration) {
36
+ return {
37
+ /**
38
+ * Activates a payout method **Required Permissions** \"payment-management.payments.create\"
39
+ * @summary Create the Payout Method Activation
40
+ * @param {string} code
41
+ * @param {string} [authorization] Bearer Token
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ activatePayoutMethod: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
+ // verify required parameter 'code' is not null or undefined
47
+ assertParamExists('activatePayoutMethod', 'code', code)
48
+ const localVarPath = `/paymentservice/v1/payout-methods/{code}/activate`
49
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
50
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
51
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
52
+ let baseOptions;
53
+ let baseAccessToken;
54
+ if (configuration) {
55
+ baseOptions = configuration.baseOptions;
56
+ baseAccessToken = configuration.accessToken;
57
+ }
58
+
59
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
60
+ const localVarHeaderParameter = {} as any;
61
+ const localVarQueryParameter = {} as any;
62
+
63
+ // authentication bearer required
64
+ // http bearer authentication required
65
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
66
+
67
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
68
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
69
+ }
70
+
71
+
72
+
73
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
74
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
75
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
76
+
77
+ return {
78
+ url: toPathString(localVarUrlObj),
79
+ options: localVarRequestOptions,
80
+ };
81
+ },
82
+ /**
83
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
84
+ * @summary Create the Payout Method
85
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
86
+ * @param {string} [authorization] Bearer Token
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ createPayoutMethod: async (createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
91
+ // verify required parameter 'createPayoutMethodRequestDto' is not null or undefined
92
+ assertParamExists('createPayoutMethod', 'createPayoutMethodRequestDto', createPayoutMethodRequestDto)
93
+ const localVarPath = `/paymentservice/v1/payout-methods`;
94
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
95
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
96
+ let baseOptions;
97
+ let baseAccessToken;
98
+ if (configuration) {
99
+ baseOptions = configuration.baseOptions;
100
+ baseAccessToken = configuration.accessToken;
101
+ }
102
+
103
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
104
+ const localVarHeaderParameter = {} as any;
105
+ const localVarQueryParameter = {} as any;
106
+
107
+ // authentication bearer required
108
+ // http bearer authentication required
109
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
110
+
111
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
112
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
113
+ }
114
+
115
+
116
+
117
+ localVarHeaderParameter['Content-Type'] = 'application/json';
118
+
119
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
120
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
121
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
122
+ localVarRequestOptions.data = serializeDataIfNeeded(createPayoutMethodRequestDto, localVarRequestOptions, configuration)
123
+
124
+ return {
125
+ url: toPathString(localVarUrlObj),
126
+ options: localVarRequestOptions,
127
+ };
128
+ },
129
+ /**
130
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
131
+ * @summary Delete the Payout Method
132
+ * @param {string} code Unique identifier for the object.
133
+ * @param {string} [authorization] Bearer Token
134
+ * @param {*} [options] Override http request option.
135
+ * @throws {RequiredError}
136
+ */
137
+ deletePayoutMethod: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
138
+ // verify required parameter 'code' is not null or undefined
139
+ assertParamExists('deletePayoutMethod', 'code', code)
140
+ const localVarPath = `/paymentservice/v1/payout-methods/{code}`
141
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
142
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
143
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
144
+ let baseOptions;
145
+ let baseAccessToken;
146
+ if (configuration) {
147
+ baseOptions = configuration.baseOptions;
148
+ baseAccessToken = configuration.accessToken;
149
+ }
150
+
151
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
152
+ const localVarHeaderParameter = {} as any;
153
+ const localVarQueryParameter = {} as any;
154
+
155
+ // authentication bearer required
156
+ // http bearer authentication required
157
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
158
+
159
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
160
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
161
+ }
162
+
163
+
164
+
165
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
166
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
167
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
168
+
169
+ return {
170
+ url: toPathString(localVarUrlObj),
171
+ options: localVarRequestOptions,
172
+ };
173
+ },
174
+ /**
175
+ * Retrieves the details of the Payout Method that was previously created. Supply the unique Payout Method code that was returned when you created it and Emil Api will return the corresponding Payout Method information. **Required Permissions** \"payment-management.payments.view\"
176
+ * @summary Retrieve the Payout Method
177
+ * @param {string} code
178
+ * @param {string} [authorization] Bearer Token
179
+ * @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: billingAddress&lt;i&gt;
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ getPayoutMethod: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
184
+ // verify required parameter 'code' is not null or undefined
185
+ assertParamExists('getPayoutMethod', 'code', code)
186
+ const localVarPath = `/paymentservice/v1/payout-methods/{code}`
187
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
188
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
189
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
190
+ let baseOptions;
191
+ let baseAccessToken;
192
+ if (configuration) {
193
+ baseOptions = configuration.baseOptions;
194
+ baseAccessToken = configuration.accessToken;
195
+ }
196
+
197
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
198
+ const localVarHeaderParameter = {} as any;
199
+ const localVarQueryParameter = {} as any;
200
+
201
+ // authentication bearer required
202
+ // http bearer authentication required
203
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
204
+
205
+ if (expand !== undefined) {
206
+ localVarQueryParameter['expand'] = expand;
207
+ }
208
+
209
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
210
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
211
+ }
212
+
213
+
214
+
215
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
216
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
217
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
218
+
219
+ return {
220
+ url: toPathString(localVarUrlObj),
221
+ options: localVarRequestOptions,
222
+ };
223
+ },
224
+ /**
225
+ * Returns a list of Payout Methods you have previously created. The Payout Methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
226
+ * @summary List Payout Methods
227
+ * @param {string} [authorization] Bearer Token
228
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
229
+ * @param {string} [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.
230
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt&lt;/i&gt;
231
+ * @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: firstName, lastName, iban, bankName, accountCode, partnerCode&lt;/i&gt;
232
+ * @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, code, isActive, createdAt, updatedAt&lt;/i&gt;
233
+ * @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: billingAddress&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: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt&lt;/i&gt;
235
+ * @param {*} [options] Override http request option.
236
+ * @throws {RequiredError}
237
+ */
238
+ listPayoutMethods: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
239
+ const localVarPath = `/paymentservice/v1/payout-methods`;
240
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
241
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
242
+ let baseOptions;
243
+ let baseAccessToken;
244
+ if (configuration) {
245
+ baseOptions = configuration.baseOptions;
246
+ baseAccessToken = configuration.accessToken;
247
+ }
248
+
249
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
250
+ const localVarHeaderParameter = {} as any;
251
+ const localVarQueryParameter = {} as any;
252
+
253
+ // authentication bearer required
254
+ // http bearer authentication required
255
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
256
+
257
+ if (pageSize !== undefined) {
258
+ localVarQueryParameter['pageSize'] = pageSize;
259
+ }
260
+
261
+ if (pageToken !== undefined) {
262
+ localVarQueryParameter['pageToken'] = pageToken;
263
+ }
264
+
265
+ if (filter !== undefined) {
266
+ localVarQueryParameter['filter'] = filter;
267
+ }
268
+
269
+ if (search !== undefined) {
270
+ localVarQueryParameter['search'] = search;
271
+ }
272
+
273
+ if (order !== undefined) {
274
+ localVarQueryParameter['order'] = order;
275
+ }
276
+
277
+ if (expand !== undefined) {
278
+ localVarQueryParameter['expand'] = expand;
279
+ }
280
+
281
+ if (filters !== undefined) {
282
+ localVarQueryParameter['filters'] = filters;
283
+ }
284
+
285
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
286
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
287
+ }
288
+
289
+
290
+
291
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
292
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
293
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
294
+
295
+ return {
296
+ url: toPathString(localVarUrlObj),
297
+ options: localVarRequestOptions,
298
+ };
299
+ },
300
+ }
301
+ };
302
+
303
+ /**
304
+ * PayoutMethodsApi - functional programming interface
305
+ * @export
306
+ */
307
+ export const PayoutMethodsApiFp = function(configuration?: Configuration) {
308
+ const localVarAxiosParamCreator = PayoutMethodsApiAxiosParamCreator(configuration)
309
+ return {
310
+ /**
311
+ * Activates a payout method **Required Permissions** \"payment-management.payments.create\"
312
+ * @summary Create the Payout Method Activation
313
+ * @param {string} code
314
+ * @param {string} [authorization] Bearer Token
315
+ * @param {*} [options] Override http request option.
316
+ * @throws {RequiredError}
317
+ */
318
+ async activatePayoutMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
319
+ const localVarAxiosArgs = await localVarAxiosParamCreator.activatePayoutMethod(code, authorization, options);
320
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
321
+ },
322
+ /**
323
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
324
+ * @summary Create the Payout Method
325
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
326
+ * @param {string} [authorization] Bearer Token
327
+ * @param {*} [options] Override http request option.
328
+ * @throws {RequiredError}
329
+ */
330
+ async createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePayoutMethodResponseClass>> {
331
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createPayoutMethod(createPayoutMethodRequestDto, authorization, options);
332
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
333
+ },
334
+ /**
335
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
336
+ * @summary Delete the Payout Method
337
+ * @param {string} code Unique identifier for the object.
338
+ * @param {string} [authorization] Bearer Token
339
+ * @param {*} [options] Override http request option.
340
+ * @throws {RequiredError}
341
+ */
342
+ async deletePayoutMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
343
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deletePayoutMethod(code, authorization, options);
344
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
345
+ },
346
+ /**
347
+ * Retrieves the details of the Payout Method that was previously created. Supply the unique Payout Method code that was returned when you created it and Emil Api will return the corresponding Payout Method information. **Required Permissions** \"payment-management.payments.view\"
348
+ * @summary Retrieve the Payout Method
349
+ * @param {string} code
350
+ * @param {string} [authorization] Bearer Token
351
+ * @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: billingAddress&lt;i&gt;
352
+ * @param {*} [options] Override http request option.
353
+ * @throws {RequiredError}
354
+ */
355
+ async getPayoutMethod(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayoutMethodResponseClass>> {
356
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPayoutMethod(code, authorization, expand, options);
357
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
358
+ },
359
+ /**
360
+ * Returns a list of Payout Methods you have previously created. The Payout Methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
361
+ * @summary List Payout Methods
362
+ * @param {string} [authorization] Bearer Token
363
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
+ * @param {string} [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.
365
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt&lt;/i&gt;
366
+ * @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: firstName, lastName, iban, bankName, accountCode, partnerCode&lt;/i&gt;
367
+ * @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, code, isActive, createdAt, updatedAt&lt;/i&gt;
368
+ * @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: billingAddress&lt;i&gt;
369
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt&lt;/i&gt;
370
+ * @param {*} [options] Override http request option.
371
+ * @throws {RequiredError}
372
+ */
373
+ async listPayoutMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPayoutMethodsResponseClass>> {
374
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPayoutMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
375
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
+ },
377
+ }
378
+ };
379
+
380
+ /**
381
+ * PayoutMethodsApi - factory interface
382
+ * @export
383
+ */
384
+ export const PayoutMethodsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
385
+ const localVarFp = PayoutMethodsApiFp(configuration)
386
+ return {
387
+ /**
388
+ * Activates a payout method **Required Permissions** \"payment-management.payments.create\"
389
+ * @summary Create the Payout Method Activation
390
+ * @param {string} code
391
+ * @param {string} [authorization] Bearer Token
392
+ * @param {*} [options] Override http request option.
393
+ * @throws {RequiredError}
394
+ */
395
+ activatePayoutMethod(code: string, authorization?: string, options?: any): AxiosPromise<void> {
396
+ return localVarFp.activatePayoutMethod(code, authorization, options).then((request) => request(axios, basePath));
397
+ },
398
+ /**
399
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
400
+ * @summary Create the Payout Method
401
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
402
+ * @param {string} [authorization] Bearer Token
403
+ * @param {*} [options] Override http request option.
404
+ * @throws {RequiredError}
405
+ */
406
+ createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePayoutMethodResponseClass> {
407
+ return localVarFp.createPayoutMethod(createPayoutMethodRequestDto, authorization, options).then((request) => request(axios, basePath));
408
+ },
409
+ /**
410
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
411
+ * @summary Delete the Payout Method
412
+ * @param {string} code Unique identifier for the object.
413
+ * @param {string} [authorization] Bearer Token
414
+ * @param {*} [options] Override http request option.
415
+ * @throws {RequiredError}
416
+ */
417
+ deletePayoutMethod(code: string, authorization?: string, options?: any): AxiosPromise<object> {
418
+ return localVarFp.deletePayoutMethod(code, authorization, options).then((request) => request(axios, basePath));
419
+ },
420
+ /**
421
+ * Retrieves the details of the Payout Method that was previously created. Supply the unique Payout Method code that was returned when you created it and Emil Api will return the corresponding Payout Method information. **Required Permissions** \"payment-management.payments.view\"
422
+ * @summary Retrieve the Payout Method
423
+ * @param {string} code
424
+ * @param {string} [authorization] Bearer Token
425
+ * @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: billingAddress&lt;i&gt;
426
+ * @param {*} [options] Override http request option.
427
+ * @throws {RequiredError}
428
+ */
429
+ getPayoutMethod(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPayoutMethodResponseClass> {
430
+ return localVarFp.getPayoutMethod(code, authorization, expand, options).then((request) => request(axios, basePath));
431
+ },
432
+ /**
433
+ * Returns a list of Payout Methods you have previously created. The Payout Methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
434
+ * @summary List Payout Methods
435
+ * @param {string} [authorization] Bearer Token
436
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
437
+ * @param {string} [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.
438
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt&lt;/i&gt;
439
+ * @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: firstName, lastName, iban, bankName, accountCode, partnerCode&lt;/i&gt;
440
+ * @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, code, isActive, createdAt, updatedAt&lt;/i&gt;
441
+ * @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: billingAddress&lt;i&gt;
442
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt&lt;/i&gt;
443
+ * @param {*} [options] Override http request option.
444
+ * @throws {RequiredError}
445
+ */
446
+ listPayoutMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPayoutMethodsResponseClass> {
447
+ return localVarFp.listPayoutMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
448
+ },
449
+ };
450
+ };
451
+
452
+ /**
453
+ * Request parameters for activatePayoutMethod operation in PayoutMethodsApi.
454
+ * @export
455
+ * @interface PayoutMethodsApiActivatePayoutMethodRequest
456
+ */
457
+ export interface PayoutMethodsApiActivatePayoutMethodRequest {
458
+ /**
459
+ *
460
+ * @type {string}
461
+ * @memberof PayoutMethodsApiActivatePayoutMethod
462
+ */
463
+ readonly code: string
464
+
465
+ /**
466
+ * Bearer Token
467
+ * @type {string}
468
+ * @memberof PayoutMethodsApiActivatePayoutMethod
469
+ */
470
+ readonly authorization?: string
471
+ }
472
+
473
+ /**
474
+ * Request parameters for createPayoutMethod operation in PayoutMethodsApi.
475
+ * @export
476
+ * @interface PayoutMethodsApiCreatePayoutMethodRequest
477
+ */
478
+ export interface PayoutMethodsApiCreatePayoutMethodRequest {
479
+ /**
480
+ *
481
+ * @type {CreatePayoutMethodRequestDto}
482
+ * @memberof PayoutMethodsApiCreatePayoutMethod
483
+ */
484
+ readonly createPayoutMethodRequestDto: CreatePayoutMethodRequestDto
485
+
486
+ /**
487
+ * Bearer Token
488
+ * @type {string}
489
+ * @memberof PayoutMethodsApiCreatePayoutMethod
490
+ */
491
+ readonly authorization?: string
492
+ }
493
+
494
+ /**
495
+ * Request parameters for deletePayoutMethod operation in PayoutMethodsApi.
496
+ * @export
497
+ * @interface PayoutMethodsApiDeletePayoutMethodRequest
498
+ */
499
+ export interface PayoutMethodsApiDeletePayoutMethodRequest {
500
+ /**
501
+ * Unique identifier for the object.
502
+ * @type {string}
503
+ * @memberof PayoutMethodsApiDeletePayoutMethod
504
+ */
505
+ readonly code: string
506
+
507
+ /**
508
+ * Bearer Token
509
+ * @type {string}
510
+ * @memberof PayoutMethodsApiDeletePayoutMethod
511
+ */
512
+ readonly authorization?: string
513
+ }
514
+
515
+ /**
516
+ * Request parameters for getPayoutMethod operation in PayoutMethodsApi.
517
+ * @export
518
+ * @interface PayoutMethodsApiGetPayoutMethodRequest
519
+ */
520
+ export interface PayoutMethodsApiGetPayoutMethodRequest {
521
+ /**
522
+ *
523
+ * @type {string}
524
+ * @memberof PayoutMethodsApiGetPayoutMethod
525
+ */
526
+ readonly code: string
527
+
528
+ /**
529
+ * Bearer Token
530
+ * @type {string}
531
+ * @memberof PayoutMethodsApiGetPayoutMethod
532
+ */
533
+ readonly authorization?: string
534
+
535
+ /**
536
+ * 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: billingAddress&lt;i&gt;
537
+ * @type {string}
538
+ * @memberof PayoutMethodsApiGetPayoutMethod
539
+ */
540
+ readonly expand?: string
541
+ }
542
+
543
+ /**
544
+ * Request parameters for listPayoutMethods operation in PayoutMethodsApi.
545
+ * @export
546
+ * @interface PayoutMethodsApiListPayoutMethodsRequest
547
+ */
548
+ export interface PayoutMethodsApiListPayoutMethodsRequest {
549
+ /**
550
+ * Bearer Token
551
+ * @type {string}
552
+ * @memberof PayoutMethodsApiListPayoutMethods
553
+ */
554
+ readonly authorization?: string
555
+
556
+ /**
557
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
558
+ * @type {number}
559
+ * @memberof PayoutMethodsApiListPayoutMethods
560
+ */
561
+ readonly pageSize?: number
562
+
563
+ /**
564
+ * 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.
565
+ * @type {string}
566
+ * @memberof PayoutMethodsApiListPayoutMethods
567
+ */
568
+ readonly pageToken?: string
569
+
570
+ /**
571
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt&lt;/i&gt;
572
+ * @type {string}
573
+ * @memberof PayoutMethodsApiListPayoutMethods
574
+ */
575
+ readonly filter?: string
576
+
577
+ /**
578
+ * 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: firstName, lastName, iban, bankName, accountCode, partnerCode&lt;/i&gt;
579
+ * @type {string}
580
+ * @memberof PayoutMethodsApiListPayoutMethods
581
+ */
582
+ readonly search?: string
583
+
584
+ /**
585
+ * 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, code, isActive, createdAt, updatedAt&lt;/i&gt;
586
+ * @type {string}
587
+ * @memberof PayoutMethodsApiListPayoutMethods
588
+ */
589
+ readonly order?: string
590
+
591
+ /**
592
+ * 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: billingAddress&lt;i&gt;
593
+ * @type {string}
594
+ * @memberof PayoutMethodsApiListPayoutMethods
595
+ */
596
+ readonly expand?: string
597
+
598
+ /**
599
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt&lt;/i&gt;
600
+ * @type {string}
601
+ * @memberof PayoutMethodsApiListPayoutMethods
602
+ */
603
+ readonly filters?: string
604
+ }
605
+
606
+ /**
607
+ * PayoutMethodsApi - object-oriented interface
608
+ * @export
609
+ * @class PayoutMethodsApi
610
+ * @extends {BaseAPI}
611
+ */
612
+ export class PayoutMethodsApi extends BaseAPI {
613
+ /**
614
+ * Activates a payout method **Required Permissions** \"payment-management.payments.create\"
615
+ * @summary Create the Payout Method Activation
616
+ * @param {PayoutMethodsApiActivatePayoutMethodRequest} requestParameters Request parameters.
617
+ * @param {*} [options] Override http request option.
618
+ * @throws {RequiredError}
619
+ * @memberof PayoutMethodsApi
620
+ */
621
+ public activatePayoutMethod(requestParameters: PayoutMethodsApiActivatePayoutMethodRequest, options?: AxiosRequestConfig) {
622
+ return PayoutMethodsApiFp(this.configuration).activatePayoutMethod(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
623
+ }
624
+
625
+ /**
626
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
627
+ * @summary Create the Payout Method
628
+ * @param {PayoutMethodsApiCreatePayoutMethodRequest} requestParameters Request parameters.
629
+ * @param {*} [options] Override http request option.
630
+ * @throws {RequiredError}
631
+ * @memberof PayoutMethodsApi
632
+ */
633
+ public createPayoutMethod(requestParameters: PayoutMethodsApiCreatePayoutMethodRequest, options?: AxiosRequestConfig) {
634
+ return PayoutMethodsApiFp(this.configuration).createPayoutMethod(requestParameters.createPayoutMethodRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
635
+ }
636
+
637
+ /**
638
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
639
+ * @summary Delete the Payout Method
640
+ * @param {PayoutMethodsApiDeletePayoutMethodRequest} requestParameters Request parameters.
641
+ * @param {*} [options] Override http request option.
642
+ * @throws {RequiredError}
643
+ * @memberof PayoutMethodsApi
644
+ */
645
+ public deletePayoutMethod(requestParameters: PayoutMethodsApiDeletePayoutMethodRequest, options?: AxiosRequestConfig) {
646
+ return PayoutMethodsApiFp(this.configuration).deletePayoutMethod(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
647
+ }
648
+
649
+ /**
650
+ * Retrieves the details of the Payout Method that was previously created. Supply the unique Payout Method code that was returned when you created it and Emil Api will return the corresponding Payout Method information. **Required Permissions** \"payment-management.payments.view\"
651
+ * @summary Retrieve the Payout Method
652
+ * @param {PayoutMethodsApiGetPayoutMethodRequest} requestParameters Request parameters.
653
+ * @param {*} [options] Override http request option.
654
+ * @throws {RequiredError}
655
+ * @memberof PayoutMethodsApi
656
+ */
657
+ public getPayoutMethod(requestParameters: PayoutMethodsApiGetPayoutMethodRequest, options?: AxiosRequestConfig) {
658
+ return PayoutMethodsApiFp(this.configuration).getPayoutMethod(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
659
+ }
660
+
661
+ /**
662
+ * Returns a list of Payout Methods you have previously created. The Payout Methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
663
+ * @summary List Payout Methods
664
+ * @param {PayoutMethodsApiListPayoutMethodsRequest} requestParameters Request parameters.
665
+ * @param {*} [options] Override http request option.
666
+ * @throws {RequiredError}
667
+ * @memberof PayoutMethodsApi
668
+ */
669
+ public listPayoutMethods(requestParameters: PayoutMethodsApiListPayoutMethodsRequest = {}, options?: AxiosRequestConfig) {
670
+ return PayoutMethodsApiFp(this.configuration).listPayoutMethods(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
671
+ }
672
+ }