@emilgroup/payment-sdk 1.13.1-beta.8 → 1.13.1-beta.81
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 +20 -1
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +177 -63
- package/api/payment-methods-api.ts +59 -17
- package/api/payment-reminders-api.ts +55 -13
- package/api/payments-api.ts +188 -21
- package/api/refunds-api.ts +45 -17
- package/api/tenant-bank-account-api.ts +45 -17
- package/api.ts +2 -0
- package/base.ts +52 -3
- package/dist/api/bank-accounts-api.d.ts +35 -8
- package/dist/api/bank-accounts-api.js +29 -11
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +642 -0
- package/dist/api/bank-transaction-api.d.ts +110 -46
- package/dist/api/bank-transaction-api.js +141 -44
- package/dist/api/payment-methods-api.d.ts +39 -12
- package/dist/api/payment-methods-api.js +32 -14
- package/dist/api/payment-reminders-api.d.ts +35 -8
- package/dist/api/payment-reminders-api.js +29 -11
- package/dist/api/payments-api.d.ts +112 -16
- package/dist/api/payments-api.js +141 -18
- package/dist/api/refunds-api.d.ts +28 -10
- package/dist/api/refunds-api.js +24 -12
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +10 -1
- package/dist/base.js +46 -2
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +30 -11
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +47 -14
- package/dist/models/bank-transaction-class.js +5 -0
- package/dist/models/bank-transaction-invoice-class.d.ts +54 -0
- package/dist/models/bank-transaction-invoice-class.js +15 -0
- package/dist/models/bank-transfer-dto.d.ts +25 -0
- package/dist/models/bank-transfer-dto.js +15 -0
- package/dist/models/billing-address-dto.d.ts +48 -0
- package/dist/models/billing-address-dto.js +15 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.js +3 -1
- package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +3 -1
- package/dist/models/create-bank-order-request-dto.d.ts +74 -0
- package/dist/models/create-bank-order-request-dto.js +28 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/create-payment-order-dto.d.ts +48 -0
- package/dist/models/create-payment-order-dto.js +15 -0
- package/dist/models/create-payment-order-request-dto.d.ts +48 -0
- package/dist/models/create-payment-order-request-dto.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-psp-payment-method-request-dto.d.ts +22 -1
- package/dist/models/create-psp-payment-method-request-dto.js +3 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/index.d.ts +19 -1
- package/dist/models/index.js +19 -1
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → invoice-allocation-dto.d.ts} +10 -4
- package/dist/models/invoice-allocation-dto.js +15 -0
- package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
- package/dist/models/invoice-match-suggestion-class.js +15 -0
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +4 -3
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-method-class.d.ts +6 -0
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
- package/dist/models/suggestion-generation-progress-class.js +22 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +33 -2
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
- package/dist/models/update-bank-order-request-dto.d.ts +62 -0
- package/dist/models/update-bank-order-request-dto.js +23 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +121 -0
- package/models/bank-transaction-class-without-expand-properties.ts +33 -11
- package/models/bank-transaction-class.ts +50 -14
- package/models/bank-transaction-invoice-class.ts +60 -0
- package/models/bank-transfer-dto.ts +31 -0
- package/models/billing-address-dto.ts +54 -0
- package/models/complete-adyen-payment-setup-request-dto.ts +3 -1
- package/models/complete-eis-payment-setup-request-dto.ts +42 -0
- package/models/complete-payment-setup-request-dto.ts +7 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +3 -1
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-order-dto.ts +54 -0
- package/models/create-payment-order-request-dto.ts +54 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-psp-payment-method-request-dto.ts +23 -2
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/financial-account-class.ts +120 -0
- package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/index.ts +19 -1
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-eis-payment-setup-request-dto.ts +42 -0
- package/models/initiate-payment-setup-request-dto.ts +3 -2
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/{unlink-bank-transaction-request-dto-rest.ts → invoice-allocation-dto.ts} +10 -4
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/link-bank-transaction-request-dto-rest.ts +4 -3
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-method-class.ts +6 -0
- package/models/payment-reminder-class.ts +7 -1
- package/models/refund-class.ts +7 -1
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/models/unlinked-bank-transaction-response-class.ts +36 -2
- package/models/update-bank-order-request-dto.ts +71 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
- /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → bank-order-class.js} +0 -0
package/api/payments-api.ts
CHANGED
|
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import { CreatePaymentOrderDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
24
26
|
import { CreatePaymentRequestDto } from '../models';
|
|
25
27
|
// @ts-ignore
|
|
26
28
|
import { CreatePaymentResponseClass } from '../models';
|
|
@@ -35,12 +37,13 @@ import { ListPaymentsResponseClass } from '../models';
|
|
|
35
37
|
export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
38
|
return {
|
|
37
39
|
/**
|
|
38
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
40
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
39
41
|
* @summary Create the payment
|
|
40
42
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
41
43
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
42
44
|
* @param {string} [authorization] Bearer Token
|
|
43
45
|
* @param {*} [options] Override http request option.
|
|
46
|
+
* @deprecated
|
|
44
47
|
* @throws {RequiredError}
|
|
45
48
|
*/
|
|
46
49
|
createPayment: async (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
@@ -88,6 +91,60 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
88
91
|
options: localVarRequestOptions,
|
|
89
92
|
};
|
|
90
93
|
},
|
|
94
|
+
/**
|
|
95
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
96
|
+
* @summary Create the payment
|
|
97
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
98
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
99
|
+
* @param {string} [authorization] Bearer Token
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
createPaymentOrder: async (idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
104
|
+
// verify required parameter 'idempotencyKey' is not null or undefined
|
|
105
|
+
assertParamExists('createPaymentOrder', 'idempotencyKey', idempotencyKey)
|
|
106
|
+
// verify required parameter 'createPaymentOrderDto' is not null or undefined
|
|
107
|
+
assertParamExists('createPaymentOrder', 'createPaymentOrderDto', createPaymentOrderDto)
|
|
108
|
+
const localVarPath = `/paymentservice/v1/payments/order`;
|
|
109
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
110
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
111
|
+
let baseOptions;
|
|
112
|
+
let baseAccessToken;
|
|
113
|
+
if (configuration) {
|
|
114
|
+
baseOptions = configuration.baseOptions;
|
|
115
|
+
baseAccessToken = configuration.accessToken;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
119
|
+
const localVarHeaderParameter = {} as any;
|
|
120
|
+
const localVarQueryParameter = {} as any;
|
|
121
|
+
|
|
122
|
+
// authentication bearer required
|
|
123
|
+
// http bearer authentication required
|
|
124
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
125
|
+
|
|
126
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
127
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
131
|
+
localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
137
|
+
|
|
138
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
139
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
140
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
141
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createPaymentOrderDto, localVarRequestOptions, configuration)
|
|
142
|
+
|
|
143
|
+
return {
|
|
144
|
+
url: toPathString(localVarUrlObj),
|
|
145
|
+
options: localVarRequestOptions,
|
|
146
|
+
};
|
|
147
|
+
},
|
|
91
148
|
/**
|
|
92
149
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
93
150
|
* @summary Retrieve the payment
|
|
@@ -142,14 +199,17 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
142
199
|
* Returns a list of payments you have previously created. The payments 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\"
|
|
143
200
|
* @summary List payments
|
|
144
201
|
* @param {string} [authorization] Bearer Token
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {string} [
|
|
202
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
203
|
+
* @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.
|
|
204
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
205
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
147
206
|
* @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, code, amount</i>
|
|
148
207
|
* @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: transactions<i>
|
|
208
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
149
209
|
* @param {*} [options] Override http request option.
|
|
150
210
|
* @throws {RequiredError}
|
|
151
211
|
*/
|
|
152
|
-
listPayments: async (authorization?: string, filter?: string,
|
|
212
|
+
listPayments: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
153
213
|
const localVarPath = `/paymentservice/v1/payments`;
|
|
154
214
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
155
215
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -168,12 +228,20 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
168
228
|
// http bearer authentication required
|
|
169
229
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
170
230
|
|
|
231
|
+
if (pageSize !== undefined) {
|
|
232
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
if (pageToken !== undefined) {
|
|
236
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
237
|
+
}
|
|
238
|
+
|
|
171
239
|
if (filter !== undefined) {
|
|
172
240
|
localVarQueryParameter['filter'] = filter;
|
|
173
241
|
}
|
|
174
242
|
|
|
175
|
-
if (
|
|
176
|
-
localVarQueryParameter['
|
|
243
|
+
if (search !== undefined) {
|
|
244
|
+
localVarQueryParameter['search'] = search;
|
|
177
245
|
}
|
|
178
246
|
|
|
179
247
|
if (order !== undefined) {
|
|
@@ -184,6 +252,10 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
184
252
|
localVarQueryParameter['expand'] = expand;
|
|
185
253
|
}
|
|
186
254
|
|
|
255
|
+
if (filters !== undefined) {
|
|
256
|
+
localVarQueryParameter['filters'] = filters;
|
|
257
|
+
}
|
|
258
|
+
|
|
187
259
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
188
260
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
189
261
|
}
|
|
@@ -210,18 +282,32 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
210
282
|
const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
|
|
211
283
|
return {
|
|
212
284
|
/**
|
|
213
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
285
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
214
286
|
* @summary Create the payment
|
|
215
287
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
216
288
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
217
289
|
* @param {string} [authorization] Bearer Token
|
|
218
290
|
* @param {*} [options] Override http request option.
|
|
291
|
+
* @deprecated
|
|
219
292
|
* @throws {RequiredError}
|
|
220
293
|
*/
|
|
221
294
|
async createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>> {
|
|
222
295
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options);
|
|
223
296
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
224
297
|
},
|
|
298
|
+
/**
|
|
299
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
300
|
+
* @summary Create the payment
|
|
301
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
302
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
303
|
+
* @param {string} [authorization] Bearer Token
|
|
304
|
+
* @param {*} [options] Override http request option.
|
|
305
|
+
* @throws {RequiredError}
|
|
306
|
+
*/
|
|
307
|
+
async createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>> {
|
|
308
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options);
|
|
309
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
310
|
+
},
|
|
225
311
|
/**
|
|
226
312
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
227
313
|
* @summary Retrieve the payment
|
|
@@ -239,15 +325,18 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
239
325
|
* Returns a list of payments you have previously created. The payments 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\"
|
|
240
326
|
* @summary List payments
|
|
241
327
|
* @param {string} [authorization] Bearer Token
|
|
242
|
-
* @param {
|
|
243
|
-
* @param {string} [
|
|
328
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
329
|
+
* @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.
|
|
330
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
331
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
244
332
|
* @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, code, amount</i>
|
|
245
333
|
* @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: transactions<i>
|
|
334
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
246
335
|
* @param {*} [options] Override http request option.
|
|
247
336
|
* @throws {RequiredError}
|
|
248
337
|
*/
|
|
249
|
-
async listPayments(authorization?: string, filter?: string,
|
|
250
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, filter,
|
|
338
|
+
async listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentsResponseClass>> {
|
|
339
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
251
340
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
252
341
|
},
|
|
253
342
|
}
|
|
@@ -261,17 +350,30 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
261
350
|
const localVarFp = PaymentsApiFp(configuration)
|
|
262
351
|
return {
|
|
263
352
|
/**
|
|
264
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
353
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
265
354
|
* @summary Create the payment
|
|
266
355
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
267
356
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
268
357
|
* @param {string} [authorization] Bearer Token
|
|
269
358
|
* @param {*} [options] Override http request option.
|
|
359
|
+
* @deprecated
|
|
270
360
|
* @throws {RequiredError}
|
|
271
361
|
*/
|
|
272
362
|
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass> {
|
|
273
363
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
274
364
|
},
|
|
365
|
+
/**
|
|
366
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
367
|
+
* @summary Create the payment
|
|
368
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
369
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
370
|
+
* @param {string} [authorization] Bearer Token
|
|
371
|
+
* @param {*} [options] Override http request option.
|
|
372
|
+
* @throws {RequiredError}
|
|
373
|
+
*/
|
|
374
|
+
createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass> {
|
|
375
|
+
return localVarFp.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options).then((request) => request(axios, basePath));
|
|
376
|
+
},
|
|
275
377
|
/**
|
|
276
378
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
277
379
|
* @summary Retrieve the payment
|
|
@@ -288,15 +390,18 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
288
390
|
* Returns a list of payments you have previously created. The payments 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\"
|
|
289
391
|
* @summary List payments
|
|
290
392
|
* @param {string} [authorization] Bearer Token
|
|
291
|
-
* @param {
|
|
292
|
-
* @param {string} [
|
|
393
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
394
|
+
* @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.
|
|
395
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
396
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
293
397
|
* @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, code, amount</i>
|
|
294
398
|
* @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: transactions<i>
|
|
399
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
295
400
|
* @param {*} [options] Override http request option.
|
|
296
401
|
* @throws {RequiredError}
|
|
297
402
|
*/
|
|
298
|
-
listPayments(authorization?: string, filter?: string,
|
|
299
|
-
return localVarFp.listPayments(authorization, filter,
|
|
403
|
+
listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentsResponseClass> {
|
|
404
|
+
return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
300
405
|
},
|
|
301
406
|
};
|
|
302
407
|
};
|
|
@@ -329,6 +434,34 @@ export interface PaymentsApiCreatePaymentRequest {
|
|
|
329
434
|
readonly authorization?: string
|
|
330
435
|
}
|
|
331
436
|
|
|
437
|
+
/**
|
|
438
|
+
* Request parameters for createPaymentOrder operation in PaymentsApi.
|
|
439
|
+
* @export
|
|
440
|
+
* @interface PaymentsApiCreatePaymentOrderRequest
|
|
441
|
+
*/
|
|
442
|
+
export interface PaymentsApiCreatePaymentOrderRequest {
|
|
443
|
+
/**
|
|
444
|
+
* Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
445
|
+
* @type {string}
|
|
446
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
447
|
+
*/
|
|
448
|
+
readonly idempotencyKey: string
|
|
449
|
+
|
|
450
|
+
/**
|
|
451
|
+
*
|
|
452
|
+
* @type {CreatePaymentOrderDto}
|
|
453
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
454
|
+
*/
|
|
455
|
+
readonly createPaymentOrderDto: CreatePaymentOrderDto
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* Bearer Token
|
|
459
|
+
* @type {string}
|
|
460
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
461
|
+
*/
|
|
462
|
+
readonly authorization?: string
|
|
463
|
+
}
|
|
464
|
+
|
|
332
465
|
/**
|
|
333
466
|
* Request parameters for getPayment operation in PaymentsApi.
|
|
334
467
|
* @export
|
|
@@ -371,18 +504,32 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
371
504
|
readonly authorization?: string
|
|
372
505
|
|
|
373
506
|
/**
|
|
374
|
-
*
|
|
507
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
508
|
+
* @type {number}
|
|
509
|
+
* @memberof PaymentsApiListPayments
|
|
510
|
+
*/
|
|
511
|
+
readonly pageSize?: number
|
|
512
|
+
|
|
513
|
+
/**
|
|
514
|
+
* 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.
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof PaymentsApiListPayments
|
|
517
|
+
*/
|
|
518
|
+
readonly pageToken?: string
|
|
519
|
+
|
|
520
|
+
/**
|
|
521
|
+
* 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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
375
522
|
* @type {string}
|
|
376
523
|
* @memberof PaymentsApiListPayments
|
|
377
524
|
*/
|
|
378
525
|
readonly filter?: string
|
|
379
526
|
|
|
380
527
|
/**
|
|
381
|
-
*
|
|
528
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
382
529
|
* @type {string}
|
|
383
530
|
* @memberof PaymentsApiListPayments
|
|
384
531
|
*/
|
|
385
|
-
readonly
|
|
532
|
+
readonly search?: string
|
|
386
533
|
|
|
387
534
|
/**
|
|
388
535
|
* 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, code, amount</i>
|
|
@@ -397,6 +544,13 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
397
544
|
* @memberof PaymentsApiListPayments
|
|
398
545
|
*/
|
|
399
546
|
readonly expand?: string
|
|
547
|
+
|
|
548
|
+
/**
|
|
549
|
+
* 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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
550
|
+
* @type {string}
|
|
551
|
+
* @memberof PaymentsApiListPayments
|
|
552
|
+
*/
|
|
553
|
+
readonly filters?: string
|
|
400
554
|
}
|
|
401
555
|
|
|
402
556
|
/**
|
|
@@ -407,10 +561,11 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
407
561
|
*/
|
|
408
562
|
export class PaymentsApi extends BaseAPI {
|
|
409
563
|
/**
|
|
410
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
564
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
411
565
|
* @summary Create the payment
|
|
412
566
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
413
567
|
* @param {*} [options] Override http request option.
|
|
568
|
+
* @deprecated
|
|
414
569
|
* @throws {RequiredError}
|
|
415
570
|
* @memberof PaymentsApi
|
|
416
571
|
*/
|
|
@@ -418,6 +573,18 @@ export class PaymentsApi extends BaseAPI {
|
|
|
418
573
|
return PaymentsApiFp(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
419
574
|
}
|
|
420
575
|
|
|
576
|
+
/**
|
|
577
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
578
|
+
* @summary Create the payment
|
|
579
|
+
* @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
|
|
580
|
+
* @param {*} [options] Override http request option.
|
|
581
|
+
* @throws {RequiredError}
|
|
582
|
+
* @memberof PaymentsApi
|
|
583
|
+
*/
|
|
584
|
+
public createPaymentOrder(requestParameters: PaymentsApiCreatePaymentOrderRequest, options?: AxiosRequestConfig) {
|
|
585
|
+
return PaymentsApiFp(this.configuration).createPaymentOrder(requestParameters.idempotencyKey, requestParameters.createPaymentOrderDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
586
|
+
}
|
|
587
|
+
|
|
421
588
|
/**
|
|
422
589
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
423
590
|
* @summary Retrieve the payment
|
|
@@ -439,6 +606,6 @@ export class PaymentsApi extends BaseAPI {
|
|
|
439
606
|
* @memberof PaymentsApi
|
|
440
607
|
*/
|
|
441
608
|
public listPayments(requestParameters: PaymentsApiListPaymentsRequest = {}, options?: AxiosRequestConfig) {
|
|
442
|
-
return PaymentsApiFp(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
609
|
+
return PaymentsApiFp(this.configuration).listPayments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
443
610
|
}
|
|
444
611
|
}
|
package/api/refunds-api.ts
CHANGED
|
@@ -135,15 +135,17 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
135
135
|
* 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\"
|
|
136
136
|
* @summary List refunds
|
|
137
137
|
* @param {string} [authorization] Bearer Token
|
|
138
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
139
|
+
* @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.
|
|
138
140
|
* @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>
|
|
139
|
-
* @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>
|
|
140
141
|
* @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>
|
|
141
142
|
* @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>
|
|
142
143
|
* @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>
|
|
144
|
+
* @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>
|
|
143
145
|
* @param {*} [options] Override http request option.
|
|
144
146
|
* @throws {RequiredError}
|
|
145
147
|
*/
|
|
146
|
-
listRefunds: async (authorization?: string,
|
|
148
|
+
listRefunds: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
147
149
|
const localVarPath = `/paymentservice/v1/refunds`;
|
|
148
150
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
149
151
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -162,12 +164,16 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
162
164
|
// http bearer authentication required
|
|
163
165
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
164
166
|
|
|
165
|
-
if (
|
|
166
|
-
localVarQueryParameter['
|
|
167
|
+
if (pageSize !== undefined) {
|
|
168
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
167
169
|
}
|
|
168
170
|
|
|
169
|
-
if (
|
|
170
|
-
localVarQueryParameter['
|
|
171
|
+
if (pageToken !== undefined) {
|
|
172
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
if (filter !== undefined) {
|
|
176
|
+
localVarQueryParameter['filter'] = filter;
|
|
171
177
|
}
|
|
172
178
|
|
|
173
179
|
if (search !== undefined) {
|
|
@@ -182,6 +188,10 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
182
188
|
localVarQueryParameter['expand'] = expand;
|
|
183
189
|
}
|
|
184
190
|
|
|
191
|
+
if (filters !== undefined) {
|
|
192
|
+
localVarQueryParameter['filters'] = filters;
|
|
193
|
+
}
|
|
194
|
+
|
|
185
195
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
186
196
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
187
197
|
}
|
|
@@ -236,16 +246,18 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
236
246
|
* 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\"
|
|
237
247
|
* @summary List refunds
|
|
238
248
|
* @param {string} [authorization] Bearer Token
|
|
249
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
250
|
+
* @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.
|
|
239
251
|
* @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>
|
|
240
|
-
* @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>
|
|
241
252
|
* @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>
|
|
242
253
|
* @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>
|
|
243
254
|
* @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>
|
|
255
|
+
* @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>
|
|
244
256
|
* @param {*} [options] Override http request option.
|
|
245
257
|
* @throws {RequiredError}
|
|
246
258
|
*/
|
|
247
|
-
async listRefunds(authorization?: string,
|
|
248
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization,
|
|
259
|
+
async listRefunds(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRefundsResponseClass>> {
|
|
260
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
249
261
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
250
262
|
},
|
|
251
263
|
}
|
|
@@ -285,16 +297,18 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
285
297
|
* 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\"
|
|
286
298
|
* @summary List refunds
|
|
287
299
|
* @param {string} [authorization] Bearer Token
|
|
300
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
301
|
+
* @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.
|
|
288
302
|
* @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>
|
|
289
|
-
* @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>
|
|
290
303
|
* @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>
|
|
291
304
|
* @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>
|
|
292
305
|
* @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>
|
|
306
|
+
* @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>
|
|
293
307
|
* @param {*} [options] Override http request option.
|
|
294
308
|
* @throws {RequiredError}
|
|
295
309
|
*/
|
|
296
|
-
listRefunds(authorization?: string,
|
|
297
|
-
return localVarFp.listRefunds(authorization,
|
|
310
|
+
listRefunds(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRefundsResponseClass> {
|
|
311
|
+
return localVarFp.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
298
312
|
},
|
|
299
313
|
};
|
|
300
314
|
};
|
|
@@ -362,18 +376,25 @@ export interface RefundsApiListRefundsRequest {
|
|
|
362
376
|
readonly authorization?: string
|
|
363
377
|
|
|
364
378
|
/**
|
|
365
|
-
*
|
|
379
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
380
|
+
* @type {number}
|
|
381
|
+
* @memberof RefundsApiListRefunds
|
|
382
|
+
*/
|
|
383
|
+
readonly pageSize?: number
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* 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.
|
|
366
387
|
* @type {string}
|
|
367
388
|
* @memberof RefundsApiListRefunds
|
|
368
389
|
*/
|
|
369
|
-
readonly
|
|
390
|
+
readonly pageToken?: string
|
|
370
391
|
|
|
371
392
|
/**
|
|
372
|
-
*
|
|
393
|
+
* 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>
|
|
373
394
|
* @type {string}
|
|
374
395
|
* @memberof RefundsApiListRefunds
|
|
375
396
|
*/
|
|
376
|
-
readonly
|
|
397
|
+
readonly filter?: string
|
|
377
398
|
|
|
378
399
|
/**
|
|
379
400
|
* 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>
|
|
@@ -395,6 +416,13 @@ export interface RefundsApiListRefundsRequest {
|
|
|
395
416
|
* @memberof RefundsApiListRefunds
|
|
396
417
|
*/
|
|
397
418
|
readonly expand?: string
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
* 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>
|
|
422
|
+
* @type {string}
|
|
423
|
+
* @memberof RefundsApiListRefunds
|
|
424
|
+
*/
|
|
425
|
+
readonly filters?: string
|
|
398
426
|
}
|
|
399
427
|
|
|
400
428
|
/**
|
|
@@ -437,6 +465,6 @@ export class RefundsApi extends BaseAPI {
|
|
|
437
465
|
* @memberof RefundsApi
|
|
438
466
|
*/
|
|
439
467
|
public listRefunds(requestParameters: RefundsApiListRefundsRequest = {}, options?: AxiosRequestConfig) {
|
|
440
|
-
return RefundsApiFp(this.configuration).listRefunds(requestParameters.authorization, requestParameters.
|
|
468
|
+
return RefundsApiFp(this.configuration).listRefunds(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
441
469
|
}
|
|
442
470
|
}
|