@emilgroup/payment-sdk 1.14.1-beta.57 → 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.
- package/.openapi-generator/FILES +6 -0
- package/README.md +2 -2
- package/api/payout-methods-api.ts +672 -0
- package/api.ts +2 -0
- package/dist/api/payout-methods-api.d.ts +382 -0
- package/dist/api/payout-methods-api.js +635 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/create-billing-address-request-dto.d.ts +1 -7
- package/dist/models/create-payout-method-request-dto.d.ts +60 -0
- package/dist/models/create-payout-method-request-dto.js +15 -0
- package/dist/models/create-payout-method-response-class.d.ts +25 -0
- package/dist/models/create-payout-method-response-class.js +15 -0
- package/dist/models/get-payout-method-response-class.d.ts +25 -0
- package/dist/models/get-payout-method-response-class.js +15 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/models/list-payout-methods-response-class.d.ts +43 -0
- package/dist/models/list-payout-methods-response-class.js +15 -0
- package/dist/models/payout-method-class.d.ts +115 -0
- package/dist/models/payout-method-class.js +15 -0
- package/dist/models/update-billing-address-request-dto.d.ts +1 -7
- package/models/create-billing-address-request-dto.ts +1 -7
- package/models/create-payout-method-request-dto.ts +66 -0
- package/models/create-payout-method-response-class.ts +31 -0
- package/models/get-payout-method-response-class.ts +31 -0
- package/models/index.ts +5 -0
- package/models/list-payout-methods-response-class.ts +49 -0
- package/models/payout-method-class.ts +121 -0
- package/models/update-billing-address-request-dto.ts +1 -7
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -31,6 +31,7 @@ import { PaymentMethodsApi } from './api';
|
|
|
31
31
|
import { PaymentRemindersApi } from './api';
|
|
32
32
|
import { PaymentSetupApi } from './api';
|
|
33
33
|
import { PaymentsApi } from './api';
|
|
34
|
+
import { PayoutMethodsApi } from './api';
|
|
34
35
|
import { PolicyPaymentMethodsApi } from './api';
|
|
35
36
|
import { RefundsApi } from './api';
|
|
36
37
|
import { TenantBankAccountApi } from './api';
|
|
@@ -48,6 +49,7 @@ export * from './api/payment-methods-api';
|
|
|
48
49
|
export * from './api/payment-reminders-api';
|
|
49
50
|
export * from './api/payment-setup-api';
|
|
50
51
|
export * from './api/payments-api';
|
|
52
|
+
export * from './api/payout-methods-api';
|
|
51
53
|
export * from './api/policy-payment-methods-api';
|
|
52
54
|
export * from './api/refunds-api';
|
|
53
55
|
export * from './api/tenant-bank-account-api';
|
|
@@ -0,0 +1,382 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Emil Payment Service
|
|
3
|
+
* This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePayoutMethodRequestDto } from '../models';
|
|
16
|
+
import { CreatePayoutMethodResponseClass } from '../models';
|
|
17
|
+
import { GetPayoutMethodResponseClass } from '../models';
|
|
18
|
+
import { ListPayoutMethodsResponseClass } from '../models';
|
|
19
|
+
/**
|
|
20
|
+
* PayoutMethodsApi - axios parameter creator
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
export declare const PayoutMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
|
+
/**
|
|
25
|
+
* Activates a payout method **Required Permissions** \"payment-management.payments.create\"
|
|
26
|
+
* @summary Create the Payout Method Activation
|
|
27
|
+
* @param {string} code
|
|
28
|
+
* @param {string} [authorization] Bearer Token
|
|
29
|
+
* @param {*} [options] Override http request option.
|
|
30
|
+
* @throws {RequiredError}
|
|
31
|
+
*/
|
|
32
|
+
activatePayoutMethod: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
|
+
/**
|
|
34
|
+
* Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
|
|
35
|
+
* @summary Create the Payout Method
|
|
36
|
+
* @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
|
|
37
|
+
* @param {string} [authorization] Bearer Token
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
createPayoutMethod: (createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
|
+
/**
|
|
43
|
+
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
44
|
+
* @summary Delete the Payout Method
|
|
45
|
+
* @param {string} code Unique identifier for the object.
|
|
46
|
+
* @param {string} [authorization] Bearer Token
|
|
47
|
+
* @param {*} [options] Override http request option.
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
deletePayoutMethod: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
|
+
/**
|
|
52
|
+
* 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\"
|
|
53
|
+
* @summary Retrieve the Payout Method
|
|
54
|
+
* @param {string} code
|
|
55
|
+
* @param {string} [authorization] Bearer Token
|
|
56
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: billingAddress<i>
|
|
57
|
+
* @param {*} [options] Override http request option.
|
|
58
|
+
* @throws {RequiredError}
|
|
59
|
+
*/
|
|
60
|
+
getPayoutMethod: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
|
+
/**
|
|
62
|
+
* 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\"
|
|
63
|
+
* @summary List Payout Methods
|
|
64
|
+
* @param {string} [authorization] Bearer Token
|
|
65
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
66
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
67
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt</i>
|
|
68
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: firstName, lastName, iban, bankName, accountCode, partnerCode</i>
|
|
69
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, isActive, createdAt, updatedAt</i>
|
|
70
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: billingAddress<i>
|
|
71
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt</i>
|
|
72
|
+
* @param {*} [options] Override http request option.
|
|
73
|
+
* @throws {RequiredError}
|
|
74
|
+
*/
|
|
75
|
+
listPayoutMethods: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* PayoutMethodsApi - functional programming interface
|
|
79
|
+
* @export
|
|
80
|
+
*/
|
|
81
|
+
export declare const PayoutMethodsApiFp: (configuration?: Configuration) => {
|
|
82
|
+
/**
|
|
83
|
+
* Activates a payout method **Required Permissions** \"payment-management.payments.create\"
|
|
84
|
+
* @summary Create the Payout Method Activation
|
|
85
|
+
* @param {string} code
|
|
86
|
+
* @param {string} [authorization] Bearer Token
|
|
87
|
+
* @param {*} [options] Override http request option.
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
activatePayoutMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
91
|
+
/**
|
|
92
|
+
* Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
|
|
93
|
+
* @summary Create the Payout Method
|
|
94
|
+
* @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
|
|
95
|
+
* @param {string} [authorization] Bearer Token
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePayoutMethodResponseClass>>;
|
|
100
|
+
/**
|
|
101
|
+
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
102
|
+
* @summary Delete the Payout Method
|
|
103
|
+
* @param {string} code Unique identifier for the object.
|
|
104
|
+
* @param {string} [authorization] Bearer Token
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
deletePayoutMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
109
|
+
/**
|
|
110
|
+
* 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\"
|
|
111
|
+
* @summary Retrieve the Payout Method
|
|
112
|
+
* @param {string} code
|
|
113
|
+
* @param {string} [authorization] Bearer Token
|
|
114
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: billingAddress<i>
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
getPayoutMethod(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayoutMethodResponseClass>>;
|
|
119
|
+
/**
|
|
120
|
+
* 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\"
|
|
121
|
+
* @summary List Payout Methods
|
|
122
|
+
* @param {string} [authorization] Bearer Token
|
|
123
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
124
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
125
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt</i>
|
|
126
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: firstName, lastName, iban, bankName, accountCode, partnerCode</i>
|
|
127
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, isActive, createdAt, updatedAt</i>
|
|
128
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: billingAddress<i>
|
|
129
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt</i>
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
*/
|
|
133
|
+
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>>;
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* PayoutMethodsApi - factory interface
|
|
137
|
+
* @export
|
|
138
|
+
*/
|
|
139
|
+
export declare const PayoutMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
140
|
+
/**
|
|
141
|
+
* Activates a payout method **Required Permissions** \"payment-management.payments.create\"
|
|
142
|
+
* @summary Create the Payout Method Activation
|
|
143
|
+
* @param {string} code
|
|
144
|
+
* @param {string} [authorization] Bearer Token
|
|
145
|
+
* @param {*} [options] Override http request option.
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
activatePayoutMethod(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
149
|
+
/**
|
|
150
|
+
* Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
|
|
151
|
+
* @summary Create the Payout Method
|
|
152
|
+
* @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
|
|
153
|
+
* @param {string} [authorization] Bearer Token
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
*/
|
|
157
|
+
createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePayoutMethodResponseClass>;
|
|
158
|
+
/**
|
|
159
|
+
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
160
|
+
* @summary Delete the Payout Method
|
|
161
|
+
* @param {string} code Unique identifier for the object.
|
|
162
|
+
* @param {string} [authorization] Bearer Token
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
deletePayoutMethod(code: string, authorization?: string, options?: any): AxiosPromise<object>;
|
|
167
|
+
/**
|
|
168
|
+
* 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\"
|
|
169
|
+
* @summary Retrieve the Payout Method
|
|
170
|
+
* @param {string} code
|
|
171
|
+
* @param {string} [authorization] Bearer Token
|
|
172
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: billingAddress<i>
|
|
173
|
+
* @param {*} [options] Override http request option.
|
|
174
|
+
* @throws {RequiredError}
|
|
175
|
+
*/
|
|
176
|
+
getPayoutMethod(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPayoutMethodResponseClass>;
|
|
177
|
+
/**
|
|
178
|
+
* 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\"
|
|
179
|
+
* @summary List Payout Methods
|
|
180
|
+
* @param {string} [authorization] Bearer Token
|
|
181
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
182
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
183
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt</i>
|
|
184
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: firstName, lastName, iban, bankName, accountCode, partnerCode</i>
|
|
185
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, isActive, createdAt, updatedAt</i>
|
|
186
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: billingAddress<i>
|
|
187
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt</i>
|
|
188
|
+
* @param {*} [options] Override http request option.
|
|
189
|
+
* @throws {RequiredError}
|
|
190
|
+
*/
|
|
191
|
+
listPayoutMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPayoutMethodsResponseClass>;
|
|
192
|
+
};
|
|
193
|
+
/**
|
|
194
|
+
* Request parameters for activatePayoutMethod operation in PayoutMethodsApi.
|
|
195
|
+
* @export
|
|
196
|
+
* @interface PayoutMethodsApiActivatePayoutMethodRequest
|
|
197
|
+
*/
|
|
198
|
+
export interface PayoutMethodsApiActivatePayoutMethodRequest {
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @type {string}
|
|
202
|
+
* @memberof PayoutMethodsApiActivatePayoutMethod
|
|
203
|
+
*/
|
|
204
|
+
readonly code: string;
|
|
205
|
+
/**
|
|
206
|
+
* Bearer Token
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof PayoutMethodsApiActivatePayoutMethod
|
|
209
|
+
*/
|
|
210
|
+
readonly authorization?: string;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Request parameters for createPayoutMethod operation in PayoutMethodsApi.
|
|
214
|
+
* @export
|
|
215
|
+
* @interface PayoutMethodsApiCreatePayoutMethodRequest
|
|
216
|
+
*/
|
|
217
|
+
export interface PayoutMethodsApiCreatePayoutMethodRequest {
|
|
218
|
+
/**
|
|
219
|
+
*
|
|
220
|
+
* @type {CreatePayoutMethodRequestDto}
|
|
221
|
+
* @memberof PayoutMethodsApiCreatePayoutMethod
|
|
222
|
+
*/
|
|
223
|
+
readonly createPayoutMethodRequestDto: CreatePayoutMethodRequestDto;
|
|
224
|
+
/**
|
|
225
|
+
* Bearer Token
|
|
226
|
+
* @type {string}
|
|
227
|
+
* @memberof PayoutMethodsApiCreatePayoutMethod
|
|
228
|
+
*/
|
|
229
|
+
readonly authorization?: string;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Request parameters for deletePayoutMethod operation in PayoutMethodsApi.
|
|
233
|
+
* @export
|
|
234
|
+
* @interface PayoutMethodsApiDeletePayoutMethodRequest
|
|
235
|
+
*/
|
|
236
|
+
export interface PayoutMethodsApiDeletePayoutMethodRequest {
|
|
237
|
+
/**
|
|
238
|
+
* Unique identifier for the object.
|
|
239
|
+
* @type {string}
|
|
240
|
+
* @memberof PayoutMethodsApiDeletePayoutMethod
|
|
241
|
+
*/
|
|
242
|
+
readonly code: string;
|
|
243
|
+
/**
|
|
244
|
+
* Bearer Token
|
|
245
|
+
* @type {string}
|
|
246
|
+
* @memberof PayoutMethodsApiDeletePayoutMethod
|
|
247
|
+
*/
|
|
248
|
+
readonly authorization?: string;
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* Request parameters for getPayoutMethod operation in PayoutMethodsApi.
|
|
252
|
+
* @export
|
|
253
|
+
* @interface PayoutMethodsApiGetPayoutMethodRequest
|
|
254
|
+
*/
|
|
255
|
+
export interface PayoutMethodsApiGetPayoutMethodRequest {
|
|
256
|
+
/**
|
|
257
|
+
*
|
|
258
|
+
* @type {string}
|
|
259
|
+
* @memberof PayoutMethodsApiGetPayoutMethod
|
|
260
|
+
*/
|
|
261
|
+
readonly code: string;
|
|
262
|
+
/**
|
|
263
|
+
* Bearer Token
|
|
264
|
+
* @type {string}
|
|
265
|
+
* @memberof PayoutMethodsApiGetPayoutMethod
|
|
266
|
+
*/
|
|
267
|
+
readonly authorization?: string;
|
|
268
|
+
/**
|
|
269
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: billingAddress<i>
|
|
270
|
+
* @type {string}
|
|
271
|
+
* @memberof PayoutMethodsApiGetPayoutMethod
|
|
272
|
+
*/
|
|
273
|
+
readonly expand?: string;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* Request parameters for listPayoutMethods operation in PayoutMethodsApi.
|
|
277
|
+
* @export
|
|
278
|
+
* @interface PayoutMethodsApiListPayoutMethodsRequest
|
|
279
|
+
*/
|
|
280
|
+
export interface PayoutMethodsApiListPayoutMethodsRequest {
|
|
281
|
+
/**
|
|
282
|
+
* Bearer Token
|
|
283
|
+
* @type {string}
|
|
284
|
+
* @memberof PayoutMethodsApiListPayoutMethods
|
|
285
|
+
*/
|
|
286
|
+
readonly authorization?: string;
|
|
287
|
+
/**
|
|
288
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
289
|
+
* @type {number}
|
|
290
|
+
* @memberof PayoutMethodsApiListPayoutMethods
|
|
291
|
+
*/
|
|
292
|
+
readonly pageSize?: number;
|
|
293
|
+
/**
|
|
294
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
295
|
+
* @type {string}
|
|
296
|
+
* @memberof PayoutMethodsApiListPayoutMethods
|
|
297
|
+
*/
|
|
298
|
+
readonly pageToken?: string;
|
|
299
|
+
/**
|
|
300
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt</i>
|
|
301
|
+
* @type {string}
|
|
302
|
+
* @memberof PayoutMethodsApiListPayoutMethods
|
|
303
|
+
*/
|
|
304
|
+
readonly filter?: string;
|
|
305
|
+
/**
|
|
306
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: firstName, lastName, iban, bankName, accountCode, partnerCode</i>
|
|
307
|
+
* @type {string}
|
|
308
|
+
* @memberof PayoutMethodsApiListPayoutMethods
|
|
309
|
+
*/
|
|
310
|
+
readonly search?: string;
|
|
311
|
+
/**
|
|
312
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, isActive, createdAt, updatedAt</i>
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof PayoutMethodsApiListPayoutMethods
|
|
315
|
+
*/
|
|
316
|
+
readonly order?: string;
|
|
317
|
+
/**
|
|
318
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: billingAddress<i>
|
|
319
|
+
* @type {string}
|
|
320
|
+
* @memberof PayoutMethodsApiListPayoutMethods
|
|
321
|
+
*/
|
|
322
|
+
readonly expand?: string;
|
|
323
|
+
/**
|
|
324
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, firstName, lastName, iban, bankName, accountCode, partnerCode, isActive, billingAddressId, createdAt, updatedAt</i>
|
|
325
|
+
* @type {string}
|
|
326
|
+
* @memberof PayoutMethodsApiListPayoutMethods
|
|
327
|
+
*/
|
|
328
|
+
readonly filters?: string;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* PayoutMethodsApi - object-oriented interface
|
|
332
|
+
* @export
|
|
333
|
+
* @class PayoutMethodsApi
|
|
334
|
+
* @extends {BaseAPI}
|
|
335
|
+
*/
|
|
336
|
+
export declare class PayoutMethodsApi extends BaseAPI {
|
|
337
|
+
/**
|
|
338
|
+
* Activates a payout method **Required Permissions** \"payment-management.payments.create\"
|
|
339
|
+
* @summary Create the Payout Method Activation
|
|
340
|
+
* @param {PayoutMethodsApiActivatePayoutMethodRequest} requestParameters Request parameters.
|
|
341
|
+
* @param {*} [options] Override http request option.
|
|
342
|
+
* @throws {RequiredError}
|
|
343
|
+
* @memberof PayoutMethodsApi
|
|
344
|
+
*/
|
|
345
|
+
activatePayoutMethod(requestParameters: PayoutMethodsApiActivatePayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
346
|
+
/**
|
|
347
|
+
* Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
|
|
348
|
+
* @summary Create the Payout Method
|
|
349
|
+
* @param {PayoutMethodsApiCreatePayoutMethodRequest} requestParameters Request parameters.
|
|
350
|
+
* @param {*} [options] Override http request option.
|
|
351
|
+
* @throws {RequiredError}
|
|
352
|
+
* @memberof PayoutMethodsApi
|
|
353
|
+
*/
|
|
354
|
+
createPayoutMethod(requestParameters: PayoutMethodsApiCreatePayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePayoutMethodResponseClass, any, {}>>;
|
|
355
|
+
/**
|
|
356
|
+
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
357
|
+
* @summary Delete the Payout Method
|
|
358
|
+
* @param {PayoutMethodsApiDeletePayoutMethodRequest} requestParameters Request parameters.
|
|
359
|
+
* @param {*} [options] Override http request option.
|
|
360
|
+
* @throws {RequiredError}
|
|
361
|
+
* @memberof PayoutMethodsApi
|
|
362
|
+
*/
|
|
363
|
+
deletePayoutMethod(requestParameters: PayoutMethodsApiDeletePayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
364
|
+
/**
|
|
365
|
+
* 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\"
|
|
366
|
+
* @summary Retrieve the Payout Method
|
|
367
|
+
* @param {PayoutMethodsApiGetPayoutMethodRequest} requestParameters Request parameters.
|
|
368
|
+
* @param {*} [options] Override http request option.
|
|
369
|
+
* @throws {RequiredError}
|
|
370
|
+
* @memberof PayoutMethodsApi
|
|
371
|
+
*/
|
|
372
|
+
getPayoutMethod(requestParameters: PayoutMethodsApiGetPayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPayoutMethodResponseClass, any, {}>>;
|
|
373
|
+
/**
|
|
374
|
+
* 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\"
|
|
375
|
+
* @summary List Payout Methods
|
|
376
|
+
* @param {PayoutMethodsApiListPayoutMethodsRequest} requestParameters Request parameters.
|
|
377
|
+
* @param {*} [options] Override http request option.
|
|
378
|
+
* @throws {RequiredError}
|
|
379
|
+
* @memberof PayoutMethodsApi
|
|
380
|
+
*/
|
|
381
|
+
listPayoutMethods(requestParameters?: PayoutMethodsApiListPayoutMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPayoutMethodsResponseClass, any, {}>>;
|
|
382
|
+
}
|