@emilgroup/payment-sdk 1.16.1-beta.7 → 1.16.1-beta.77
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 +12 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +16 -16
- package/api/bank-orders-api.ts +16 -16
- package/api/bank-transaction-api.ts +12 -12
- package/api/billing-addresses-api.ts +12 -12
- package/api/credit-allocation-api.ts +12 -12
- package/api/exceeding-credits-api.ts +12 -12
- package/api/ibanvalidator-api.ts +165 -0
- package/api/payment-methods-api.ts +12 -12
- package/api/payment-receipts-api.ts +676 -0
- package/api/payment-reminders-api.ts +12 -12
- package/api/payment-requests-api.ts +20 -20
- package/api/payments-api.ts +12 -12
- package/api/payout-methods-api.ts +138 -20
- package/api/refunds-api.ts +12 -12
- package/api/tenant-bank-account-api.ts +12 -12
- package/api/webhooks-api.ts +125 -14
- package/api.ts +4 -0
- package/base.ts +1 -0
- package/dist/api/bank-accounts-api.d.ts +16 -16
- package/dist/api/bank-accounts-api.js +13 -13
- package/dist/api/bank-orders-api.d.ts +16 -16
- package/dist/api/bank-orders-api.js +14 -14
- package/dist/api/bank-transaction-api.d.ts +12 -12
- package/dist/api/bank-transaction-api.js +10 -10
- package/dist/api/billing-addresses-api.d.ts +12 -12
- package/dist/api/billing-addresses-api.js +10 -10
- package/dist/api/credit-allocation-api.d.ts +12 -12
- package/dist/api/credit-allocation-api.js +10 -10
- package/dist/api/exceeding-credits-api.d.ts +12 -12
- package/dist/api/exceeding-credits-api.js +10 -10
- package/dist/api/ibanvalidator-api.d.ts +97 -0
- package/dist/api/ibanvalidator-api.js +224 -0
- package/dist/api/payment-methods-api.d.ts +12 -12
- package/dist/api/payment-methods-api.js +10 -10
- package/dist/api/payment-receipts-api.d.ts +383 -0
- package/dist/api/payment-receipts-api.js +637 -0
- package/dist/api/payment-reminders-api.d.ts +12 -12
- package/dist/api/payment-reminders-api.js +10 -10
- package/dist/api/payment-requests-api.d.ts +20 -20
- package/dist/api/payment-requests-api.js +15 -15
- package/dist/api/payments-api.d.ts +12 -12
- package/dist/api/payments-api.js +10 -10
- package/dist/api/payout-methods-api.d.ts +85 -20
- package/dist/api/payout-methods-api.js +115 -16
- package/dist/api/refunds-api.d.ts +12 -12
- package/dist/api/refunds-api.js +10 -10
- package/dist/api/tenant-bank-account-api.d.ts +12 -12
- package/dist/api/tenant-bank-account-api.js +10 -10
- package/dist/api/webhooks-api.d.ts +73 -9
- package/dist/api/webhooks-api.js +100 -11
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/bank-account-class-without-expand-properties.d.ts +6 -0
- package/dist/models/bank-account-class.d.ts +6 -0
- package/dist/models/bank-data-class.d.ts +36 -0
- package/dist/models/bank-data-class.js +15 -0
- package/dist/models/create-payment-receipt-request-dto.d.ts +65 -0
- package/dist/models/create-payment-receipt-request-dto.js +20 -0
- package/dist/models/create-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/create-payment-receipt-response-class.js +15 -0
- package/dist/models/create-payment-request-request-dto.d.ts +53 -10
- package/dist/models/create-payment-request-request-dto.js +8 -4
- package/dist/models/create-payout-method-by-bank-account-request-dto.d.ts +36 -0
- package/dist/models/create-payout-method-by-bank-account-request-dto.js +15 -0
- package/dist/models/create-payout-method-request-dto.d.ts +8 -2
- package/dist/models/credit-allocation-class.d.ts +6 -0
- package/dist/models/credit-allocation-entity.d.ts +6 -0
- package/dist/models/get-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/get-payment-receipt-response-class.js +15 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/list-payment-receipts-response-class.d.ts +43 -0
- package/dist/models/list-payment-receipts-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +1 -1
- package/dist/models/payment-class.d.ts +1 -1
- package/dist/models/payment-entity.d.ts +1 -1
- package/dist/models/payment-receipt-class.d.ts +101 -0
- package/dist/models/payment-receipt-class.js +20 -0
- package/dist/models/payment-request-class.d.ts +68 -12
- package/dist/models/payment-request-class.js +9 -5
- package/dist/models/payout-method-class.d.ts +6 -0
- package/dist/models/update-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/update-payment-receipt-response-class.js +15 -0
- package/dist/models/update-payment-request-request-dto.d.ts +2 -2
- package/dist/models/update-payment-request-request-dto.js +1 -1
- package/dist/models/validate-iban-request-dto.d.ts +24 -0
- package/dist/models/validate-iban-request-dto.js +15 -0
- package/dist/models/validate-iban-response-class.d.ts +31 -0
- package/dist/models/validate-iban-response-class.js +15 -0
- package/models/bank-account-class-without-expand-properties.ts +6 -0
- package/models/bank-account-class.ts +6 -0
- package/models/bank-data-class.ts +42 -0
- package/models/create-payment-receipt-request-dto.ts +74 -0
- package/models/create-payment-receipt-response-class.ts +31 -0
- package/models/create-payment-request-request-dto.ts +52 -10
- package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
- package/models/create-payout-method-request-dto.ts +8 -2
- package/models/credit-allocation-class.ts +6 -0
- package/models/credit-allocation-entity.ts +6 -0
- package/models/get-payment-receipt-response-class.ts +31 -0
- package/models/index.ts +10 -0
- package/models/list-payment-receipts-response-class.ts +49 -0
- package/models/payment-class-without-expand-properties.ts +1 -1
- package/models/payment-class.ts +1 -1
- package/models/payment-entity.ts +1 -1
- package/models/payment-receipt-class.ts +110 -0
- package/models/payment-request-class.ts +67 -12
- package/models/payout-method-class.ts +6 -0
- package/models/update-payment-receipt-response-class.ts +31 -0
- package/models/update-payment-request-request-dto.ts +2 -2
- package/models/validate-iban-request-dto.ts +30 -0
- package/models/validate-iban-response-class.ts +37 -0
- package/package.json +2 -2
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePayoutMethodByBankAccountRequestDto } from '../models';
|
|
15
16
|
import { CreatePayoutMethodRequestDto } from '../models';
|
|
16
17
|
import { CreatePayoutMethodResponseClass } from '../models';
|
|
17
18
|
import { GetPayoutMethodResponseClass } from '../models';
|
|
@@ -39,6 +40,16 @@ export declare const PayoutMethodsApiAxiosParamCreator: (configuration?: Configu
|
|
|
39
40
|
* @throws {RequiredError}
|
|
40
41
|
*/
|
|
41
42
|
createPayoutMethod: (createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
|
+
/**
|
|
44
|
+
* Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
|
|
45
|
+
* @summary Create the Payout Method
|
|
46
|
+
* @param {string} code
|
|
47
|
+
* @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
|
|
48
|
+
* @param {string} [authorization] Bearer Token
|
|
49
|
+
* @param {*} [options] Override http request option.
|
|
50
|
+
* @throws {RequiredError}
|
|
51
|
+
*/
|
|
52
|
+
createPayoutMethodByBankAccount: (code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
53
|
/**
|
|
43
54
|
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
44
55
|
* @summary Delete the Payout Method
|
|
@@ -59,16 +70,16 @@ export declare const PayoutMethodsApiAxiosParamCreator: (configuration?: Configu
|
|
|
59
70
|
*/
|
|
60
71
|
getPayoutMethod: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
72
|
/**
|
|
62
|
-
* Returns a list of Payout Methods you have previously created.
|
|
73
|
+
* 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
74
|
* @summary List Payout Methods
|
|
64
75
|
* @param {string} [authorization] Bearer Token
|
|
65
76
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
66
77
|
* @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.
|
|
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, billingAddressCode</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>
|
|
78
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
79
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode</i>
|
|
80
|
+
* @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, accountHolder</i>
|
|
70
81
|
* @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.
|
|
82
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
72
83
|
* @param {*} [options] Override http request option.
|
|
73
84
|
* @throws {RequiredError}
|
|
74
85
|
*/
|
|
@@ -97,6 +108,16 @@ export declare const PayoutMethodsApiFp: (configuration?: Configuration) => {
|
|
|
97
108
|
* @throws {RequiredError}
|
|
98
109
|
*/
|
|
99
110
|
createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePayoutMethodResponseClass>>;
|
|
111
|
+
/**
|
|
112
|
+
* Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
|
|
113
|
+
* @summary Create the Payout Method
|
|
114
|
+
* @param {string} code
|
|
115
|
+
* @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
|
|
116
|
+
* @param {string} [authorization] Bearer Token
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
createPayoutMethodByBankAccount(code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePayoutMethodResponseClass>>;
|
|
100
121
|
/**
|
|
101
122
|
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
102
123
|
* @summary Delete the Payout Method
|
|
@@ -117,16 +138,16 @@ export declare const PayoutMethodsApiFp: (configuration?: Configuration) => {
|
|
|
117
138
|
*/
|
|
118
139
|
getPayoutMethod(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayoutMethodResponseClass>>;
|
|
119
140
|
/**
|
|
120
|
-
* Returns a list of Payout Methods you have previously created.
|
|
141
|
+
* 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
142
|
* @summary List Payout Methods
|
|
122
143
|
* @param {string} [authorization] Bearer Token
|
|
123
144
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
124
145
|
* @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.
|
|
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, billingAddressCode</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>
|
|
146
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
147
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode</i>
|
|
148
|
+
* @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, accountHolder</i>
|
|
128
149
|
* @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.
|
|
150
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
130
151
|
* @param {*} [options] Override http request option.
|
|
131
152
|
* @throws {RequiredError}
|
|
132
153
|
*/
|
|
@@ -155,6 +176,16 @@ export declare const PayoutMethodsApiFactory: (configuration?: Configuration, ba
|
|
|
155
176
|
* @throws {RequiredError}
|
|
156
177
|
*/
|
|
157
178
|
createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePayoutMethodResponseClass>;
|
|
179
|
+
/**
|
|
180
|
+
* Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
|
|
181
|
+
* @summary Create the Payout Method
|
|
182
|
+
* @param {string} code
|
|
183
|
+
* @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
|
|
184
|
+
* @param {string} [authorization] Bearer Token
|
|
185
|
+
* @param {*} [options] Override http request option.
|
|
186
|
+
* @throws {RequiredError}
|
|
187
|
+
*/
|
|
188
|
+
createPayoutMethodByBankAccount(code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePayoutMethodResponseClass>;
|
|
158
189
|
/**
|
|
159
190
|
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
160
191
|
* @summary Delete the Payout Method
|
|
@@ -175,16 +206,16 @@ export declare const PayoutMethodsApiFactory: (configuration?: Configuration, ba
|
|
|
175
206
|
*/
|
|
176
207
|
getPayoutMethod(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPayoutMethodResponseClass>;
|
|
177
208
|
/**
|
|
178
|
-
* Returns a list of Payout Methods you have previously created.
|
|
209
|
+
* 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
210
|
* @summary List Payout Methods
|
|
180
211
|
* @param {string} [authorization] Bearer Token
|
|
181
212
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
182
213
|
* @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.
|
|
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, billingAddressCode</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>
|
|
214
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
215
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode</i>
|
|
216
|
+
* @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, accountHolder</i>
|
|
186
217
|
* @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.
|
|
218
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
188
219
|
* @param {*} [options] Override http request option.
|
|
189
220
|
* @throws {RequiredError}
|
|
190
221
|
*/
|
|
@@ -228,6 +259,31 @@ export interface PayoutMethodsApiCreatePayoutMethodRequest {
|
|
|
228
259
|
*/
|
|
229
260
|
readonly authorization?: string;
|
|
230
261
|
}
|
|
262
|
+
/**
|
|
263
|
+
* Request parameters for createPayoutMethodByBankAccount operation in PayoutMethodsApi.
|
|
264
|
+
* @export
|
|
265
|
+
* @interface PayoutMethodsApiCreatePayoutMethodByBankAccountRequest
|
|
266
|
+
*/
|
|
267
|
+
export interface PayoutMethodsApiCreatePayoutMethodByBankAccountRequest {
|
|
268
|
+
/**
|
|
269
|
+
*
|
|
270
|
+
* @type {string}
|
|
271
|
+
* @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
|
|
272
|
+
*/
|
|
273
|
+
readonly code: string;
|
|
274
|
+
/**
|
|
275
|
+
*
|
|
276
|
+
* @type {CreatePayoutMethodByBankAccountRequestDto}
|
|
277
|
+
* @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
|
|
278
|
+
*/
|
|
279
|
+
readonly createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto;
|
|
280
|
+
/**
|
|
281
|
+
* Bearer Token
|
|
282
|
+
* @type {string}
|
|
283
|
+
* @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
|
|
284
|
+
*/
|
|
285
|
+
readonly authorization?: string;
|
|
286
|
+
}
|
|
231
287
|
/**
|
|
232
288
|
* Request parameters for deletePayoutMethod operation in PayoutMethodsApi.
|
|
233
289
|
* @export
|
|
@@ -297,19 +353,19 @@ export interface PayoutMethodsApiListPayoutMethodsRequest {
|
|
|
297
353
|
*/
|
|
298
354
|
readonly pageToken?: string;
|
|
299
355
|
/**
|
|
300
|
-
* Filter the response by one or multiple fields.
|
|
356
|
+
* 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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
301
357
|
* @type {string}
|
|
302
358
|
* @memberof PayoutMethodsApiListPayoutMethods
|
|
303
359
|
*/
|
|
304
360
|
readonly filter?: string;
|
|
305
361
|
/**
|
|
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, billingAddressCode</i>
|
|
362
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode</i>
|
|
307
363
|
* @type {string}
|
|
308
364
|
* @memberof PayoutMethodsApiListPayoutMethods
|
|
309
365
|
*/
|
|
310
366
|
readonly search?: string;
|
|
311
367
|
/**
|
|
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>
|
|
368
|
+
* 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, accountHolder</i>
|
|
313
369
|
* @type {string}
|
|
314
370
|
* @memberof PayoutMethodsApiListPayoutMethods
|
|
315
371
|
*/
|
|
@@ -321,7 +377,7 @@ export interface PayoutMethodsApiListPayoutMethodsRequest {
|
|
|
321
377
|
*/
|
|
322
378
|
readonly expand?: string;
|
|
323
379
|
/**
|
|
324
|
-
* Filters the response by one or multiple fields.
|
|
380
|
+
* 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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
325
381
|
* @type {string}
|
|
326
382
|
* @memberof PayoutMethodsApiListPayoutMethods
|
|
327
383
|
*/
|
|
@@ -352,6 +408,15 @@ export declare class PayoutMethodsApi extends BaseAPI {
|
|
|
352
408
|
* @memberof PayoutMethodsApi
|
|
353
409
|
*/
|
|
354
410
|
createPayoutMethod(requestParameters: PayoutMethodsApiCreatePayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePayoutMethodResponseClass, any, {}>>;
|
|
411
|
+
/**
|
|
412
|
+
* Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
|
|
413
|
+
* @summary Create the Payout Method
|
|
414
|
+
* @param {PayoutMethodsApiCreatePayoutMethodByBankAccountRequest} requestParameters Request parameters.
|
|
415
|
+
* @param {*} [options] Override http request option.
|
|
416
|
+
* @throws {RequiredError}
|
|
417
|
+
* @memberof PayoutMethodsApi
|
|
418
|
+
*/
|
|
419
|
+
createPayoutMethodByBankAccount(requestParameters: PayoutMethodsApiCreatePayoutMethodByBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePayoutMethodResponseClass, any, {}>>;
|
|
355
420
|
/**
|
|
356
421
|
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
357
422
|
* @summary Delete the Payout Method
|
|
@@ -371,7 +436,7 @@ export declare class PayoutMethodsApi extends BaseAPI {
|
|
|
371
436
|
*/
|
|
372
437
|
getPayoutMethod(requestParameters: PayoutMethodsApiGetPayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPayoutMethodResponseClass, any, {}>>;
|
|
373
438
|
/**
|
|
374
|
-
* Returns a list of Payout Methods you have previously created.
|
|
439
|
+
* 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
440
|
* @summary List Payout Methods
|
|
376
441
|
* @param {PayoutMethodsApiListPayoutMethodsRequest} requestParameters Request parameters.
|
|
377
442
|
* @param {*} [options] Override http request option.
|
|
@@ -189,6 +189,59 @@ var PayoutMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
189
189
|
});
|
|
190
190
|
});
|
|
191
191
|
},
|
|
192
|
+
/**
|
|
193
|
+
* Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
|
|
194
|
+
* @summary Create the Payout Method
|
|
195
|
+
* @param {string} code
|
|
196
|
+
* @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
|
|
197
|
+
* @param {string} [authorization] Bearer Token
|
|
198
|
+
* @param {*} [options] Override http request option.
|
|
199
|
+
* @throws {RequiredError}
|
|
200
|
+
*/
|
|
201
|
+
createPayoutMethodByBankAccount: function (code, createPayoutMethodByBankAccountRequestDto, authorization, options) {
|
|
202
|
+
if (options === void 0) { options = {}; }
|
|
203
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
204
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
205
|
+
return __generator(this, function (_a) {
|
|
206
|
+
switch (_a.label) {
|
|
207
|
+
case 0:
|
|
208
|
+
// verify required parameter 'code' is not null or undefined
|
|
209
|
+
(0, common_1.assertParamExists)('createPayoutMethodByBankAccount', 'code', code);
|
|
210
|
+
// verify required parameter 'createPayoutMethodByBankAccountRequestDto' is not null or undefined
|
|
211
|
+
(0, common_1.assertParamExists)('createPayoutMethodByBankAccount', 'createPayoutMethodByBankAccountRequestDto', createPayoutMethodByBankAccountRequestDto);
|
|
212
|
+
localVarPath = "/paymentservice/v1/payout-methods/bank-account/{code}"
|
|
213
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
214
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
215
|
+
if (configuration) {
|
|
216
|
+
baseOptions = configuration.baseOptions;
|
|
217
|
+
baseAccessToken = configuration.accessToken;
|
|
218
|
+
}
|
|
219
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
220
|
+
localVarHeaderParameter = {};
|
|
221
|
+
localVarQueryParameter = {};
|
|
222
|
+
// authentication bearer required
|
|
223
|
+
// http bearer authentication required
|
|
224
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
225
|
+
case 1:
|
|
226
|
+
// authentication bearer required
|
|
227
|
+
// http bearer authentication required
|
|
228
|
+
_a.sent();
|
|
229
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
230
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
231
|
+
}
|
|
232
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
233
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
234
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
235
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
236
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPayoutMethodByBankAccountRequestDto, localVarRequestOptions, configuration);
|
|
237
|
+
return [2 /*return*/, {
|
|
238
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
239
|
+
options: localVarRequestOptions,
|
|
240
|
+
}];
|
|
241
|
+
}
|
|
242
|
+
});
|
|
243
|
+
});
|
|
244
|
+
},
|
|
192
245
|
/**
|
|
193
246
|
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
194
247
|
* @summary Delete the Payout Method
|
|
@@ -290,16 +343,16 @@ var PayoutMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
290
343
|
});
|
|
291
344
|
},
|
|
292
345
|
/**
|
|
293
|
-
* Returns a list of Payout Methods you have previously created.
|
|
346
|
+
* 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\"
|
|
294
347
|
* @summary List Payout Methods
|
|
295
348
|
* @param {string} [authorization] Bearer Token
|
|
296
349
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
297
350
|
* @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.
|
|
298
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
299
|
-
* @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, billingAddressCode</i>
|
|
300
|
-
* @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>
|
|
351
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
352
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode</i>
|
|
353
|
+
* @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, accountHolder</i>
|
|
301
354
|
* @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>
|
|
302
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
355
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
303
356
|
* @param {*} [options] Override http request option.
|
|
304
357
|
* @throws {RequiredError}
|
|
305
358
|
*/
|
|
@@ -413,6 +466,28 @@ var PayoutMethodsApiFp = function (configuration) {
|
|
|
413
466
|
});
|
|
414
467
|
});
|
|
415
468
|
},
|
|
469
|
+
/**
|
|
470
|
+
* Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
|
|
471
|
+
* @summary Create the Payout Method
|
|
472
|
+
* @param {string} code
|
|
473
|
+
* @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
|
|
474
|
+
* @param {string} [authorization] Bearer Token
|
|
475
|
+
* @param {*} [options] Override http request option.
|
|
476
|
+
* @throws {RequiredError}
|
|
477
|
+
*/
|
|
478
|
+
createPayoutMethodByBankAccount: function (code, createPayoutMethodByBankAccountRequestDto, authorization, options) {
|
|
479
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
480
|
+
var localVarAxiosArgs;
|
|
481
|
+
return __generator(this, function (_a) {
|
|
482
|
+
switch (_a.label) {
|
|
483
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createPayoutMethodByBankAccount(code, createPayoutMethodByBankAccountRequestDto, authorization, options)];
|
|
484
|
+
case 1:
|
|
485
|
+
localVarAxiosArgs = _a.sent();
|
|
486
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
487
|
+
}
|
|
488
|
+
});
|
|
489
|
+
});
|
|
490
|
+
},
|
|
416
491
|
/**
|
|
417
492
|
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
418
493
|
* @summary Delete the Payout Method
|
|
@@ -457,16 +532,16 @@ var PayoutMethodsApiFp = function (configuration) {
|
|
|
457
532
|
});
|
|
458
533
|
},
|
|
459
534
|
/**
|
|
460
|
-
* Returns a list of Payout Methods you have previously created.
|
|
535
|
+
* 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\"
|
|
461
536
|
* @summary List Payout Methods
|
|
462
537
|
* @param {string} [authorization] Bearer Token
|
|
463
538
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
464
539
|
* @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.
|
|
465
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
466
|
-
* @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, billingAddressCode</i>
|
|
467
|
-
* @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>
|
|
540
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
541
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode</i>
|
|
542
|
+
* @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, accountHolder</i>
|
|
468
543
|
* @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>
|
|
469
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
544
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
470
545
|
* @param {*} [options] Override http request option.
|
|
471
546
|
* @throws {RequiredError}
|
|
472
547
|
*/
|
|
@@ -515,6 +590,18 @@ var PayoutMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
515
590
|
createPayoutMethod: function (createPayoutMethodRequestDto, authorization, options) {
|
|
516
591
|
return localVarFp.createPayoutMethod(createPayoutMethodRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
517
592
|
},
|
|
593
|
+
/**
|
|
594
|
+
* Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
|
|
595
|
+
* @summary Create the Payout Method
|
|
596
|
+
* @param {string} code
|
|
597
|
+
* @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
|
|
598
|
+
* @param {string} [authorization] Bearer Token
|
|
599
|
+
* @param {*} [options] Override http request option.
|
|
600
|
+
* @throws {RequiredError}
|
|
601
|
+
*/
|
|
602
|
+
createPayoutMethodByBankAccount: function (code, createPayoutMethodByBankAccountRequestDto, authorization, options) {
|
|
603
|
+
return localVarFp.createPayoutMethodByBankAccount(code, createPayoutMethodByBankAccountRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
604
|
+
},
|
|
518
605
|
/**
|
|
519
606
|
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
520
607
|
* @summary Delete the Payout Method
|
|
@@ -539,16 +626,16 @@ var PayoutMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
539
626
|
return localVarFp.getPayoutMethod(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
540
627
|
},
|
|
541
628
|
/**
|
|
542
|
-
* Returns a list of Payout Methods you have previously created.
|
|
629
|
+
* 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\"
|
|
543
630
|
* @summary List Payout Methods
|
|
544
631
|
* @param {string} [authorization] Bearer Token
|
|
545
632
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
546
633
|
* @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.
|
|
547
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
548
|
-
* @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, billingAddressCode</i>
|
|
549
|
-
* @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>
|
|
634
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
635
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode</i>
|
|
636
|
+
* @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, accountHolder</i>
|
|
550
637
|
* @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>
|
|
551
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
638
|
+
* @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, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode</i>
|
|
552
639
|
* @param {*} [options] Override http request option.
|
|
553
640
|
* @throws {RequiredError}
|
|
554
641
|
*/
|
|
@@ -593,6 +680,18 @@ var PayoutMethodsApi = /** @class */ (function (_super) {
|
|
|
593
680
|
var _this = this;
|
|
594
681
|
return (0, exports.PayoutMethodsApiFp)(this.configuration).createPayoutMethod(requestParameters.createPayoutMethodRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
595
682
|
};
|
|
683
|
+
/**
|
|
684
|
+
* Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
|
|
685
|
+
* @summary Create the Payout Method
|
|
686
|
+
* @param {PayoutMethodsApiCreatePayoutMethodByBankAccountRequest} requestParameters Request parameters.
|
|
687
|
+
* @param {*} [options] Override http request option.
|
|
688
|
+
* @throws {RequiredError}
|
|
689
|
+
* @memberof PayoutMethodsApi
|
|
690
|
+
*/
|
|
691
|
+
PayoutMethodsApi.prototype.createPayoutMethodByBankAccount = function (requestParameters, options) {
|
|
692
|
+
var _this = this;
|
|
693
|
+
return (0, exports.PayoutMethodsApiFp)(this.configuration).createPayoutMethodByBankAccount(requestParameters.code, requestParameters.createPayoutMethodByBankAccountRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
694
|
+
};
|
|
596
695
|
/**
|
|
597
696
|
* Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
|
|
598
697
|
* @summary Delete the Payout Method
|
|
@@ -618,7 +717,7 @@ var PayoutMethodsApi = /** @class */ (function (_super) {
|
|
|
618
717
|
return (0, exports.PayoutMethodsApiFp)(this.configuration).getPayoutMethod(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
619
718
|
};
|
|
620
719
|
/**
|
|
621
|
-
* Returns a list of Payout Methods you have previously created.
|
|
720
|
+
* 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\"
|
|
622
721
|
* @summary List Payout Methods
|
|
623
722
|
* @param {PayoutMethodsApiListPayoutMethodsRequest} requestParameters Request parameters.
|
|
624
723
|
* @param {*} [options] Override http request option.
|
|
@@ -41,16 +41,16 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
41
41
|
*/
|
|
42
42
|
getRefund: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
43
|
/**
|
|
44
|
-
* Returns a list of refunds you have previously created.
|
|
44
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
45
45
|
* @summary List refunds
|
|
46
46
|
* @param {string} [authorization] Bearer Token
|
|
47
47
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
48
48
|
* @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.
|
|
49
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
49
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
50
50
|
* @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: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
51
51
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
|
|
52
52
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
53
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
53
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
54
54
|
* @param {*} [options] Override http request option.
|
|
55
55
|
* @throws {RequiredError}
|
|
56
56
|
*/
|
|
@@ -81,16 +81,16 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
|
|
|
81
81
|
*/
|
|
82
82
|
getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>>;
|
|
83
83
|
/**
|
|
84
|
-
* Returns a list of refunds you have previously created.
|
|
84
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
85
85
|
* @summary List refunds
|
|
86
86
|
* @param {string} [authorization] Bearer Token
|
|
87
87
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
88
88
|
* @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.
|
|
89
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
89
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
90
90
|
* @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: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
91
91
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
|
|
92
92
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
93
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
93
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
96
96
|
*/
|
|
@@ -121,16 +121,16 @@ export declare const RefundsApiFactory: (configuration?: Configuration, basePath
|
|
|
121
121
|
*/
|
|
122
122
|
getRefund(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetRefundResponseClass>;
|
|
123
123
|
/**
|
|
124
|
-
* Returns a list of refunds you have previously created.
|
|
124
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
125
125
|
* @summary List refunds
|
|
126
126
|
* @param {string} [authorization] Bearer Token
|
|
127
127
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
128
128
|
* @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.
|
|
129
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
129
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
130
130
|
* @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: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
131
131
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
|
|
132
132
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
133
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
133
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
134
134
|
* @param {*} [options] Override http request option.
|
|
135
135
|
* @throws {RequiredError}
|
|
136
136
|
*/
|
|
@@ -205,7 +205,7 @@ export interface RefundsApiListRefundsRequest {
|
|
|
205
205
|
*/
|
|
206
206
|
readonly pageToken?: string;
|
|
207
207
|
/**
|
|
208
|
-
* Filter the response by one or multiple fields.
|
|
208
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
209
209
|
* @type {string}
|
|
210
210
|
* @memberof RefundsApiListRefunds
|
|
211
211
|
*/
|
|
@@ -229,7 +229,7 @@ export interface RefundsApiListRefundsRequest {
|
|
|
229
229
|
*/
|
|
230
230
|
readonly expand?: string;
|
|
231
231
|
/**
|
|
232
|
-
* Filters the response by one or multiple fields.
|
|
232
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
233
233
|
* @type {string}
|
|
234
234
|
* @memberof RefundsApiListRefunds
|
|
235
235
|
*/
|
|
@@ -261,7 +261,7 @@ export declare class RefundsApi extends BaseAPI {
|
|
|
261
261
|
*/
|
|
262
262
|
getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRefundResponseClass, any, {}>>;
|
|
263
263
|
/**
|
|
264
|
-
* Returns a list of refunds you have previously created.
|
|
264
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
265
265
|
* @summary List refunds
|
|
266
266
|
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
267
267
|
* @param {*} [options] Override http request option.
|