@emilgroup/payment-sdk-node 1.21.1-beta.8 → 1.21.1-beta.80
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 +695 -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 +46 -4
- 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 +646 -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 +11 -2
- package/dist/base.js +42 -3
- 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';
|
|
@@ -39,12 +41,13 @@ const FormData = require('form-data');
|
|
|
39
41
|
export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
42
|
return {
|
|
41
43
|
/**
|
|
42
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
44
|
+
* 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\"
|
|
43
45
|
* @summary Create the payment
|
|
44
46
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
45
47
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
46
48
|
* @param {string} [authorization] Bearer Token
|
|
47
49
|
* @param {*} [options] Override http request option.
|
|
50
|
+
* @deprecated
|
|
48
51
|
* @throws {RequiredError}
|
|
49
52
|
*/
|
|
50
53
|
createPayment: async (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
@@ -92,6 +95,60 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
92
95
|
options: localVarRequestOptions,
|
|
93
96
|
};
|
|
94
97
|
},
|
|
98
|
+
/**
|
|
99
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
100
|
+
* @summary Create the payment
|
|
101
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
102
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
103
|
+
* @param {string} [authorization] Bearer Token
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
createPaymentOrder: async (idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
108
|
+
// verify required parameter 'idempotencyKey' is not null or undefined
|
|
109
|
+
assertParamExists('createPaymentOrder', 'idempotencyKey', idempotencyKey)
|
|
110
|
+
// verify required parameter 'createPaymentOrderDto' is not null or undefined
|
|
111
|
+
assertParamExists('createPaymentOrder', 'createPaymentOrderDto', createPaymentOrderDto)
|
|
112
|
+
const localVarPath = `/paymentservice/v1/payments/order`;
|
|
113
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
114
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
115
|
+
let baseOptions;
|
|
116
|
+
let baseAccessToken;
|
|
117
|
+
if (configuration) {
|
|
118
|
+
baseOptions = configuration.baseOptions;
|
|
119
|
+
baseAccessToken = configuration.accessToken;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
123
|
+
const localVarHeaderParameter = {} as any;
|
|
124
|
+
const localVarQueryParameter = {} as any;
|
|
125
|
+
|
|
126
|
+
// authentication bearer required
|
|
127
|
+
// http bearer authentication required
|
|
128
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
129
|
+
|
|
130
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
131
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
135
|
+
localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
141
|
+
|
|
142
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
143
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
144
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
145
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createPaymentOrderDto, localVarRequestOptions, configuration)
|
|
146
|
+
|
|
147
|
+
return {
|
|
148
|
+
url: toPathString(localVarUrlObj),
|
|
149
|
+
options: localVarRequestOptions,
|
|
150
|
+
};
|
|
151
|
+
},
|
|
95
152
|
/**
|
|
96
153
|
* 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\"
|
|
97
154
|
* @summary Retrieve the payment
|
|
@@ -146,14 +203,17 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
146
203
|
* 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\"
|
|
147
204
|
* @summary List payments
|
|
148
205
|
* @param {string} [authorization] Bearer Token
|
|
149
|
-
* @param {
|
|
150
|
-
* @param {string} [
|
|
206
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
207
|
+
* @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.
|
|
208
|
+
* @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>
|
|
209
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
151
210
|
* @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>
|
|
152
211
|
* @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>
|
|
212
|
+
* @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>
|
|
153
213
|
* @param {*} [options] Override http request option.
|
|
154
214
|
* @throws {RequiredError}
|
|
155
215
|
*/
|
|
156
|
-
listPayments: async (authorization?: string, filter?: string,
|
|
216
|
+
listPayments: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
157
217
|
const localVarPath = `/paymentservice/v1/payments`;
|
|
158
218
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
159
219
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -172,12 +232,20 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
172
232
|
// http bearer authentication required
|
|
173
233
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
174
234
|
|
|
235
|
+
if (pageSize !== undefined) {
|
|
236
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
if (pageToken !== undefined) {
|
|
240
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
241
|
+
}
|
|
242
|
+
|
|
175
243
|
if (filter !== undefined) {
|
|
176
244
|
localVarQueryParameter['filter'] = filter;
|
|
177
245
|
}
|
|
178
246
|
|
|
179
|
-
if (
|
|
180
|
-
localVarQueryParameter['
|
|
247
|
+
if (search !== undefined) {
|
|
248
|
+
localVarQueryParameter['search'] = search;
|
|
181
249
|
}
|
|
182
250
|
|
|
183
251
|
if (order !== undefined) {
|
|
@@ -188,6 +256,10 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
188
256
|
localVarQueryParameter['expand'] = expand;
|
|
189
257
|
}
|
|
190
258
|
|
|
259
|
+
if (filters !== undefined) {
|
|
260
|
+
localVarQueryParameter['filters'] = filters;
|
|
261
|
+
}
|
|
262
|
+
|
|
191
263
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
192
264
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
193
265
|
}
|
|
@@ -214,18 +286,32 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
214
286
|
const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
|
|
215
287
|
return {
|
|
216
288
|
/**
|
|
217
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
289
|
+
* 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\"
|
|
218
290
|
* @summary Create the payment
|
|
219
291
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
220
292
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
221
293
|
* @param {string} [authorization] Bearer Token
|
|
222
294
|
* @param {*} [options] Override http request option.
|
|
295
|
+
* @deprecated
|
|
223
296
|
* @throws {RequiredError}
|
|
224
297
|
*/
|
|
225
298
|
async createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>> {
|
|
226
299
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options);
|
|
227
300
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
228
301
|
},
|
|
302
|
+
/**
|
|
303
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
304
|
+
* @summary Create the payment
|
|
305
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
306
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
307
|
+
* @param {string} [authorization] Bearer Token
|
|
308
|
+
* @param {*} [options] Override http request option.
|
|
309
|
+
* @throws {RequiredError}
|
|
310
|
+
*/
|
|
311
|
+
async createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>> {
|
|
312
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options);
|
|
313
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
314
|
+
},
|
|
229
315
|
/**
|
|
230
316
|
* 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\"
|
|
231
317
|
* @summary Retrieve the payment
|
|
@@ -243,15 +329,18 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
243
329
|
* 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\"
|
|
244
330
|
* @summary List payments
|
|
245
331
|
* @param {string} [authorization] Bearer Token
|
|
246
|
-
* @param {
|
|
247
|
-
* @param {string} [
|
|
332
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
333
|
+
* @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.
|
|
334
|
+
* @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>
|
|
335
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
248
336
|
* @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>
|
|
249
337
|
* @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>
|
|
338
|
+
* @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>
|
|
250
339
|
* @param {*} [options] Override http request option.
|
|
251
340
|
* @throws {RequiredError}
|
|
252
341
|
*/
|
|
253
|
-
async listPayments(authorization?: string, filter?: string,
|
|
254
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, filter,
|
|
342
|
+
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>> {
|
|
343
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
255
344
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
256
345
|
},
|
|
257
346
|
}
|
|
@@ -265,17 +354,30 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
265
354
|
const localVarFp = PaymentsApiFp(configuration)
|
|
266
355
|
return {
|
|
267
356
|
/**
|
|
268
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
357
|
+
* 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\"
|
|
269
358
|
* @summary Create the payment
|
|
270
359
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
271
360
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
272
361
|
* @param {string} [authorization] Bearer Token
|
|
273
362
|
* @param {*} [options] Override http request option.
|
|
363
|
+
* @deprecated
|
|
274
364
|
* @throws {RequiredError}
|
|
275
365
|
*/
|
|
276
366
|
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass> {
|
|
277
367
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
278
368
|
},
|
|
369
|
+
/**
|
|
370
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
371
|
+
* @summary Create the payment
|
|
372
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
373
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
374
|
+
* @param {string} [authorization] Bearer Token
|
|
375
|
+
* @param {*} [options] Override http request option.
|
|
376
|
+
* @throws {RequiredError}
|
|
377
|
+
*/
|
|
378
|
+
createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass> {
|
|
379
|
+
return localVarFp.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options).then((request) => request(axios, basePath));
|
|
380
|
+
},
|
|
279
381
|
/**
|
|
280
382
|
* 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\"
|
|
281
383
|
* @summary Retrieve the payment
|
|
@@ -292,15 +394,18 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
292
394
|
* 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\"
|
|
293
395
|
* @summary List payments
|
|
294
396
|
* @param {string} [authorization] Bearer Token
|
|
295
|
-
* @param {
|
|
296
|
-
* @param {string} [
|
|
397
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
398
|
+
* @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.
|
|
399
|
+
* @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>
|
|
400
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
297
401
|
* @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>
|
|
298
402
|
* @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>
|
|
403
|
+
* @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>
|
|
299
404
|
* @param {*} [options] Override http request option.
|
|
300
405
|
* @throws {RequiredError}
|
|
301
406
|
*/
|
|
302
|
-
listPayments(authorization?: string, filter?: string,
|
|
303
|
-
return localVarFp.listPayments(authorization, filter,
|
|
407
|
+
listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentsResponseClass> {
|
|
408
|
+
return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
304
409
|
},
|
|
305
410
|
};
|
|
306
411
|
};
|
|
@@ -333,6 +438,34 @@ export interface PaymentsApiCreatePaymentRequest {
|
|
|
333
438
|
readonly authorization?: string
|
|
334
439
|
}
|
|
335
440
|
|
|
441
|
+
/**
|
|
442
|
+
* Request parameters for createPaymentOrder operation in PaymentsApi.
|
|
443
|
+
* @export
|
|
444
|
+
* @interface PaymentsApiCreatePaymentOrderRequest
|
|
445
|
+
*/
|
|
446
|
+
export interface PaymentsApiCreatePaymentOrderRequest {
|
|
447
|
+
/**
|
|
448
|
+
* Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
449
|
+
* @type {string}
|
|
450
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
451
|
+
*/
|
|
452
|
+
readonly idempotencyKey: string
|
|
453
|
+
|
|
454
|
+
/**
|
|
455
|
+
*
|
|
456
|
+
* @type {CreatePaymentOrderDto}
|
|
457
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
458
|
+
*/
|
|
459
|
+
readonly createPaymentOrderDto: CreatePaymentOrderDto
|
|
460
|
+
|
|
461
|
+
/**
|
|
462
|
+
* Bearer Token
|
|
463
|
+
* @type {string}
|
|
464
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
465
|
+
*/
|
|
466
|
+
readonly authorization?: string
|
|
467
|
+
}
|
|
468
|
+
|
|
336
469
|
/**
|
|
337
470
|
* Request parameters for getPayment operation in PaymentsApi.
|
|
338
471
|
* @export
|
|
@@ -375,18 +508,32 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
375
508
|
readonly authorization?: string
|
|
376
509
|
|
|
377
510
|
/**
|
|
378
|
-
*
|
|
511
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
512
|
+
* @type {number}
|
|
513
|
+
* @memberof PaymentsApiListPayments
|
|
514
|
+
*/
|
|
515
|
+
readonly pageSize?: number
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* 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.
|
|
519
|
+
* @type {string}
|
|
520
|
+
* @memberof PaymentsApiListPayments
|
|
521
|
+
*/
|
|
522
|
+
readonly pageToken?: string
|
|
523
|
+
|
|
524
|
+
/**
|
|
525
|
+
* 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>
|
|
379
526
|
* @type {string}
|
|
380
527
|
* @memberof PaymentsApiListPayments
|
|
381
528
|
*/
|
|
382
529
|
readonly filter?: string
|
|
383
530
|
|
|
384
531
|
/**
|
|
385
|
-
*
|
|
532
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
386
533
|
* @type {string}
|
|
387
534
|
* @memberof PaymentsApiListPayments
|
|
388
535
|
*/
|
|
389
|
-
readonly
|
|
536
|
+
readonly search?: string
|
|
390
537
|
|
|
391
538
|
/**
|
|
392
539
|
* 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>
|
|
@@ -401,6 +548,13 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
401
548
|
* @memberof PaymentsApiListPayments
|
|
402
549
|
*/
|
|
403
550
|
readonly expand?: string
|
|
551
|
+
|
|
552
|
+
/**
|
|
553
|
+
* 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>
|
|
554
|
+
* @type {string}
|
|
555
|
+
* @memberof PaymentsApiListPayments
|
|
556
|
+
*/
|
|
557
|
+
readonly filters?: string
|
|
404
558
|
}
|
|
405
559
|
|
|
406
560
|
/**
|
|
@@ -411,10 +565,11 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
411
565
|
*/
|
|
412
566
|
export class PaymentsApi extends BaseAPI {
|
|
413
567
|
/**
|
|
414
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
568
|
+
* 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\"
|
|
415
569
|
* @summary Create the payment
|
|
416
570
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
417
571
|
* @param {*} [options] Override http request option.
|
|
572
|
+
* @deprecated
|
|
418
573
|
* @throws {RequiredError}
|
|
419
574
|
* @memberof PaymentsApi
|
|
420
575
|
*/
|
|
@@ -422,6 +577,18 @@ export class PaymentsApi extends BaseAPI {
|
|
|
422
577
|
return PaymentsApiFp(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
423
578
|
}
|
|
424
579
|
|
|
580
|
+
/**
|
|
581
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
582
|
+
* @summary Create the payment
|
|
583
|
+
* @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
|
|
584
|
+
* @param {*} [options] Override http request option.
|
|
585
|
+
* @throws {RequiredError}
|
|
586
|
+
* @memberof PaymentsApi
|
|
587
|
+
*/
|
|
588
|
+
public createPaymentOrder(requestParameters: PaymentsApiCreatePaymentOrderRequest, options?: AxiosRequestConfig) {
|
|
589
|
+
return PaymentsApiFp(this.configuration).createPaymentOrder(requestParameters.idempotencyKey, requestParameters.createPaymentOrderDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
590
|
+
}
|
|
591
|
+
|
|
425
592
|
/**
|
|
426
593
|
* 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\"
|
|
427
594
|
* @summary Retrieve the payment
|
|
@@ -443,6 +610,6 @@ export class PaymentsApi extends BaseAPI {
|
|
|
443
610
|
* @memberof PaymentsApi
|
|
444
611
|
*/
|
|
445
612
|
public listPayments(requestParameters: PaymentsApiListPaymentsRequest = {}, options?: AxiosRequestConfig) {
|
|
446
|
-
return PaymentsApiFp(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
613
|
+
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));
|
|
447
614
|
}
|
|
448
615
|
}
|
package/api/refunds-api.ts
CHANGED
|
@@ -139,15 +139,17 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
139
139
|
* 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\"
|
|
140
140
|
* @summary List refunds
|
|
141
141
|
* @param {string} [authorization] Bearer Token
|
|
142
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
143
|
+
* @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.
|
|
142
144
|
* @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>
|
|
143
|
-
* @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>
|
|
144
145
|
* @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>
|
|
145
146
|
* @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>
|
|
146
147
|
* @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>
|
|
148
|
+
* @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>
|
|
147
149
|
* @param {*} [options] Override http request option.
|
|
148
150
|
* @throws {RequiredError}
|
|
149
151
|
*/
|
|
150
|
-
listRefunds: async (authorization?: string,
|
|
152
|
+
listRefunds: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
151
153
|
const localVarPath = `/paymentservice/v1/refunds`;
|
|
152
154
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
153
155
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -166,12 +168,16 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
166
168
|
// http bearer authentication required
|
|
167
169
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
168
170
|
|
|
169
|
-
if (
|
|
170
|
-
localVarQueryParameter['
|
|
171
|
+
if (pageSize !== undefined) {
|
|
172
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
171
173
|
}
|
|
172
174
|
|
|
173
|
-
if (
|
|
174
|
-
localVarQueryParameter['
|
|
175
|
+
if (pageToken !== undefined) {
|
|
176
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
if (filter !== undefined) {
|
|
180
|
+
localVarQueryParameter['filter'] = filter;
|
|
175
181
|
}
|
|
176
182
|
|
|
177
183
|
if (search !== undefined) {
|
|
@@ -186,6 +192,10 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
186
192
|
localVarQueryParameter['expand'] = expand;
|
|
187
193
|
}
|
|
188
194
|
|
|
195
|
+
if (filters !== undefined) {
|
|
196
|
+
localVarQueryParameter['filters'] = filters;
|
|
197
|
+
}
|
|
198
|
+
|
|
189
199
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
190
200
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
191
201
|
}
|
|
@@ -240,16 +250,18 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
240
250
|
* 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\"
|
|
241
251
|
* @summary List refunds
|
|
242
252
|
* @param {string} [authorization] Bearer Token
|
|
253
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
254
|
+
* @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.
|
|
243
255
|
* @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>
|
|
244
|
-
* @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>
|
|
245
256
|
* @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>
|
|
246
257
|
* @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>
|
|
247
258
|
* @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>
|
|
259
|
+
* @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>
|
|
248
260
|
* @param {*} [options] Override http request option.
|
|
249
261
|
* @throws {RequiredError}
|
|
250
262
|
*/
|
|
251
|
-
async listRefunds(authorization?: string,
|
|
252
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization,
|
|
263
|
+
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>> {
|
|
264
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
253
265
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
254
266
|
},
|
|
255
267
|
}
|
|
@@ -289,16 +301,18 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
289
301
|
* 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\"
|
|
290
302
|
* @summary List refunds
|
|
291
303
|
* @param {string} [authorization] Bearer Token
|
|
304
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
305
|
+
* @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.
|
|
292
306
|
* @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>
|
|
293
|
-
* @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>
|
|
294
307
|
* @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>
|
|
295
308
|
* @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>
|
|
296
309
|
* @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>
|
|
310
|
+
* @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>
|
|
297
311
|
* @param {*} [options] Override http request option.
|
|
298
312
|
* @throws {RequiredError}
|
|
299
313
|
*/
|
|
300
|
-
listRefunds(authorization?: string,
|
|
301
|
-
return localVarFp.listRefunds(authorization,
|
|
314
|
+
listRefunds(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRefundsResponseClass> {
|
|
315
|
+
return localVarFp.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
302
316
|
},
|
|
303
317
|
};
|
|
304
318
|
};
|
|
@@ -366,18 +380,25 @@ export interface RefundsApiListRefundsRequest {
|
|
|
366
380
|
readonly authorization?: string
|
|
367
381
|
|
|
368
382
|
/**
|
|
369
|
-
*
|
|
383
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
384
|
+
* @type {number}
|
|
385
|
+
* @memberof RefundsApiListRefunds
|
|
386
|
+
*/
|
|
387
|
+
readonly pageSize?: number
|
|
388
|
+
|
|
389
|
+
/**
|
|
390
|
+
* 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.
|
|
370
391
|
* @type {string}
|
|
371
392
|
* @memberof RefundsApiListRefunds
|
|
372
393
|
*/
|
|
373
|
-
readonly
|
|
394
|
+
readonly pageToken?: string
|
|
374
395
|
|
|
375
396
|
/**
|
|
376
|
-
*
|
|
397
|
+
* 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>
|
|
377
398
|
* @type {string}
|
|
378
399
|
* @memberof RefundsApiListRefunds
|
|
379
400
|
*/
|
|
380
|
-
readonly
|
|
401
|
+
readonly filter?: string
|
|
381
402
|
|
|
382
403
|
/**
|
|
383
404
|
* 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>
|
|
@@ -399,6 +420,13 @@ export interface RefundsApiListRefundsRequest {
|
|
|
399
420
|
* @memberof RefundsApiListRefunds
|
|
400
421
|
*/
|
|
401
422
|
readonly expand?: string
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* 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>
|
|
426
|
+
* @type {string}
|
|
427
|
+
* @memberof RefundsApiListRefunds
|
|
428
|
+
*/
|
|
429
|
+
readonly filters?: string
|
|
402
430
|
}
|
|
403
431
|
|
|
404
432
|
/**
|
|
@@ -441,6 +469,6 @@ export class RefundsApi extends BaseAPI {
|
|
|
441
469
|
* @memberof RefundsApi
|
|
442
470
|
*/
|
|
443
471
|
public listRefunds(requestParameters: RefundsApiListRefundsRequest = {}, options?: AxiosRequestConfig) {
|
|
444
|
-
return RefundsApiFp(this.configuration).listRefunds(requestParameters.authorization, requestParameters.
|
|
472
|
+
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));
|
|
445
473
|
}
|
|
446
474
|
}
|