@emilgroup/payment-sdk-node 1.23.0 → 1.23.1-beta.100

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 (180) hide show
  1. package/.openapi-generator/FILES +34 -0
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +16 -16
  4. package/api/bank-orders-api.ts +16 -16
  5. package/api/bank-transaction-api.ts +12 -12
  6. package/api/billing-addresses-api.ts +681 -0
  7. package/api/credit-allocation-api.ts +12 -12
  8. package/api/exceeding-credits-api.ts +12 -12
  9. package/api/ibanvalidator-api.ts +169 -0
  10. package/api/payment-methods-api.ts +12 -12
  11. package/api/payment-receipts-api.ts +680 -0
  12. package/api/payment-reminders-api.ts +16 -16
  13. package/api/payment-requests-api.ts +697 -0
  14. package/api/payments-api.ts +12 -12
  15. package/api/payout-methods-api.ts +794 -0
  16. package/api/refunds-api.ts +12 -12
  17. package/api/tenant-bank-account-api.ts +16 -16
  18. package/api/webhooks-api.ts +125 -14
  19. package/api.ts +10 -0
  20. package/base.ts +1 -0
  21. package/dist/api/bank-accounts-api.d.ts +16 -16
  22. package/dist/api/bank-accounts-api.js +13 -13
  23. package/dist/api/bank-orders-api.d.ts +16 -16
  24. package/dist/api/bank-orders-api.js +14 -14
  25. package/dist/api/bank-transaction-api.d.ts +12 -12
  26. package/dist/api/bank-transaction-api.js +10 -10
  27. package/dist/api/billing-addresses-api.d.ts +384 -0
  28. package/dist/api/billing-addresses-api.js +640 -0
  29. package/dist/api/credit-allocation-api.d.ts +12 -12
  30. package/dist/api/credit-allocation-api.js +10 -10
  31. package/dist/api/exceeding-credits-api.d.ts +12 -12
  32. package/dist/api/exceeding-credits-api.js +10 -10
  33. package/dist/api/ibanvalidator-api.d.ts +97 -0
  34. package/dist/api/ibanvalidator-api.js +228 -0
  35. package/dist/api/payment-methods-api.d.ts +12 -12
  36. package/dist/api/payment-methods-api.js +10 -10
  37. package/dist/api/payment-receipts-api.d.ts +383 -0
  38. package/dist/api/payment-receipts-api.js +641 -0
  39. package/dist/api/payment-reminders-api.d.ts +16 -16
  40. package/dist/api/payment-reminders-api.js +13 -13
  41. package/dist/api/payment-requests-api.d.ts +393 -0
  42. package/dist/api/payment-requests-api.js +648 -0
  43. package/dist/api/payments-api.d.ts +12 -12
  44. package/dist/api/payments-api.js +10 -10
  45. package/dist/api/payout-methods-api.d.ts +447 -0
  46. package/dist/api/payout-methods-api.js +738 -0
  47. package/dist/api/refunds-api.d.ts +12 -12
  48. package/dist/api/refunds-api.js +10 -10
  49. package/dist/api/tenant-bank-account-api.d.ts +16 -16
  50. package/dist/api/tenant-bank-account-api.js +13 -13
  51. package/dist/api/webhooks-api.d.ts +73 -9
  52. package/dist/api/webhooks-api.js +100 -11
  53. package/dist/api.d.ts +5 -0
  54. package/dist/api.js +5 -0
  55. package/dist/base.d.ts +2 -1
  56. package/dist/base.js +1 -0
  57. package/dist/models/bank-account-class-without-expand-properties.d.ts +6 -0
  58. package/dist/models/bank-account-class.d.ts +6 -0
  59. package/dist/models/bank-data-class.d.ts +36 -0
  60. package/dist/models/bank-data-class.js +15 -0
  61. package/dist/models/bank-order-class.d.ts +3 -3
  62. package/dist/models/bank-order-entity.d.ts +3 -2
  63. package/dist/models/bank-order-entity.js +2 -1
  64. package/dist/models/billing-address-class.d.ts +108 -0
  65. package/dist/models/billing-address-class.js +15 -0
  66. package/dist/models/create-bank-order-request-dto.d.ts +4 -3
  67. package/dist/models/create-bank-order-request-dto.js +2 -1
  68. package/dist/models/create-billing-address-request-dto.d.ts +66 -0
  69. package/dist/models/create-billing-address-request-dto.js +15 -0
  70. package/dist/models/create-billing-address-response-class.d.ts +25 -0
  71. package/dist/models/create-billing-address-response-class.js +15 -0
  72. package/dist/models/create-payment-receipt-request-dto.d.ts +65 -0
  73. package/dist/models/create-payment-receipt-request-dto.js +20 -0
  74. package/dist/models/create-payment-receipt-response-class.d.ts +25 -0
  75. package/dist/models/create-payment-receipt-response-class.js +15 -0
  76. package/dist/models/create-payment-request-request-dto.d.ts +109 -0
  77. package/dist/models/create-payment-request-request-dto.js +30 -0
  78. package/dist/models/create-payment-request-response-class.d.ts +25 -0
  79. package/dist/models/create-payment-request-response-class.js +15 -0
  80. package/dist/models/create-payout-method-by-bank-account-request-dto.d.ts +36 -0
  81. package/dist/models/create-payout-method-by-bank-account-request-dto.js +15 -0
  82. package/dist/models/create-payout-method-request-dto.d.ts +66 -0
  83. package/dist/models/create-payout-method-request-dto.js +15 -0
  84. package/dist/models/create-payout-method-response-class.d.ts +25 -0
  85. package/dist/models/create-payout-method-response-class.js +15 -0
  86. package/dist/models/create-tenant-bank-account-request-dto.d.ts +17 -0
  87. package/dist/models/create-tenant-bank-account-request-dto.js +11 -1
  88. package/dist/models/get-billing-address-response-class.d.ts +25 -0
  89. package/dist/models/get-billing-address-response-class.js +15 -0
  90. package/dist/models/get-payment-receipt-response-class.d.ts +25 -0
  91. package/dist/models/get-payment-receipt-response-class.js +15 -0
  92. package/dist/models/get-payment-request-response-class.d.ts +25 -0
  93. package/dist/models/get-payment-request-response-class.js +15 -0
  94. package/dist/models/get-payout-method-response-class.d.ts +25 -0
  95. package/dist/models/get-payout-method-response-class.js +15 -0
  96. package/dist/models/index.d.ts +29 -0
  97. package/dist/models/index.js +29 -0
  98. package/dist/models/list-billing-addresses-response-class.d.ts +43 -0
  99. package/dist/models/list-billing-addresses-response-class.js +15 -0
  100. package/dist/models/list-exceeding-credits-response-class.d.ts +18 -6
  101. package/dist/models/list-payment-receipts-response-class.d.ts +43 -0
  102. package/dist/models/list-payment-receipts-response-class.js +15 -0
  103. package/dist/models/list-payment-requests-response-class.d.ts +43 -0
  104. package/dist/models/list-payment-requests-response-class.js +15 -0
  105. package/dist/models/list-payout-methods-response-class.d.ts +43 -0
  106. package/dist/models/list-payout-methods-response-class.js +15 -0
  107. package/dist/models/list-refunds-response-class.d.ts +18 -6
  108. package/dist/models/payment-receipt-class.d.ts +101 -0
  109. package/dist/models/payment-receipt-class.js +20 -0
  110. package/dist/models/payment-request-class.d.ts +155 -0
  111. package/dist/models/payment-request-class.js +38 -0
  112. package/dist/models/payout-method-class.d.ts +121 -0
  113. package/dist/models/payout-method-class.js +15 -0
  114. package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +17 -0
  115. package/dist/models/tenant-bank-account-class-without-expand-properties.js +11 -1
  116. package/dist/models/tenant-bank-account-class.d.ts +17 -0
  117. package/dist/models/tenant-bank-account-class.js +11 -1
  118. package/dist/models/tenant-bank-account-entity.d.ts +17 -0
  119. package/dist/models/tenant-bank-account-entity.js +11 -1
  120. package/dist/models/update-bank-order-request-dto.d.ts +3 -3
  121. package/dist/models/update-billing-address-request-dto.d.ts +66 -0
  122. package/dist/models/update-billing-address-request-dto.js +15 -0
  123. package/dist/models/update-billing-address-response-class.d.ts +25 -0
  124. package/dist/models/update-billing-address-response-class.js +15 -0
  125. package/dist/models/update-payment-receipt-response-class.d.ts +25 -0
  126. package/dist/models/update-payment-receipt-response-class.js +15 -0
  127. package/dist/models/update-payment-request-request-dto.d.ts +39 -0
  128. package/dist/models/update-payment-request-request-dto.js +24 -0
  129. package/dist/models/update-payment-request-response-class.d.ts +25 -0
  130. package/dist/models/update-payment-request-response-class.js +15 -0
  131. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +17 -0
  132. package/dist/models/update-tenant-bank-account-rest-request-dto.js +11 -1
  133. package/dist/models/validate-iban-request-dto.d.ts +24 -0
  134. package/dist/models/validate-iban-request-dto.js +15 -0
  135. package/dist/models/validate-iban-response-class.d.ts +31 -0
  136. package/dist/models/validate-iban-response-class.js +15 -0
  137. package/models/bank-account-class-without-expand-properties.ts +6 -0
  138. package/models/bank-account-class.ts +6 -0
  139. package/models/bank-data-class.ts +42 -0
  140. package/models/bank-order-class.ts +3 -3
  141. package/models/bank-order-entity.ts +4 -3
  142. package/models/billing-address-class.ts +114 -0
  143. package/models/create-bank-order-request-dto.ts +5 -4
  144. package/models/create-billing-address-request-dto.ts +72 -0
  145. package/models/create-billing-address-response-class.ts +31 -0
  146. package/models/create-payment-receipt-request-dto.ts +74 -0
  147. package/models/create-payment-receipt-response-class.ts +31 -0
  148. package/models/create-payment-request-request-dto.ts +118 -0
  149. package/models/create-payment-request-response-class.ts +31 -0
  150. package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
  151. package/models/create-payout-method-request-dto.ts +72 -0
  152. package/models/create-payout-method-response-class.ts +31 -0
  153. package/models/create-tenant-bank-account-request-dto.ts +18 -0
  154. package/models/get-billing-address-response-class.ts +31 -0
  155. package/models/get-payment-receipt-response-class.ts +31 -0
  156. package/models/get-payment-request-response-class.ts +31 -0
  157. package/models/get-payout-method-response-class.ts +31 -0
  158. package/models/index.ts +29 -0
  159. package/models/list-billing-addresses-response-class.ts +49 -0
  160. package/models/list-exceeding-credits-response-class.ts +18 -6
  161. package/models/list-payment-receipts-response-class.ts +49 -0
  162. package/models/list-payment-requests-response-class.ts +49 -0
  163. package/models/list-payout-methods-response-class.ts +49 -0
  164. package/models/list-refunds-response-class.ts +18 -6
  165. package/models/payment-receipt-class.ts +110 -0
  166. package/models/payment-request-class.ts +165 -0
  167. package/models/payout-method-class.ts +127 -0
  168. package/models/tenant-bank-account-class-without-expand-properties.ts +18 -0
  169. package/models/tenant-bank-account-class.ts +18 -0
  170. package/models/tenant-bank-account-entity.ts +18 -0
  171. package/models/update-bank-order-request-dto.ts +3 -3
  172. package/models/update-billing-address-request-dto.ts +72 -0
  173. package/models/update-billing-address-response-class.ts +31 -0
  174. package/models/update-payment-receipt-response-class.ts +31 -0
  175. package/models/update-payment-request-request-dto.ts +48 -0
  176. package/models/update-payment-request-response-class.ts +31 -0
  177. package/models/update-tenant-bank-account-rest-request-dto.ts +18 -0
  178. package/models/validate-iban-request-dto.ts +30 -0
  179. package/models/validate-iban-response-class.ts +37 -0
  180. package/package.json +3 -3
