@emilgroup/payment-sdk-node 1.21.1-beta.2 → 1.21.1-beta.20
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 +695 -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 +646 -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
|
@@ -39,7 +39,7 @@ const FormData = require('form-data');
|
|
|
39
39
|
export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
42
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
43
43
|
* @summary Create the payment method
|
|
44
44
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
45
45
|
* @param {string} [authorization] Bearer Token
|
|
@@ -86,7 +86,7 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
86
86
|
};
|
|
87
87
|
},
|
|
88
88
|
/**
|
|
89
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
89
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
90
90
|
* @summary Retrieve the payment method
|
|
91
91
|
* @param {string} code
|
|
92
92
|
* @param {string} [authorization] Bearer Token
|
|
@@ -131,17 +131,20 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
131
131
|
};
|
|
132
132
|
},
|
|
133
133
|
/**
|
|
134
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
134
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
135
135
|
* @summary List payment methods
|
|
136
136
|
* @param {string} [authorization] Bearer Token
|
|
137
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
138
|
+
* @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.
|
|
137
139
|
* @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, productSlug</i>
|
|
138
|
-
* @param {string} [
|
|
140
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
139
141
|
* @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</i>
|
|
140
142
|
* @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/>
|
|
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, pspCustomerId, psp, type, productSlug</i>
|
|
141
144
|
* @param {*} [options] Override http request option.
|
|
142
145
|
* @throws {RequiredError}
|
|
143
146
|
*/
|
|
144
|
-
listPaymentMethods: async (authorization?: string, filter?: string,
|
|
147
|
+
listPaymentMethods: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
145
148
|
const localVarPath = `/paymentservice/v1/payment-methods`;
|
|
146
149
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
147
150
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -160,12 +163,20 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
160
163
|
// http bearer authentication required
|
|
161
164
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
162
165
|
|
|
166
|
+
if (pageSize !== undefined) {
|
|
167
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
if (pageToken !== undefined) {
|
|
171
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
172
|
+
}
|
|
173
|
+
|
|
163
174
|
if (filter !== undefined) {
|
|
164
175
|
localVarQueryParameter['filter'] = filter;
|
|
165
176
|
}
|
|
166
177
|
|
|
167
|
-
if (
|
|
168
|
-
localVarQueryParameter['
|
|
178
|
+
if (search !== undefined) {
|
|
179
|
+
localVarQueryParameter['search'] = search;
|
|
169
180
|
}
|
|
170
181
|
|
|
171
182
|
if (order !== undefined) {
|
|
@@ -176,6 +187,10 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
176
187
|
localVarQueryParameter['expand'] = expand;
|
|
177
188
|
}
|
|
178
189
|
|
|
190
|
+
if (filters !== undefined) {
|
|
191
|
+
localVarQueryParameter['filters'] = filters;
|
|
192
|
+
}
|
|
193
|
+
|
|
179
194
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
180
195
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
181
196
|
}
|
|
@@ -202,7 +217,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
202
217
|
const localVarAxiosParamCreator = PaymentMethodsApiAxiosParamCreator(configuration)
|
|
203
218
|
return {
|
|
204
219
|
/**
|
|
205
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
220
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
206
221
|
* @summary Create the payment method
|
|
207
222
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
208
223
|
* @param {string} [authorization] Bearer Token
|
|
@@ -214,7 +229,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
214
229
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
215
230
|
},
|
|
216
231
|
/**
|
|
217
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
232
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
218
233
|
* @summary Retrieve the payment method
|
|
219
234
|
* @param {string} code
|
|
220
235
|
* @param {string} [authorization] Bearer Token
|
|
@@ -226,18 +241,21 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
226
241
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
227
242
|
},
|
|
228
243
|
/**
|
|
229
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
244
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
230
245
|
* @summary List payment methods
|
|
231
246
|
* @param {string} [authorization] Bearer Token
|
|
247
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
|
+
* @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.
|
|
232
249
|
* @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, productSlug</i>
|
|
233
|
-
* @param {string} [
|
|
250
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
234
251
|
* @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</i>
|
|
235
252
|
* @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/>
|
|
253
|
+
* @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, productSlug</i>
|
|
236
254
|
* @param {*} [options] Override http request option.
|
|
237
255
|
* @throws {RequiredError}
|
|
238
256
|
*/
|
|
239
|
-
async listPaymentMethods(authorization?: string, filter?: string,
|
|
240
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentMethods(authorization, filter,
|
|
257
|
+
async listPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentMethodsResponseClass>> {
|
|
258
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
241
259
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
242
260
|
},
|
|
243
261
|
}
|
|
@@ -251,7 +269,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
251
269
|
const localVarFp = PaymentMethodsApiFp(configuration)
|
|
252
270
|
return {
|
|
253
271
|
/**
|
|
254
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
272
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
255
273
|
* @summary Create the payment method
|
|
256
274
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
257
275
|
* @param {string} [authorization] Bearer Token
|
|
@@ -262,7 +280,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
262
280
|
return localVarFp.createPaymentMethod(createPspPaymentMethodRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
263
281
|
},
|
|
264
282
|
/**
|
|
265
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
283
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
266
284
|
* @summary Retrieve the payment method
|
|
267
285
|
* @param {string} code
|
|
268
286
|
* @param {string} [authorization] Bearer Token
|
|
@@ -273,18 +291,21 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
273
291
|
return localVarFp.getPaymentMethod(code, authorization, options).then((request) => request(axios, basePath));
|
|
274
292
|
},
|
|
275
293
|
/**
|
|
276
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
294
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
277
295
|
* @summary List payment methods
|
|
278
296
|
* @param {string} [authorization] Bearer Token
|
|
297
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
298
|
+
* @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.
|
|
279
299
|
* @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, productSlug</i>
|
|
280
|
-
* @param {string} [
|
|
300
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
281
301
|
* @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</i>
|
|
282
302
|
* @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/>
|
|
303
|
+
* @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, productSlug</i>
|
|
283
304
|
* @param {*} [options] Override http request option.
|
|
284
305
|
* @throws {RequiredError}
|
|
285
306
|
*/
|
|
286
|
-
listPaymentMethods(authorization?: string, filter?: string,
|
|
287
|
-
return localVarFp.listPaymentMethods(authorization, filter,
|
|
307
|
+
listPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentMethodsResponseClass> {
|
|
308
|
+
return localVarFp.listPaymentMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
288
309
|
},
|
|
289
310
|
};
|
|
290
311
|
};
|
|
@@ -344,6 +365,20 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
344
365
|
*/
|
|
345
366
|
readonly authorization?: string
|
|
346
367
|
|
|
368
|
+
/**
|
|
369
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
370
|
+
* @type {number}
|
|
371
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
372
|
+
*/
|
|
373
|
+
readonly pageSize?: number
|
|
374
|
+
|
|
375
|
+
/**
|
|
376
|
+
* 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.
|
|
377
|
+
* @type {string}
|
|
378
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
379
|
+
*/
|
|
380
|
+
readonly pageToken?: string
|
|
381
|
+
|
|
347
382
|
/**
|
|
348
383
|
* 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, productSlug</i>
|
|
349
384
|
* @type {string}
|
|
@@ -352,11 +387,11 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
352
387
|
readonly filter?: string
|
|
353
388
|
|
|
354
389
|
/**
|
|
355
|
-
*
|
|
390
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
356
391
|
* @type {string}
|
|
357
392
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
358
393
|
*/
|
|
359
|
-
readonly
|
|
394
|
+
readonly search?: string
|
|
360
395
|
|
|
361
396
|
/**
|
|
362
397
|
* 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</i>
|
|
@@ -371,6 +406,13 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
371
406
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
372
407
|
*/
|
|
373
408
|
readonly expand?: string
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
* 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, productSlug</i>
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
414
|
+
*/
|
|
415
|
+
readonly filters?: string
|
|
374
416
|
}
|
|
375
417
|
|
|
376
418
|
/**
|
|
@@ -381,7 +423,7 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
381
423
|
*/
|
|
382
424
|
export class PaymentMethodsApi extends BaseAPI {
|
|
383
425
|
/**
|
|
384
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
426
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
385
427
|
* @summary Create the payment method
|
|
386
428
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
387
429
|
* @param {*} [options] Override http request option.
|
|
@@ -393,7 +435,7 @@ export class PaymentMethodsApi extends BaseAPI {
|
|
|
393
435
|
}
|
|
394
436
|
|
|
395
437
|
/**
|
|
396
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
438
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
397
439
|
* @summary Retrieve the payment method
|
|
398
440
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
399
441
|
* @param {*} [options] Override http request option.
|
|
@@ -405,7 +447,7 @@ export class PaymentMethodsApi extends BaseAPI {
|
|
|
405
447
|
}
|
|
406
448
|
|
|
407
449
|
/**
|
|
408
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
450
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
409
451
|
* @summary List payment methods
|
|
410
452
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
411
453
|
* @param {*} [options] Override http request option.
|
|
@@ -413,6 +455,6 @@ export class PaymentMethodsApi extends BaseAPI {
|
|
|
413
455
|
* @memberof PaymentMethodsApi
|
|
414
456
|
*/
|
|
415
457
|
public listPaymentMethods(requestParameters: PaymentMethodsApiListPaymentMethodsRequest = {}, options?: AxiosRequestConfig) {
|
|
416
|
-
return PaymentMethodsApiFp(this.configuration).listPaymentMethods(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
458
|
+
return PaymentMethodsApiFp(this.configuration).listPaymentMethods(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
417
459
|
}
|
|
418
460
|
}
|
|
@@ -43,7 +43,7 @@ const FormData = require('form-data');
|
|
|
43
43
|
export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
44
|
return {
|
|
45
45
|
/**
|
|
46
|
-
* This will create a payment reminder in the database.
|
|
46
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
47
47
|
* @summary Create the payment reminder
|
|
48
48
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -90,7 +90,7 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
92
|
/**
|
|
93
|
-
* This will deactivate the payment reminder
|
|
93
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
94
94
|
* @summary Deactivate payment reminder
|
|
95
95
|
* @param {string} code Unique identifier for the object.
|
|
96
96
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -141,16 +141,16 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
141
141
|
};
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
144
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
145
145
|
* @summary Retrieve the payment reminder
|
|
146
146
|
* @param {string} code
|
|
147
147
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
149
149
|
* @throws {RequiredError}
|
|
150
150
|
*/
|
|
151
|
-
|
|
151
|
+
getPaymentReminder: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152
152
|
// verify required parameter 'code' is not null or undefined
|
|
153
|
-
assertParamExists('
|
|
153
|
+
assertParamExists('getPaymentReminder', 'code', code)
|
|
154
154
|
const localVarPath = `/paymentservice/v1/payment-reminders/{code}`
|
|
155
155
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
156
156
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -186,17 +186,20 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
186
186
|
};
|
|
187
187
|
},
|
|
188
188
|
/**
|
|
189
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
189
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
190
190
|
* @summary List payment reminders
|
|
191
191
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
192
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
193
|
+
* @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.
|
|
192
194
|
* @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, policyCode, nextReminderDate</i>
|
|
193
|
-
* @param {string} [
|
|
195
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
194
196
|
* @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</i>
|
|
195
197
|
* @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/>
|
|
198
|
+
* @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, policyCode, nextReminderDate</i>
|
|
196
199
|
* @param {*} [options] Override http request option.
|
|
197
200
|
* @throws {RequiredError}
|
|
198
201
|
*/
|
|
199
|
-
listPaymentReminders: async (authorization?: string, filter?: string,
|
|
202
|
+
listPaymentReminders: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
200
203
|
const localVarPath = `/paymentservice/v1/payment-reminders`;
|
|
201
204
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
205
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -215,12 +218,20 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
215
218
|
// http bearer authentication required
|
|
216
219
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
217
220
|
|
|
221
|
+
if (pageSize !== undefined) {
|
|
222
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
if (pageToken !== undefined) {
|
|
226
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
227
|
+
}
|
|
228
|
+
|
|
218
229
|
if (filter !== undefined) {
|
|
219
230
|
localVarQueryParameter['filter'] = filter;
|
|
220
231
|
}
|
|
221
232
|
|
|
222
|
-
if (
|
|
223
|
-
localVarQueryParameter['
|
|
233
|
+
if (search !== undefined) {
|
|
234
|
+
localVarQueryParameter['search'] = search;
|
|
224
235
|
}
|
|
225
236
|
|
|
226
237
|
if (order !== undefined) {
|
|
@@ -231,6 +242,10 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
231
242
|
localVarQueryParameter['expand'] = expand;
|
|
232
243
|
}
|
|
233
244
|
|
|
245
|
+
if (filters !== undefined) {
|
|
246
|
+
localVarQueryParameter['filters'] = filters;
|
|
247
|
+
}
|
|
248
|
+
|
|
234
249
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
235
250
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
236
251
|
}
|
|
@@ -257,7 +272,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
257
272
|
const localVarAxiosParamCreator = PaymentRemindersApiAxiosParamCreator(configuration)
|
|
258
273
|
return {
|
|
259
274
|
/**
|
|
260
|
-
* This will create a payment reminder in the database.
|
|
275
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
261
276
|
* @summary Create the payment reminder
|
|
262
277
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
263
278
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -269,7 +284,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
269
284
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
270
285
|
},
|
|
271
286
|
/**
|
|
272
|
-
* This will deactivate the payment reminder
|
|
287
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
273
288
|
* @summary Deactivate payment reminder
|
|
274
289
|
* @param {string} code Unique identifier for the object.
|
|
275
290
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -282,30 +297,33 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
282
297
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
283
298
|
},
|
|
284
299
|
/**
|
|
285
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
300
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
286
301
|
* @summary Retrieve the payment reminder
|
|
287
302
|
* @param {string} code
|
|
288
303
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
289
304
|
* @param {*} [options] Override http request option.
|
|
290
305
|
* @throws {RequiredError}
|
|
291
306
|
*/
|
|
292
|
-
async
|
|
293
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
307
|
+
async getPaymentReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>> {
|
|
308
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentReminder(code, authorization, options);
|
|
294
309
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
295
310
|
},
|
|
296
311
|
/**
|
|
297
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
312
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
298
313
|
* @summary List payment reminders
|
|
299
314
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
315
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
316
|
+
* @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.
|
|
300
317
|
* @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, policyCode, nextReminderDate</i>
|
|
301
|
-
* @param {string} [
|
|
318
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
302
319
|
* @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</i>
|
|
303
320
|
* @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/>
|
|
321
|
+
* @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, policyCode, nextReminderDate</i>
|
|
304
322
|
* @param {*} [options] Override http request option.
|
|
305
323
|
* @throws {RequiredError}
|
|
306
324
|
*/
|
|
307
|
-
async listPaymentReminders(authorization?: string, filter?: string,
|
|
308
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization, filter,
|
|
325
|
+
async listPaymentReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentRemindersResponseClass>> {
|
|
326
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
309
327
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
310
328
|
},
|
|
311
329
|
}
|
|
@@ -319,7 +337,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
319
337
|
const localVarFp = PaymentRemindersApiFp(configuration)
|
|
320
338
|
return {
|
|
321
339
|
/**
|
|
322
|
-
* This will create a payment reminder in the database.
|
|
340
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
323
341
|
* @summary Create the payment reminder
|
|
324
342
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
325
343
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -330,7 +348,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
330
348
|
return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
331
349
|
},
|
|
332
350
|
/**
|
|
333
|
-
* This will deactivate the payment reminder
|
|
351
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
334
352
|
* @summary Deactivate payment reminder
|
|
335
353
|
* @param {string} code Unique identifier for the object.
|
|
336
354
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -342,29 +360,32 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
342
360
|
return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
343
361
|
},
|
|
344
362
|
/**
|
|
345
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
363
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
346
364
|
* @summary Retrieve the payment reminder
|
|
347
365
|
* @param {string} code
|
|
348
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
349
367
|
* @param {*} [options] Override http request option.
|
|
350
368
|
* @throws {RequiredError}
|
|
351
369
|
*/
|
|
352
|
-
|
|
353
|
-
return localVarFp.
|
|
370
|
+
getPaymentReminder(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass> {
|
|
371
|
+
return localVarFp.getPaymentReminder(code, authorization, options).then((request) => request(axios, basePath));
|
|
354
372
|
},
|
|
355
373
|
/**
|
|
356
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
374
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
357
375
|
* @summary List payment reminders
|
|
358
376
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
377
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
378
|
+
* @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.
|
|
359
379
|
* @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, policyCode, nextReminderDate</i>
|
|
360
|
-
* @param {string} [
|
|
380
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
361
381
|
* @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</i>
|
|
362
382
|
* @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/>
|
|
383
|
+
* @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, policyCode, nextReminderDate</i>
|
|
363
384
|
* @param {*} [options] Override http request option.
|
|
364
385
|
* @throws {RequiredError}
|
|
365
386
|
*/
|
|
366
|
-
listPaymentReminders(authorization?: string, filter?: string,
|
|
367
|
-
return localVarFp.listPaymentReminders(authorization, filter,
|
|
387
|
+
listPaymentReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentRemindersResponseClass> {
|
|
388
|
+
return localVarFp.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
368
389
|
},
|
|
369
390
|
};
|
|
370
391
|
};
|
|
@@ -419,22 +440,22 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
|
|
|
419
440
|
}
|
|
420
441
|
|
|
421
442
|
/**
|
|
422
|
-
* Request parameters for
|
|
443
|
+
* Request parameters for getPaymentReminder operation in PaymentRemindersApi.
|
|
423
444
|
* @export
|
|
424
|
-
* @interface
|
|
445
|
+
* @interface PaymentRemindersApiGetPaymentReminderRequest
|
|
425
446
|
*/
|
|
426
|
-
export interface
|
|
447
|
+
export interface PaymentRemindersApiGetPaymentReminderRequest {
|
|
427
448
|
/**
|
|
428
449
|
*
|
|
429
450
|
* @type {string}
|
|
430
|
-
* @memberof
|
|
451
|
+
* @memberof PaymentRemindersApiGetPaymentReminder
|
|
431
452
|
*/
|
|
432
453
|
readonly code: string
|
|
433
454
|
|
|
434
455
|
/**
|
|
435
456
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
436
457
|
* @type {string}
|
|
437
|
-
* @memberof
|
|
458
|
+
* @memberof PaymentRemindersApiGetPaymentReminder
|
|
438
459
|
*/
|
|
439
460
|
readonly authorization?: string
|
|
440
461
|
}
|
|
@@ -452,6 +473,20 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
452
473
|
*/
|
|
453
474
|
readonly authorization?: string
|
|
454
475
|
|
|
476
|
+
/**
|
|
477
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
478
|
+
* @type {number}
|
|
479
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
480
|
+
*/
|
|
481
|
+
readonly pageSize?: number
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* 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.
|
|
485
|
+
* @type {string}
|
|
486
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
487
|
+
*/
|
|
488
|
+
readonly pageToken?: string
|
|
489
|
+
|
|
455
490
|
/**
|
|
456
491
|
* 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, policyCode, nextReminderDate</i>
|
|
457
492
|
* @type {string}
|
|
@@ -460,11 +495,11 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
460
495
|
readonly filter?: string
|
|
461
496
|
|
|
462
497
|
/**
|
|
463
|
-
*
|
|
498
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
464
499
|
* @type {string}
|
|
465
500
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
466
501
|
*/
|
|
467
|
-
readonly
|
|
502
|
+
readonly search?: string
|
|
468
503
|
|
|
469
504
|
/**
|
|
470
505
|
* 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</i>
|
|
@@ -479,6 +514,13 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
479
514
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
480
515
|
*/
|
|
481
516
|
readonly expand?: string
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* 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, policyCode, nextReminderDate</i>
|
|
520
|
+
* @type {string}
|
|
521
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
522
|
+
*/
|
|
523
|
+
readonly filters?: string
|
|
482
524
|
}
|
|
483
525
|
|
|
484
526
|
/**
|
|
@@ -489,7 +531,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
489
531
|
*/
|
|
490
532
|
export class PaymentRemindersApi extends BaseAPI {
|
|
491
533
|
/**
|
|
492
|
-
* This will create a payment reminder in the database.
|
|
534
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
493
535
|
* @summary Create the payment reminder
|
|
494
536
|
* @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
|
|
495
537
|
* @param {*} [options] Override http request option.
|
|
@@ -501,7 +543,7 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
501
543
|
}
|
|
502
544
|
|
|
503
545
|
/**
|
|
504
|
-
* This will deactivate the payment reminder
|
|
546
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
505
547
|
* @summary Deactivate payment reminder
|
|
506
548
|
* @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
|
|
507
549
|
* @param {*} [options] Override http request option.
|
|
@@ -513,19 +555,19 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
513
555
|
}
|
|
514
556
|
|
|
515
557
|
/**
|
|
516
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
558
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
517
559
|
* @summary Retrieve the payment reminder
|
|
518
|
-
* @param {
|
|
560
|
+
* @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
|
|
519
561
|
* @param {*} [options] Override http request option.
|
|
520
562
|
* @throws {RequiredError}
|
|
521
563
|
* @memberof PaymentRemindersApi
|
|
522
564
|
*/
|
|
523
|
-
public
|
|
524
|
-
return PaymentRemindersApiFp(this.configuration).
|
|
565
|
+
public getPaymentReminder(requestParameters: PaymentRemindersApiGetPaymentReminderRequest, options?: AxiosRequestConfig) {
|
|
566
|
+
return PaymentRemindersApiFp(this.configuration).getPaymentReminder(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
525
567
|
}
|
|
526
568
|
|
|
527
569
|
/**
|
|
528
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
570
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
529
571
|
* @summary List payment reminders
|
|
530
572
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
531
573
|
* @param {*} [options] Override http request option.
|
|
@@ -533,6 +575,6 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
533
575
|
* @memberof PaymentRemindersApi
|
|
534
576
|
*/
|
|
535
577
|
public listPaymentReminders(requestParameters: PaymentRemindersApiListPaymentRemindersRequest = {}, options?: AxiosRequestConfig) {
|
|
536
|
-
return PaymentRemindersApiFp(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
578
|
+
return PaymentRemindersApiFp(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
537
579
|
}
|
|
538
580
|
}
|