@emilgroup/payment-sdk 1.13.1-beta.2 → 1.13.1-beta.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +12 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +79 -37
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +187 -56
- package/api/payment-methods-api.ts +67 -25
- package/api/payment-reminders-api.ts +85 -43
- package/api/payment-setup-api.ts +8 -8
- package/api/payments-api.ts +67 -25
- package/api/refunds-api.ts +57 -29
- package/api/tenant-bank-account-api.ts +45 -17
- package/api/webhooks-api.ts +4 -4
- package/api.ts +2 -0
- package/base.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +59 -32
- package/dist/api/bank-accounts-api.js +53 -35
- 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 +123 -49
- package/dist/api/bank-transaction-api.js +151 -47
- package/dist/api/payment-methods-api.d.ts +47 -20
- package/dist/api/payment-methods-api.js +41 -23
- package/dist/api/payment-reminders-api.d.ts +61 -34
- package/dist/api/payment-reminders-api.js +54 -36
- package/dist/api/payment-setup-api.d.ts +8 -8
- package/dist/api/payment-setup-api.js +8 -8
- package/dist/api/payments-api.d.ts +47 -20
- package/dist/api/payments-api.js +41 -23
- package/dist/api/refunds-api.d.ts +40 -22
- package/dist/api/refunds-api.js +36 -24
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api/webhooks-api.d.ts +4 -4
- package/dist/api/webhooks-api.js +4 -4
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-order-class.js +15 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +8 -2
- package/dist/models/bank-transaction-class.d.ts +22 -2
- 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-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 +7 -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 +11 -0
- package/dist/models/index.js +11 -0
- 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-stripe-payment-setup-request-dto.d.ts +6 -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/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-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 +8 -2
- package/dist/models/update-bank-order-request-dto.d.ts +56 -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 +8 -2
- package/models/bank-transaction-class.ts +22 -2
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -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 +7 -1
- 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 +11 -0
- 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-stripe-payment-setup-request-dto.ts +6 -0
- package/models/invoice-match-suggestion-class.ts +66 -0
- 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-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 +8 -2
- package/models/update-bank-order-request-dto.ts +65 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
package/api/payment-setup-api.ts
CHANGED
|
@@ -35,7 +35,7 @@ import { InitiatePaymentSetupResponseClass } from '../models';
|
|
|
35
35
|
export const PaymentSetupApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
38
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
|
|
39
39
|
* @summary Complete a payment setup
|
|
40
40
|
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
41
41
|
* @param {string} [authorization] Bearer Token
|
|
@@ -82,7 +82,7 @@ export const PaymentSetupApiAxiosParamCreator = function (configuration?: Config
|
|
|
82
82
|
};
|
|
83
83
|
},
|
|
84
84
|
/**
|
|
85
|
-
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
85
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
|
|
86
86
|
* @summary Initiate a payment setup
|
|
87
87
|
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
88
88
|
* @param {string} [authorization] Bearer Token
|
|
@@ -139,7 +139,7 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
|
|
|
139
139
|
const localVarAxiosParamCreator = PaymentSetupApiAxiosParamCreator(configuration)
|
|
140
140
|
return {
|
|
141
141
|
/**
|
|
142
|
-
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
142
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
|
|
143
143
|
* @summary Complete a payment setup
|
|
144
144
|
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
145
145
|
* @param {string} [authorization] Bearer Token
|
|
@@ -151,7 +151,7 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
|
|
|
151
151
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
152
152
|
},
|
|
153
153
|
/**
|
|
154
|
-
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
154
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
|
|
155
155
|
* @summary Initiate a payment setup
|
|
156
156
|
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
157
157
|
* @param {string} [authorization] Bearer Token
|
|
@@ -173,7 +173,7 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
|
|
|
173
173
|
const localVarFp = PaymentSetupApiFp(configuration)
|
|
174
174
|
return {
|
|
175
175
|
/**
|
|
176
|
-
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
176
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
|
|
177
177
|
* @summary Complete a payment setup
|
|
178
178
|
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
179
179
|
* @param {string} [authorization] Bearer Token
|
|
@@ -184,7 +184,7 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
|
|
|
184
184
|
return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
185
185
|
},
|
|
186
186
|
/**
|
|
187
|
-
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
187
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
|
|
188
188
|
* @summary Initiate a payment setup
|
|
189
189
|
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
190
190
|
* @param {string} [authorization] Bearer Token
|
|
@@ -247,7 +247,7 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
|
|
|
247
247
|
*/
|
|
248
248
|
export class PaymentSetupApi extends BaseAPI {
|
|
249
249
|
/**
|
|
250
|
-
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
250
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
|
|
251
251
|
* @summary Complete a payment setup
|
|
252
252
|
* @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
|
|
253
253
|
* @param {*} [options] Override http request option.
|
|
@@ -259,7 +259,7 @@ export class PaymentSetupApi extends BaseAPI {
|
|
|
259
259
|
}
|
|
260
260
|
|
|
261
261
|
/**
|
|
262
|
-
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
262
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
|
|
263
263
|
* @summary Initiate a payment setup
|
|
264
264
|
* @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
|
|
265
265
|
* @param {*} [options] Override http request option.
|
package/api/payments-api.ts
CHANGED
|
@@ -35,7 +35,7 @@ import { ListPaymentsResponseClass } from '../models';
|
|
|
35
35
|
export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* This will create a payment for a specified account. This function is idempotent.
|
|
38
|
+
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
39
39
|
* @summary Create the payment
|
|
40
40
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
41
41
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
@@ -89,7 +89,7 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
89
89
|
};
|
|
90
90
|
},
|
|
91
91
|
/**
|
|
92
|
-
* 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.
|
|
92
|
+
* 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
93
|
* @summary Retrieve the payment
|
|
94
94
|
* @param {string} code
|
|
95
95
|
* @param {string} [authorization] Bearer Token
|
|
@@ -139,17 +139,20 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
139
139
|
};
|
|
140
140
|
},
|
|
141
141
|
/**
|
|
142
|
-
* 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.
|
|
142
|
+
* 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
143
|
* @summary List payments
|
|
144
144
|
* @param {string} [authorization] Bearer Token
|
|
145
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
146
|
+
* @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.
|
|
145
147
|
* @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</i>
|
|
146
|
-
* @param {string} [
|
|
148
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
147
149
|
* @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
150
|
* @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>
|
|
151
|
+
* @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</i>
|
|
149
152
|
* @param {*} [options] Override http request option.
|
|
150
153
|
* @throws {RequiredError}
|
|
151
154
|
*/
|
|
152
|
-
listPayments: async (authorization?: string, filter?: string,
|
|
155
|
+
listPayments: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
153
156
|
const localVarPath = `/paymentservice/v1/payments`;
|
|
154
157
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
155
158
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -168,12 +171,20 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
168
171
|
// http bearer authentication required
|
|
169
172
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
170
173
|
|
|
174
|
+
if (pageSize !== undefined) {
|
|
175
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
if (pageToken !== undefined) {
|
|
179
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
180
|
+
}
|
|
181
|
+
|
|
171
182
|
if (filter !== undefined) {
|
|
172
183
|
localVarQueryParameter['filter'] = filter;
|
|
173
184
|
}
|
|
174
185
|
|
|
175
|
-
if (
|
|
176
|
-
localVarQueryParameter['
|
|
186
|
+
if (search !== undefined) {
|
|
187
|
+
localVarQueryParameter['search'] = search;
|
|
177
188
|
}
|
|
178
189
|
|
|
179
190
|
if (order !== undefined) {
|
|
@@ -184,6 +195,10 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
184
195
|
localVarQueryParameter['expand'] = expand;
|
|
185
196
|
}
|
|
186
197
|
|
|
198
|
+
if (filters !== undefined) {
|
|
199
|
+
localVarQueryParameter['filters'] = filters;
|
|
200
|
+
}
|
|
201
|
+
|
|
187
202
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
188
203
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
189
204
|
}
|
|
@@ -210,7 +225,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
210
225
|
const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
|
|
211
226
|
return {
|
|
212
227
|
/**
|
|
213
|
-
* This will create a payment for a specified account. This function is idempotent.
|
|
228
|
+
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
214
229
|
* @summary Create the payment
|
|
215
230
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
216
231
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
@@ -223,7 +238,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
223
238
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
224
239
|
},
|
|
225
240
|
/**
|
|
226
|
-
* 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.
|
|
241
|
+
* 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
242
|
* @summary Retrieve the payment
|
|
228
243
|
* @param {string} code
|
|
229
244
|
* @param {string} [authorization] Bearer Token
|
|
@@ -236,18 +251,21 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
236
251
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
237
252
|
},
|
|
238
253
|
/**
|
|
239
|
-
* 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.
|
|
254
|
+
* 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
255
|
* @summary List payments
|
|
241
256
|
* @param {string} [authorization] Bearer Token
|
|
257
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
258
|
+
* @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.
|
|
242
259
|
* @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</i>
|
|
243
|
-
* @param {string} [
|
|
260
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
244
261
|
* @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
262
|
* @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>
|
|
263
|
+
* @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</i>
|
|
246
264
|
* @param {*} [options] Override http request option.
|
|
247
265
|
* @throws {RequiredError}
|
|
248
266
|
*/
|
|
249
|
-
async listPayments(authorization?: string, filter?: string,
|
|
250
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, filter,
|
|
267
|
+
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>> {
|
|
268
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
251
269
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
252
270
|
},
|
|
253
271
|
}
|
|
@@ -261,7 +279,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
261
279
|
const localVarFp = PaymentsApiFp(configuration)
|
|
262
280
|
return {
|
|
263
281
|
/**
|
|
264
|
-
* This will create a payment for a specified account. This function is idempotent.
|
|
282
|
+
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
265
283
|
* @summary Create the payment
|
|
266
284
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
267
285
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
@@ -273,7 +291,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
273
291
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
274
292
|
},
|
|
275
293
|
/**
|
|
276
|
-
* 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.
|
|
294
|
+
* 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
295
|
* @summary Retrieve the payment
|
|
278
296
|
* @param {string} code
|
|
279
297
|
* @param {string} [authorization] Bearer Token
|
|
@@ -285,18 +303,21 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
285
303
|
return localVarFp.getPayment(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
286
304
|
},
|
|
287
305
|
/**
|
|
288
|
-
* 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.
|
|
306
|
+
* 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
307
|
* @summary List payments
|
|
290
308
|
* @param {string} [authorization] Bearer Token
|
|
309
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
310
|
+
* @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.
|
|
291
311
|
* @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</i>
|
|
292
|
-
* @param {string} [
|
|
312
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
293
313
|
* @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
314
|
* @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>
|
|
315
|
+
* @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</i>
|
|
295
316
|
* @param {*} [options] Override http request option.
|
|
296
317
|
* @throws {RequiredError}
|
|
297
318
|
*/
|
|
298
|
-
listPayments(authorization?: string, filter?: string,
|
|
299
|
-
return localVarFp.listPayments(authorization, filter,
|
|
319
|
+
listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentsResponseClass> {
|
|
320
|
+
return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
300
321
|
},
|
|
301
322
|
};
|
|
302
323
|
};
|
|
@@ -370,6 +391,20 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
370
391
|
*/
|
|
371
392
|
readonly authorization?: string
|
|
372
393
|
|
|
394
|
+
/**
|
|
395
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
396
|
+
* @type {number}
|
|
397
|
+
* @memberof PaymentsApiListPayments
|
|
398
|
+
*/
|
|
399
|
+
readonly pageSize?: number
|
|
400
|
+
|
|
401
|
+
/**
|
|
402
|
+
* 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.
|
|
403
|
+
* @type {string}
|
|
404
|
+
* @memberof PaymentsApiListPayments
|
|
405
|
+
*/
|
|
406
|
+
readonly pageToken?: string
|
|
407
|
+
|
|
373
408
|
/**
|
|
374
409
|
* 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</i>
|
|
375
410
|
* @type {string}
|
|
@@ -378,11 +413,11 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
378
413
|
readonly filter?: string
|
|
379
414
|
|
|
380
415
|
/**
|
|
381
|
-
*
|
|
416
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
382
417
|
* @type {string}
|
|
383
418
|
* @memberof PaymentsApiListPayments
|
|
384
419
|
*/
|
|
385
|
-
readonly
|
|
420
|
+
readonly search?: string
|
|
386
421
|
|
|
387
422
|
/**
|
|
388
423
|
* 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 +432,13 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
397
432
|
* @memberof PaymentsApiListPayments
|
|
398
433
|
*/
|
|
399
434
|
readonly expand?: string
|
|
435
|
+
|
|
436
|
+
/**
|
|
437
|
+
* 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</i>
|
|
438
|
+
* @type {string}
|
|
439
|
+
* @memberof PaymentsApiListPayments
|
|
440
|
+
*/
|
|
441
|
+
readonly filters?: string
|
|
400
442
|
}
|
|
401
443
|
|
|
402
444
|
/**
|
|
@@ -407,7 +449,7 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
407
449
|
*/
|
|
408
450
|
export class PaymentsApi extends BaseAPI {
|
|
409
451
|
/**
|
|
410
|
-
* This will create a payment for a specified account. This function is idempotent.
|
|
452
|
+
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
411
453
|
* @summary Create the payment
|
|
412
454
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
413
455
|
* @param {*} [options] Override http request option.
|
|
@@ -419,7 +461,7 @@ export class PaymentsApi extends BaseAPI {
|
|
|
419
461
|
}
|
|
420
462
|
|
|
421
463
|
/**
|
|
422
|
-
* 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.
|
|
464
|
+
* 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
465
|
* @summary Retrieve the payment
|
|
424
466
|
* @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
|
|
425
467
|
* @param {*} [options] Override http request option.
|
|
@@ -431,7 +473,7 @@ export class PaymentsApi extends BaseAPI {
|
|
|
431
473
|
}
|
|
432
474
|
|
|
433
475
|
/**
|
|
434
|
-
* 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.
|
|
476
|
+
* 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\"
|
|
435
477
|
* @summary List payments
|
|
436
478
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
437
479
|
* @param {*} [options] Override http request option.
|
|
@@ -439,6 +481,6 @@ export class PaymentsApi extends BaseAPI {
|
|
|
439
481
|
* @memberof PaymentsApi
|
|
440
482
|
*/
|
|
441
483
|
public listPayments(requestParameters: PaymentsApiListPaymentsRequest = {}, options?: AxiosRequestConfig) {
|
|
442
|
-
return PaymentsApiFp(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
484
|
+
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
485
|
}
|
|
444
486
|
}
|
package/api/refunds-api.ts
CHANGED
|
@@ -35,7 +35,7 @@ import { ListRefundsResponseClass } from '../models';
|
|
|
35
35
|
export const RefundsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* This will create a refund in the database.
|
|
38
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
39
39
|
* @summary Create the refund
|
|
40
40
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
41
41
|
* @param {string} [authorization] Bearer Token
|
|
@@ -82,7 +82,7 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
82
82
|
};
|
|
83
83
|
},
|
|
84
84
|
/**
|
|
85
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
85
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
86
86
|
* @summary Retrieve the refund
|
|
87
87
|
* @param {string} code
|
|
88
88
|
* @param {string} [authorization] Bearer Token
|
|
@@ -132,18 +132,20 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
132
132
|
};
|
|
133
133
|
},
|
|
134
134
|
/**
|
|
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.
|
|
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
|
}
|
|
@@ -208,7 +218,7 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
208
218
|
const localVarAxiosParamCreator = RefundsApiAxiosParamCreator(configuration)
|
|
209
219
|
return {
|
|
210
220
|
/**
|
|
211
|
-
* This will create a refund in the database.
|
|
221
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
212
222
|
* @summary Create the refund
|
|
213
223
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
214
224
|
* @param {string} [authorization] Bearer Token
|
|
@@ -220,7 +230,7 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
220
230
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
221
231
|
},
|
|
222
232
|
/**
|
|
223
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
233
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
224
234
|
* @summary Retrieve the refund
|
|
225
235
|
* @param {string} code
|
|
226
236
|
* @param {string} [authorization] Bearer Token
|
|
@@ -233,19 +243,21 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
233
243
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
234
244
|
},
|
|
235
245
|
/**
|
|
236
|
-
* 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.
|
|
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
|
}
|
|
@@ -259,7 +271,7 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
259
271
|
const localVarFp = RefundsApiFp(configuration)
|
|
260
272
|
return {
|
|
261
273
|
/**
|
|
262
|
-
* This will create a refund in the database.
|
|
274
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
263
275
|
* @summary Create the refund
|
|
264
276
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
265
277
|
* @param {string} [authorization] Bearer Token
|
|
@@ -270,7 +282,7 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
270
282
|
return localVarFp.createRefund(createRefundRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
271
283
|
},
|
|
272
284
|
/**
|
|
273
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
285
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
274
286
|
* @summary Retrieve the refund
|
|
275
287
|
* @param {string} code
|
|
276
288
|
* @param {string} [authorization] Bearer Token
|
|
@@ -282,19 +294,21 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
282
294
|
return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
283
295
|
},
|
|
284
296
|
/**
|
|
285
|
-
* 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.
|
|
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
|
/**
|
|
@@ -405,7 +433,7 @@ export interface RefundsApiListRefundsRequest {
|
|
|
405
433
|
*/
|
|
406
434
|
export class RefundsApi extends BaseAPI {
|
|
407
435
|
/**
|
|
408
|
-
* This will create a refund in the database.
|
|
436
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
409
437
|
* @summary Create the refund
|
|
410
438
|
* @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
|
|
411
439
|
* @param {*} [options] Override http request option.
|
|
@@ -417,7 +445,7 @@ export class RefundsApi extends BaseAPI {
|
|
|
417
445
|
}
|
|
418
446
|
|
|
419
447
|
/**
|
|
420
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
448
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
421
449
|
* @summary Retrieve the refund
|
|
422
450
|
* @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
|
|
423
451
|
* @param {*} [options] Override http request option.
|
|
@@ -429,7 +457,7 @@ export class RefundsApi extends BaseAPI {
|
|
|
429
457
|
}
|
|
430
458
|
|
|
431
459
|
/**
|
|
432
|
-
* 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.
|
|
460
|
+
* 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\"
|
|
433
461
|
* @summary List refunds
|
|
434
462
|
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
435
463
|
* @param {*} [options] Override http request option.
|
|
@@ -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
|
}
|