@@ -0,0 +1,794 @@
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 { CreatePayoutMethodByBankAccountRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreatePayoutMethodRequestDto } from '../models';
27
+ // @ts-ignore
28
+ import { CreatePayoutMethodResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { GetPayoutMethodResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { ListPayoutMethodsResponseClass } from '../models';
33
+ // URLSearchParams not necessarily used
34
+ // @ts-ignore
35
+ import { URL, URLSearchParams } from 'url';
36
+ const FormData = require('form-data');
37
+ /**
38
+ * PayoutMethodsApi - axios parameter creator
39
+ * @export
40
+ */
41
+ export const PayoutMethodsApiAxiosParamCreator = function (configuration?: Configuration) {
42
+ return {
43
+ /**
44
+ * Activates a payout method and deactivates the currently active payout method for the same partner **Required Permissions** \"payment-management.payments.update\"
45
+ * @summary Create the Payout Method Activation
46
+ * @param {string} code Unique identifier for the object.
47
+ * @param {string} [authorization] Bearer Token
48
+ * @param {*} [options] Override http request option.
49
+ * @throws {RequiredError}
50
+ */
51
+ activatePayoutMethod: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
52
+ // verify required parameter 'code' is not null or undefined
53
+ assertParamExists('activatePayoutMethod', 'code', code)
54
+ const localVarPath = `/paymentservice/v1/payout-methods/{code}/activate`
55
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
56
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
57
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
58
+ let baseOptions;
59
+ let baseAccessToken;
60
+ if (configuration) {
61
+ baseOptions = configuration.baseOptions;
62
+ baseAccessToken = configuration.accessToken;
63
+ }
64
+
65
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
66
+ const localVarHeaderParameter = {} as any;
67
+ const localVarQueryParameter = {} as any;
68
+
69
+ // authentication bearer required
70
+ // http bearer authentication required
71
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
72
+
73
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
74
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
75
+ }
76
+
77
+
78
+
79
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
80
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
81
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
82
+
83
+ return {
84
+ url: toPathString(localVarUrlObj),
85
+ options: localVarRequestOptions,
86
+ };
87
+ },
88
+ /**
89
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
90
+ * @summary Create the Payout Method
91
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
92
+ * @param {string} [authorization] Bearer Token
93
+ * @param {*} [options] Override http request option.
94
+ * @throws {RequiredError}
95
+ */
96
+ createPayoutMethod: async (createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
97
+ // verify required parameter 'createPayoutMethodRequestDto' is not null or undefined
98
+ assertParamExists('createPayoutMethod', 'createPayoutMethodRequestDto', createPayoutMethodRequestDto)
99
+ const localVarPath = `/paymentservice/v1/payout-methods`;
100
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
101
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
102
+ let baseOptions;
103
+ let baseAccessToken;
104
+ if (configuration) {
105
+ baseOptions = configuration.baseOptions;
106
+ baseAccessToken = configuration.accessToken;
107
+ }
108
+
109
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
110
+ const localVarHeaderParameter = {} as any;
111
+ const localVarQueryParameter = {} as any;
112
+
113
+ // authentication bearer required
114
+ // http bearer authentication required
115
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
116
+
117
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
118
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
119
+ }
120
+
121
+
122
+
123
+ localVarHeaderParameter['Content-Type'] = 'application/json';
124
+
125
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
126
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
127
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
128
+ localVarRequestOptions.data = serializeDataIfNeeded(createPayoutMethodRequestDto, localVarRequestOptions, configuration)
129
+
130
+ return {
131
+ url: toPathString(localVarUrlObj),
132
+ options: localVarRequestOptions,
133
+ };
134
+ },
135
+ /**
136
+ * Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
137
+ * @summary Create the Payout Method
138
+ * @param {string} code
139
+ * @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
140
+ * @param {string} [authorization] Bearer Token
141
+ * @param {*} [options] Override http request option.
142
+ * @throws {RequiredError}
143
+ */
144
+ createPayoutMethodByBankAccount: async (code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
145
+ // verify required parameter 'code' is not null or undefined
146
+ assertParamExists('createPayoutMethodByBankAccount', 'code', code)
147
+ // verify required parameter 'createPayoutMethodByBankAccountRequestDto' is not null or undefined
148
+ assertParamExists('createPayoutMethodByBankAccount', 'createPayoutMethodByBankAccountRequestDto', createPayoutMethodByBankAccountRequestDto)
149
+ const localVarPath = `/paymentservice/v1/payout-methods/bank-account/{code}`
150
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
151
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
152
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
153
+ let baseOptions;
154
+ let baseAccessToken;
155
+ if (configuration) {
156
+ baseOptions = configuration.baseOptions;
157
+ baseAccessToken = configuration.accessToken;
158
+ }
159
+
160
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
161
+ const localVarHeaderParameter = {} as any;
162
+ const localVarQueryParameter = {} as any;
163
+
164
+ // authentication bearer required
165
+ // http bearer authentication required
166
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
167
+
168
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
169
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
170
+ }
171
+
172
+
173
+
174
+ localVarHeaderParameter['Content-Type'] = 'application/json';
175
+
176
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
177
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
178
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
179
+ localVarRequestOptions.data = serializeDataIfNeeded(createPayoutMethodByBankAccountRequestDto, localVarRequestOptions, configuration)
180
+
181
+ return {
182
+ url: toPathString(localVarUrlObj),
183
+ options: localVarRequestOptions,
184
+ };
185
+ },
186
+ /**
187
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
188
+ * @summary Delete the Payout Method
189
+ * @param {string} code Unique identifier for the object.
190
+ * @param {string} [authorization] Bearer Token
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ deletePayoutMethod: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
195
+ // verify required parameter 'code' is not null or undefined
196
+ assertParamExists('deletePayoutMethod', 'code', code)
197
+ const localVarPath = `/paymentservice/v1/payout-methods/{code}`
198
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
199
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
200
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
201
+ let baseOptions;
202
+ let baseAccessToken;
203
+ if (configuration) {
204
+ baseOptions = configuration.baseOptions;
205
+ baseAccessToken = configuration.accessToken;
206
+ }
207
+
208
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
209
+ const localVarHeaderParameter = {} as any;
210
+ const localVarQueryParameter = {} as any;
211
+
212
+ // authentication bearer required
213
+ // http bearer authentication required
214
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
215
+
216
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
217
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
218
+ }
219
+
220
+
221
+
222
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
223
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
224
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
225
+
226
+ return {
227
+ url: toPathString(localVarUrlObj),
228
+ options: localVarRequestOptions,
229
+ };
230
+ },
231
+ /**
232
+ * 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\"
233
+ * @summary Retrieve the Payout Method
234
+ * @param {string} code
235
+ * @param {string} [authorization] Bearer Token
236
+ * @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;
237
+ * @param {*} [options] Override http request option.
238
+ * @throws {RequiredError}
239
+ */
240
+ getPayoutMethod: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
241
+ // verify required parameter 'code' is not null or undefined
242
+ assertParamExists('getPayoutMethod', 'code', code)
243
+ const localVarPath = `/paymentservice/v1/payout-methods/{code}`
244
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
245
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
246
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
247
+ let baseOptions;
248
+ let baseAccessToken;
249
+ if (configuration) {
250
+ baseOptions = configuration.baseOptions;
251
+ baseAccessToken = configuration.accessToken;
252
+ }
253
+
254
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
255
+ const localVarHeaderParameter = {} as any;
256
+ const localVarQueryParameter = {} as any;
257
+
258
+ // authentication bearer required
259
+ // http bearer authentication required
260
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
261
+
262
+ if (expand !== undefined) {
263
+ localVarQueryParameter['expand'] = expand;
264
+ }
265
+
266
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
267
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
268
+ }
269
+
270
+
271
+
272
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
273
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
274
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
275
+
276
+ return {
277
+ url: toPathString(localVarUrlObj),
278
+ options: localVarRequestOptions,
279
+ };
280
+ },
281
+ /**
282
+ * 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\"
283
+ * @summary List Payout Methods
284
+ * @param {string} [authorization] Bearer Token
285
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
286
+ * @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.
287
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
288
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode&lt;/i&gt;
289
+ * @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, accountHolder&lt;/i&gt;
290
+ * @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;
291
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
292
+ * @param {*} [options] Override http request option.
293
+ * @throws {RequiredError}
294
+ */
295
+ listPayoutMethods: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
296
+ const localVarPath = `/paymentservice/v1/payout-methods`;
297
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
298
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
299
+ let baseOptions;
300
+ let baseAccessToken;
301
+ if (configuration) {
302
+ baseOptions = configuration.baseOptions;
303
+ baseAccessToken = configuration.accessToken;
304
+ }
305
+
306
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
307
+ const localVarHeaderParameter = {} as any;
308
+ const localVarQueryParameter = {} as any;
309
+
310
+ // authentication bearer required
311
+ // http bearer authentication required
312
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
313
+
314
+ if (pageSize !== undefined) {
315
+ localVarQueryParameter['pageSize'] = pageSize;
316
+ }
317
+
318
+ if (pageToken !== undefined) {
319
+ localVarQueryParameter['pageToken'] = pageToken;
320
+ }
321
+
322
+ if (filter !== undefined) {
323
+ localVarQueryParameter['filter'] = filter;
324
+ }
325
+
326
+ if (search !== undefined) {
327
+ localVarQueryParameter['search'] = search;
328
+ }
329
+
330
+ if (order !== undefined) {
331
+ localVarQueryParameter['order'] = order;
332
+ }
333
+
334
+ if (expand !== undefined) {
335
+ localVarQueryParameter['expand'] = expand;
336
+ }
337
+
338
+ if (filters !== undefined) {
339
+ localVarQueryParameter['filters'] = filters;
340
+ }
341
+
342
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
343
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
344
+ }
345
+
346
+
347
+
348
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
349
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
350
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
351
+
352
+ return {
353
+ url: toPathString(localVarUrlObj),
354
+ options: localVarRequestOptions,
355
+ };
356
+ },
357
+ }
358
+ };
359
+
360
+ /**
361
+ * PayoutMethodsApi - functional programming interface
362
+ * @export
363
+ */
364
+ export const PayoutMethodsApiFp = function(configuration?: Configuration) {
365
+ const localVarAxiosParamCreator = PayoutMethodsApiAxiosParamCreator(configuration)
366
+ return {
367
+ /**
368
+ * Activates a payout method and deactivates the currently active payout method for the same partner **Required Permissions** \"payment-management.payments.update\"
369
+ * @summary Create the Payout Method Activation
370
+ * @param {string} code Unique identifier for the object.
371
+ * @param {string} [authorization] Bearer Token
372
+ * @param {*} [options] Override http request option.
373
+ * @throws {RequiredError}
374
+ */
375
+ async activatePayoutMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
376
+ const localVarAxiosArgs = await localVarAxiosParamCreator.activatePayoutMethod(code, authorization, options);
377
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
378
+ },
379
+ /**
380
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
381
+ * @summary Create the Payout Method
382
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
383
+ * @param {string} [authorization] Bearer Token
384
+ * @param {*} [options] Override http request option.
385
+ * @throws {RequiredError}
386
+ */
387
+ async createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePayoutMethodResponseClass>> {
388
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createPayoutMethod(createPayoutMethodRequestDto, authorization, options);
389
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
390
+ },
391
+ /**
392
+ * Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
393
+ * @summary Create the Payout Method
394
+ * @param {string} code
395
+ * @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
396
+ * @param {string} [authorization] Bearer Token
397
+ * @param {*} [options] Override http request option.
398
+ * @throws {RequiredError}
399
+ */
400
+ async createPayoutMethodByBankAccount(code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePayoutMethodResponseClass>> {
401
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createPayoutMethodByBankAccount(code, createPayoutMethodByBankAccountRequestDto, authorization, options);
402
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
403
+ },
404
+ /**
405
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
406
+ * @summary Delete the Payout Method
407
+ * @param {string} code Unique identifier for the object.
408
+ * @param {string} [authorization] Bearer Token
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ */
412
+ async deletePayoutMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
413
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deletePayoutMethod(code, authorization, options);
414
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
415
+ },
416
+ /**
417
+ * 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\"
418
+ * @summary Retrieve the Payout Method
419
+ * @param {string} code
420
+ * @param {string} [authorization] Bearer Token
421
+ * @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;
422
+ * @param {*} [options] Override http request option.
423
+ * @throws {RequiredError}
424
+ */
425
+ async getPayoutMethod(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayoutMethodResponseClass>> {
426
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPayoutMethod(code, authorization, expand, options);
427
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
428
+ },
429
+ /**
430
+ * 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\"
431
+ * @summary List Payout Methods
432
+ * @param {string} [authorization] Bearer Token
433
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
434
+ * @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.
435
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
436
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode&lt;/i&gt;
437
+ * @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, accountHolder&lt;/i&gt;
438
+ * @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;
439
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
440
+ * @param {*} [options] Override http request option.
441
+ * @throws {RequiredError}
442
+ */
443
+ 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>> {
444
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPayoutMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
445
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
446
+ },
447
+ }
448
+ };
449
+
450
+ /**
451
+ * PayoutMethodsApi - factory interface
452
+ * @export
453
+ */
454
+ export const PayoutMethodsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
455
+ const localVarFp = PayoutMethodsApiFp(configuration)
456
+ return {
457
+ /**
458
+ * Activates a payout method and deactivates the currently active payout method for the same partner **Required Permissions** \"payment-management.payments.update\"
459
+ * @summary Create the Payout Method Activation
460
+ * @param {string} code Unique identifier for the object.
461
+ * @param {string} [authorization] Bearer Token
462
+ * @param {*} [options] Override http request option.
463
+ * @throws {RequiredError}
464
+ */
465
+ activatePayoutMethod(code: string, authorization?: string, options?: any): AxiosPromise<object> {
466
+ return localVarFp.activatePayoutMethod(code, authorization, options).then((request) => request(axios, basePath));
467
+ },
468
+ /**
469
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
470
+ * @summary Create the Payout Method
471
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
472
+ * @param {string} [authorization] Bearer Token
473
+ * @param {*} [options] Override http request option.
474
+ * @throws {RequiredError}
475
+ */
476
+ createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePayoutMethodResponseClass> {
477
+ return localVarFp.createPayoutMethod(createPayoutMethodRequestDto, authorization, options).then((request) => request(axios, basePath));
478
+ },
479
+ /**
480
+ * Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
481
+ * @summary Create the Payout Method
482
+ * @param {string} code
483
+ * @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
484
+ * @param {string} [authorization] Bearer Token
485
+ * @param {*} [options] Override http request option.
486
+ * @throws {RequiredError}
487
+ */
488
+ createPayoutMethodByBankAccount(code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePayoutMethodResponseClass> {
489
+ return localVarFp.createPayoutMethodByBankAccount(code, createPayoutMethodByBankAccountRequestDto, authorization, options).then((request) => request(axios, basePath));
490
+ },
491
+ /**
492
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
493
+ * @summary Delete the Payout Method
494
+ * @param {string} code Unique identifier for the object.
495
+ * @param {string} [authorization] Bearer Token
496
+ * @param {*} [options] Override http request option.
497
+ * @throws {RequiredError}
498
+ */
499
+ deletePayoutMethod(code: string, authorization?: string, options?: any): AxiosPromise<object> {
500
+ return localVarFp.deletePayoutMethod(code, authorization, options).then((request) => request(axios, basePath));
501
+ },
502
+ /**
503
+ * 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\"
504
+ * @summary Retrieve the Payout Method
505
+ * @param {string} code
506
+ * @param {string} [authorization] Bearer Token
507
+ * @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;
508
+ * @param {*} [options] Override http request option.
509
+ * @throws {RequiredError}
510
+ */
511
+ getPayoutMethod(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPayoutMethodResponseClass> {
512
+ return localVarFp.getPayoutMethod(code, authorization, expand, options).then((request) => request(axios, basePath));
513
+ },
514
+ /**
515
+ * 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\"
516
+ * @summary List Payout Methods
517
+ * @param {string} [authorization] Bearer Token
518
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
519
+ * @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.
520
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
521
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode&lt;/i&gt;
522
+ * @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, accountHolder&lt;/i&gt;
523
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
524
+ * @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
525
+ * @param {*} [options] Override http request option.
526
+ * @throws {RequiredError}
527
+ */
528
+ listPayoutMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPayoutMethodsResponseClass> {
529
+ return localVarFp.listPayoutMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
530
+ },
531
+ };
532
+ };
533
+
534
+ /**
535
+ * Request parameters for activatePayoutMethod operation in PayoutMethodsApi.
536
+ * @export
537
+ * @interface PayoutMethodsApiActivatePayoutMethodRequest
538
+ */
539
+ export interface PayoutMethodsApiActivatePayoutMethodRequest {
540
+ /**
541
+ * Unique identifier for the object.
542
+ * @type {string}
543
+ * @memberof PayoutMethodsApiActivatePayoutMethod
544
+ */
545
+ readonly code: string
546
+
547
+ /**
548
+ * Bearer Token
549
+ * @type {string}
550
+ * @memberof PayoutMethodsApiActivatePayoutMethod
551
+ */
552
+ readonly authorization?: string
553
+ }
554
+
555
+ /**
556
+ * Request parameters for createPayoutMethod operation in PayoutMethodsApi.
557
+ * @export
558
+ * @interface PayoutMethodsApiCreatePayoutMethodRequest
559
+ */
560
+ export interface PayoutMethodsApiCreatePayoutMethodRequest {
561
+ /**
562
+ *
563
+ * @type {CreatePayoutMethodRequestDto}
564
+ * @memberof PayoutMethodsApiCreatePayoutMethod
565
+ */
566
+ readonly createPayoutMethodRequestDto: CreatePayoutMethodRequestDto
567
+
568
+ /**
569
+ * Bearer Token
570
+ * @type {string}
571
+ * @memberof PayoutMethodsApiCreatePayoutMethod
572
+ */
573
+ readonly authorization?: string
574
+ }
575
+
576
+ /**
577
+ * Request parameters for createPayoutMethodByBankAccount operation in PayoutMethodsApi.
578
+ * @export
579
+ * @interface PayoutMethodsApiCreatePayoutMethodByBankAccountRequest
580
+ */
581
+ export interface PayoutMethodsApiCreatePayoutMethodByBankAccountRequest {
582
+ /**
583
+ *
584
+ * @type {string}
585
+ * @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
586
+ */
587
+ readonly code: string
588
+
589
+ /**
590
+ *
591
+ * @type {CreatePayoutMethodByBankAccountRequestDto}
592
+ * @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
593
+ */
594
+ readonly createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto
595
+
596
+ /**
597
+ * Bearer Token
598
+ * @type {string}
599
+ * @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
600
+ */
601
+ readonly authorization?: string
602
+ }
603
+
604
+ /**
605
+ * Request parameters for deletePayoutMethod operation in PayoutMethodsApi.
606
+ * @export
607
+ * @interface PayoutMethodsApiDeletePayoutMethodRequest
608
+ */
609
+ export interface PayoutMethodsApiDeletePayoutMethodRequest {
610
+ /**
611
+ * Unique identifier for the object.
612
+ * @type {string}
613
+ * @memberof PayoutMethodsApiDeletePayoutMethod
614
+ */
615
+ readonly code: string
616
+
617
+ /**
618
+ * Bearer Token
619
+ * @type {string}
620
+ * @memberof PayoutMethodsApiDeletePayoutMethod
621
+ */
622
+ readonly authorization?: string
623
+ }
624
+
625
+ /**
626
+ * Request parameters for getPayoutMethod operation in PayoutMethodsApi.
627
+ * @export
628
+ * @interface PayoutMethodsApiGetPayoutMethodRequest
629
+ */
630
+ export interface PayoutMethodsApiGetPayoutMethodRequest {
631
+ /**
632
+ *
633
+ * @type {string}
634
+ * @memberof PayoutMethodsApiGetPayoutMethod
635
+ */
636
+ readonly code: string
637
+
638
+ /**
639
+ * Bearer Token
640
+ * @type {string}
641
+ * @memberof PayoutMethodsApiGetPayoutMethod
642
+ */
643
+ readonly authorization?: string
644
+
645
+ /**
646
+ * 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;
647
+ * @type {string}
648
+ * @memberof PayoutMethodsApiGetPayoutMethod
649
+ */
650
+ readonly expand?: string
651
+ }
652
+
653
+ /**
654
+ * Request parameters for listPayoutMethods operation in PayoutMethodsApi.
655
+ * @export
656
+ * @interface PayoutMethodsApiListPayoutMethodsRequest
657
+ */
658
+ export interface PayoutMethodsApiListPayoutMethodsRequest {
659
+ /**
660
+ * Bearer Token
661
+ * @type {string}
662
+ * @memberof PayoutMethodsApiListPayoutMethods
663
+ */
664
+ readonly authorization?: string
665
+
666
+ /**
667
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
668
+ * @type {number}
669
+ * @memberof PayoutMethodsApiListPayoutMethods
670
+ */
671
+ readonly pageSize?: number
672
+
673
+ /**
674
+ * 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.
675
+ * @type {string}
676
+ * @memberof PayoutMethodsApiListPayoutMethods
677
+ */
678
+ readonly pageToken?: string
679
+
680
+ /**
681
+ * 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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
682
+ * @type {string}
683
+ * @memberof PayoutMethodsApiListPayoutMethods
684
+ */
685
+ readonly filter?: string
686
+
687
+ /**
688
+ * 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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode&lt;/i&gt;
689
+ * @type {string}
690
+ * @memberof PayoutMethodsApiListPayoutMethods
691
+ */
692
+ readonly search?: string
693
+
694
+ /**
695
+ * 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, accountHolder&lt;/i&gt;
696
+ * @type {string}
697
+ * @memberof PayoutMethodsApiListPayoutMethods
698
+ */
699
+ readonly order?: string
700
+
701
+ /**
702
+ * 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;
703
+ * @type {string}
704
+ * @memberof PayoutMethodsApiListPayoutMethods
705
+ */
706
+ readonly expand?: string
707
+
708
+ /**
709
+ * 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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
710
+ * @type {string}
711
+ * @memberof PayoutMethodsApiListPayoutMethods
712
+ */
713
+ readonly filters?: string
714
+ }
715
+
716
+ /**
717
+ * PayoutMethodsApi - object-oriented interface
718
+ * @export
719
+ * @class PayoutMethodsApi
720
+ * @extends {BaseAPI}
721
+ */
722
+ export class PayoutMethodsApi extends BaseAPI {
723
+ /**
724
+ * Activates a payout method and deactivates the currently active payout method for the same partner **Required Permissions** \"payment-management.payments.update\"
725
+ * @summary Create the Payout Method Activation
726
+ * @param {PayoutMethodsApiActivatePayoutMethodRequest} requestParameters Request parameters.
727
+ * @param {*} [options] Override http request option.
728
+ * @throws {RequiredError}
729
+ * @memberof PayoutMethodsApi
730
+ */
731
+ public activatePayoutMethod(requestParameters: PayoutMethodsApiActivatePayoutMethodRequest, options?: AxiosRequestConfig) {
732
+ return PayoutMethodsApiFp(this.configuration).activatePayoutMethod(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
733
+ }
734
+
735
+ /**
736
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
737
+ * @summary Create the Payout Method
738
+ * @param {PayoutMethodsApiCreatePayoutMethodRequest} requestParameters Request parameters.
739
+ * @param {*} [options] Override http request option.
740
+ * @throws {RequiredError}
741
+ * @memberof PayoutMethodsApi
742
+ */
743
+ public createPayoutMethod(requestParameters: PayoutMethodsApiCreatePayoutMethodRequest, options?: AxiosRequestConfig) {
744
+ return PayoutMethodsApiFp(this.configuration).createPayoutMethod(requestParameters.createPayoutMethodRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
745
+ }
746
+
747
+ /**
748
+ * Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
749
+ * @summary Create the Payout Method
750
+ * @param {PayoutMethodsApiCreatePayoutMethodByBankAccountRequest} requestParameters Request parameters.
751
+ * @param {*} [options] Override http request option.
752
+ * @throws {RequiredError}
753
+ * @memberof PayoutMethodsApi
754
+ */
755
+ public createPayoutMethodByBankAccount(requestParameters: PayoutMethodsApiCreatePayoutMethodByBankAccountRequest, options?: AxiosRequestConfig) {
756
+ return PayoutMethodsApiFp(this.configuration).createPayoutMethodByBankAccount(requestParameters.code, requestParameters.createPayoutMethodByBankAccountRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
757
+ }
758
+
759
+ /**
760
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
761
+ * @summary Delete the Payout Method
762
+ * @param {PayoutMethodsApiDeletePayoutMethodRequest} requestParameters Request parameters.
763
+ * @param {*} [options] Override http request option.
764
+ * @throws {RequiredError}
765
+ * @memberof PayoutMethodsApi
766
+ */
767
+ public deletePayoutMethod(requestParameters: PayoutMethodsApiDeletePayoutMethodRequest, options?: AxiosRequestConfig) {
768
+ return PayoutMethodsApiFp(this.configuration).deletePayoutMethod(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
769
+ }
770
+
771
+ /**
772
+ * 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\"
773
+ * @summary Retrieve the Payout Method
774
+ * @param {PayoutMethodsApiGetPayoutMethodRequest} requestParameters Request parameters.
775
+ * @param {*} [options] Override http request option.
776
+ * @throws {RequiredError}
777
+ * @memberof PayoutMethodsApi
778
+ */
779
+ public getPayoutMethod(requestParameters: PayoutMethodsApiGetPayoutMethodRequest, options?: AxiosRequestConfig) {
780
+ return PayoutMethodsApiFp(this.configuration).getPayoutMethod(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
781
+ }
782
+
783
+ /**
784
+ * 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\"
785
+ * @summary List Payout Methods
786
+ * @param {PayoutMethodsApiListPayoutMethodsRequest} requestParameters Request parameters.
787
+ * @param {*} [options] Override http request option.
788
+ * @throws {RequiredError}
789
+ * @memberof PayoutMethodsApi
790
+ */
791
+ public listPayoutMethods(requestParameters: PayoutMethodsApiListPayoutMethodsRequest = {}, options?: AxiosRequestConfig) {
792
+ 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));
793
+ }
794
+ }