@emilgroup/payment-sdk 1.13.1-beta.8 → 1.13.1-beta.81
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +20 -1
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +177 -63
- package/api/payment-methods-api.ts +59 -17
- package/api/payment-reminders-api.ts +55 -13
- package/api/payments-api.ts +188 -21
- package/api/refunds-api.ts +45 -17
- package/api/tenant-bank-account-api.ts +45 -17
- package/api.ts +2 -0
- package/base.ts +52 -3
- package/dist/api/bank-accounts-api.d.ts +35 -8
- package/dist/api/bank-accounts-api.js +29 -11
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +642 -0
- package/dist/api/bank-transaction-api.d.ts +110 -46
- package/dist/api/bank-transaction-api.js +141 -44
- package/dist/api/payment-methods-api.d.ts +39 -12
- package/dist/api/payment-methods-api.js +32 -14
- package/dist/api/payment-reminders-api.d.ts +35 -8
- package/dist/api/payment-reminders-api.js +29 -11
- package/dist/api/payments-api.d.ts +112 -16
- package/dist/api/payments-api.js +141 -18
- package/dist/api/refunds-api.d.ts +28 -10
- package/dist/api/refunds-api.js +24 -12
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +10 -1
- package/dist/base.js +46 -2
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +30 -11
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +47 -14
- package/dist/models/bank-transaction-class.js +5 -0
- package/dist/models/bank-transaction-invoice-class.d.ts +54 -0
- package/dist/models/bank-transaction-invoice-class.js +15 -0
- package/dist/models/bank-transfer-dto.d.ts +25 -0
- package/dist/models/bank-transfer-dto.js +15 -0
- package/dist/models/billing-address-dto.d.ts +48 -0
- package/dist/models/billing-address-dto.js +15 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.js +3 -1
- package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +3 -1
- package/dist/models/create-bank-order-request-dto.d.ts +74 -0
- package/dist/models/create-bank-order-request-dto.js +28 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/create-payment-order-dto.d.ts +48 -0
- package/dist/models/create-payment-order-dto.js +15 -0
- package/dist/models/create-payment-order-request-dto.d.ts +48 -0
- package/dist/models/create-payment-order-request-dto.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-psp-payment-method-request-dto.d.ts +22 -1
- package/dist/models/create-psp-payment-method-request-dto.js +3 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/index.d.ts +19 -1
- package/dist/models/index.js +19 -1
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → invoice-allocation-dto.d.ts} +10 -4
- package/dist/models/invoice-allocation-dto.js +15 -0
- package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
- package/dist/models/invoice-match-suggestion-class.js +15 -0
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +4 -3
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-method-class.d.ts +6 -0
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
- package/dist/models/suggestion-generation-progress-class.js +22 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +33 -2
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
- package/dist/models/update-bank-order-request-dto.d.ts +62 -0
- package/dist/models/update-bank-order-request-dto.js +23 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +121 -0
- package/models/bank-transaction-class-without-expand-properties.ts +33 -11
- package/models/bank-transaction-class.ts +50 -14
- package/models/bank-transaction-invoice-class.ts +60 -0
- package/models/bank-transfer-dto.ts +31 -0
- package/models/billing-address-dto.ts +54 -0
- package/models/complete-adyen-payment-setup-request-dto.ts +3 -1
- package/models/complete-eis-payment-setup-request-dto.ts +42 -0
- package/models/complete-payment-setup-request-dto.ts +7 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +3 -1
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-order-dto.ts +54 -0
- package/models/create-payment-order-request-dto.ts +54 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-psp-payment-method-request-dto.ts +23 -2
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/financial-account-class.ts +120 -0
- package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/index.ts +19 -1
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-eis-payment-setup-request-dto.ts +42 -0
- package/models/initiate-payment-setup-request-dto.ts +3 -2
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/{unlink-bank-transaction-request-dto-rest.ts → invoice-allocation-dto.ts} +10 -4
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/link-bank-transaction-request-dto-rest.ts +4 -3
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-method-class.ts +6 -0
- package/models/payment-reminder-class.ts +7 -1
- package/models/refund-class.ts +7 -1
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/models/unlinked-bank-transaction-response-class.ts +36 -2
- package/models/update-bank-order-request-dto.ts +71 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
- /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → bank-order-class.js} +0 -0
|
@@ -130,14 +130,17 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
130
130
|
* 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\"
|
|
131
131
|
* @summary List payment methods
|
|
132
132
|
* @param {string} [authorization] Bearer Token
|
|
133
|
-
* @param {
|
|
134
|
-
* @param {string} [
|
|
133
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
134
|
+
* @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.
|
|
135
|
+
* @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, accountCode, partnerCode</i>
|
|
136
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
135
137
|
* @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>
|
|
136
138
|
* @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/>
|
|
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, pspCustomerId, psp, type, productSlug, accountCode, partnerCode</i>
|
|
137
140
|
* @param {*} [options] Override http request option.
|
|
138
141
|
* @throws {RequiredError}
|
|
139
142
|
*/
|
|
140
|
-
listPaymentMethods: async (authorization?: string, filter?: string,
|
|
143
|
+
listPaymentMethods: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
141
144
|
const localVarPath = `/paymentservice/v1/payment-methods`;
|
|
142
145
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
143
146
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -156,12 +159,20 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
156
159
|
// http bearer authentication required
|
|
157
160
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
158
161
|
|
|
162
|
+
if (pageSize !== undefined) {
|
|
163
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
if (pageToken !== undefined) {
|
|
167
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
168
|
+
}
|
|
169
|
+
|
|
159
170
|
if (filter !== undefined) {
|
|
160
171
|
localVarQueryParameter['filter'] = filter;
|
|
161
172
|
}
|
|
162
173
|
|
|
163
|
-
if (
|
|
164
|
-
localVarQueryParameter['
|
|
174
|
+
if (search !== undefined) {
|
|
175
|
+
localVarQueryParameter['search'] = search;
|
|
165
176
|
}
|
|
166
177
|
|
|
167
178
|
if (order !== undefined) {
|
|
@@ -172,6 +183,10 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
172
183
|
localVarQueryParameter['expand'] = expand;
|
|
173
184
|
}
|
|
174
185
|
|
|
186
|
+
if (filters !== undefined) {
|
|
187
|
+
localVarQueryParameter['filters'] = filters;
|
|
188
|
+
}
|
|
189
|
+
|
|
175
190
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
176
191
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
177
192
|
}
|
|
@@ -225,15 +240,18 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
225
240
|
* 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\"
|
|
226
241
|
* @summary List payment methods
|
|
227
242
|
* @param {string} [authorization] Bearer Token
|
|
228
|
-
* @param {
|
|
229
|
-
* @param {string} [
|
|
243
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
244
|
+
* @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.
|
|
245
|
+
* @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, accountCode, partnerCode</i>
|
|
246
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
230
247
|
* @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>
|
|
231
248
|
* @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/>
|
|
249
|
+
* @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, accountCode, partnerCode</i>
|
|
232
250
|
* @param {*} [options] Override http request option.
|
|
233
251
|
* @throws {RequiredError}
|
|
234
252
|
*/
|
|
235
|
-
async listPaymentMethods(authorization?: string, filter?: string,
|
|
236
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentMethods(authorization, filter,
|
|
253
|
+
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>> {
|
|
254
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
237
255
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
238
256
|
},
|
|
239
257
|
}
|
|
@@ -272,15 +290,18 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
272
290
|
* 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\"
|
|
273
291
|
* @summary List payment methods
|
|
274
292
|
* @param {string} [authorization] Bearer Token
|
|
275
|
-
* @param {
|
|
276
|
-
* @param {string} [
|
|
293
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
294
|
+
* @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.
|
|
295
|
+
* @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, accountCode, partnerCode</i>
|
|
296
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
277
297
|
* @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>
|
|
278
298
|
* @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/>
|
|
299
|
+
* @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, accountCode, partnerCode</i>
|
|
279
300
|
* @param {*} [options] Override http request option.
|
|
280
301
|
* @throws {RequiredError}
|
|
281
302
|
*/
|
|
282
|
-
listPaymentMethods(authorization?: string, filter?: string,
|
|
283
|
-
return localVarFp.listPaymentMethods(authorization, filter,
|
|
303
|
+
listPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentMethodsResponseClass> {
|
|
304
|
+
return localVarFp.listPaymentMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
284
305
|
},
|
|
285
306
|
};
|
|
286
307
|
};
|
|
@@ -341,18 +362,32 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
341
362
|
readonly authorization?: string
|
|
342
363
|
|
|
343
364
|
/**
|
|
344
|
-
*
|
|
365
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
366
|
+
* @type {number}
|
|
367
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
368
|
+
*/
|
|
369
|
+
readonly pageSize?: number
|
|
370
|
+
|
|
371
|
+
/**
|
|
372
|
+
* 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.
|
|
373
|
+
* @type {string}
|
|
374
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
375
|
+
*/
|
|
376
|
+
readonly pageToken?: string
|
|
377
|
+
|
|
378
|
+
/**
|
|
379
|
+
* 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, accountCode, partnerCode</i>
|
|
345
380
|
* @type {string}
|
|
346
381
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
347
382
|
*/
|
|
348
383
|
readonly filter?: string
|
|
349
384
|
|
|
350
385
|
/**
|
|
351
|
-
*
|
|
386
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
352
387
|
* @type {string}
|
|
353
388
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
354
389
|
*/
|
|
355
|
-
readonly
|
|
390
|
+
readonly search?: string
|
|
356
391
|
|
|
357
392
|
/**
|
|
358
393
|
* 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>
|
|
@@ -367,6 +402,13 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
367
402
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
368
403
|
*/
|
|
369
404
|
readonly expand?: string
|
|
405
|
+
|
|
406
|
+
/**
|
|
407
|
+
* 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, accountCode, partnerCode</i>
|
|
408
|
+
* @type {string}
|
|
409
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
410
|
+
*/
|
|
411
|
+
readonly filters?: string
|
|
370
412
|
}
|
|
371
413
|
|
|
372
414
|
/**
|
|
@@ -409,6 +451,6 @@ export class PaymentMethodsApi extends BaseAPI {
|
|
|
409
451
|
* @memberof PaymentMethodsApi
|
|
410
452
|
*/
|
|
411
453
|
public listPaymentMethods(requestParameters: PaymentMethodsApiListPaymentMethodsRequest = {}, options?: AxiosRequestConfig) {
|
|
412
|
-
return PaymentMethodsApiFp(this.configuration).listPaymentMethods(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
454
|
+
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));
|
|
413
455
|
}
|
|
414
456
|
}
|
|
@@ -185,14 +185,17 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
185
185
|
* 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\"
|
|
186
186
|
* @summary List payment reminders
|
|
187
187
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
188
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
189
|
+
* @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.
|
|
188
190
|
* @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>
|
|
189
|
-
* @param {string} [
|
|
191
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
190
192
|
* @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>
|
|
191
193
|
* @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/>
|
|
194
|
+
* @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>
|
|
192
195
|
* @param {*} [options] Override http request option.
|
|
193
196
|
* @throws {RequiredError}
|
|
194
197
|
*/
|
|
195
|
-
listPaymentReminders: async (authorization?: string, filter?: string,
|
|
198
|
+
listPaymentReminders: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
196
199
|
const localVarPath = `/paymentservice/v1/payment-reminders`;
|
|
197
200
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
198
201
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -211,12 +214,20 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
211
214
|
// http bearer authentication required
|
|
212
215
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
213
216
|
|
|
217
|
+
if (pageSize !== undefined) {
|
|
218
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
if (pageToken !== undefined) {
|
|
222
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
223
|
+
}
|
|
224
|
+
|
|
214
225
|
if (filter !== undefined) {
|
|
215
226
|
localVarQueryParameter['filter'] = filter;
|
|
216
227
|
}
|
|
217
228
|
|
|
218
|
-
if (
|
|
219
|
-
localVarQueryParameter['
|
|
229
|
+
if (search !== undefined) {
|
|
230
|
+
localVarQueryParameter['search'] = search;
|
|
220
231
|
}
|
|
221
232
|
|
|
222
233
|
if (order !== undefined) {
|
|
@@ -227,6 +238,10 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
227
238
|
localVarQueryParameter['expand'] = expand;
|
|
228
239
|
}
|
|
229
240
|
|
|
241
|
+
if (filters !== undefined) {
|
|
242
|
+
localVarQueryParameter['filters'] = filters;
|
|
243
|
+
}
|
|
244
|
+
|
|
230
245
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
231
246
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
232
247
|
}
|
|
@@ -293,15 +308,18 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
293
308
|
* 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\"
|
|
294
309
|
* @summary List payment reminders
|
|
295
310
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
311
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
312
|
+
* @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.
|
|
296
313
|
* @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>
|
|
297
|
-
* @param {string} [
|
|
314
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
298
315
|
* @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>
|
|
299
316
|
* @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/>
|
|
317
|
+
* @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>
|
|
300
318
|
* @param {*} [options] Override http request option.
|
|
301
319
|
* @throws {RequiredError}
|
|
302
320
|
*/
|
|
303
|
-
async listPaymentReminders(authorization?: string, filter?: string,
|
|
304
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization, filter,
|
|
321
|
+
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>> {
|
|
322
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
305
323
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
306
324
|
},
|
|
307
325
|
}
|
|
@@ -352,15 +370,18 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
352
370
|
* 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\"
|
|
353
371
|
* @summary List payment reminders
|
|
354
372
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
373
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
374
|
+
* @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.
|
|
355
375
|
* @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>
|
|
356
|
-
* @param {string} [
|
|
376
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
357
377
|
* @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>
|
|
358
378
|
* @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/>
|
|
379
|
+
* @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>
|
|
359
380
|
* @param {*} [options] Override http request option.
|
|
360
381
|
* @throws {RequiredError}
|
|
361
382
|
*/
|
|
362
|
-
listPaymentReminders(authorization?: string, filter?: string,
|
|
363
|
-
return localVarFp.listPaymentReminders(authorization, filter,
|
|
383
|
+
listPaymentReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentRemindersResponseClass> {
|
|
384
|
+
return localVarFp.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
364
385
|
},
|
|
365
386
|
};
|
|
366
387
|
};
|
|
@@ -448,6 +469,20 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
448
469
|
*/
|
|
449
470
|
readonly authorization?: string
|
|
450
471
|
|
|
472
|
+
/**
|
|
473
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
474
|
+
* @type {number}
|
|
475
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
476
|
+
*/
|
|
477
|
+
readonly pageSize?: number
|
|
478
|
+
|
|
479
|
+
/**
|
|
480
|
+
* 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.
|
|
481
|
+
* @type {string}
|
|
482
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
483
|
+
*/
|
|
484
|
+
readonly pageToken?: string
|
|
485
|
+
|
|
451
486
|
/**
|
|
452
487
|
* 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>
|
|
453
488
|
* @type {string}
|
|
@@ -456,11 +491,11 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
456
491
|
readonly filter?: string
|
|
457
492
|
|
|
458
493
|
/**
|
|
459
|
-
*
|
|
494
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
460
495
|
* @type {string}
|
|
461
496
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
462
497
|
*/
|
|
463
|
-
readonly
|
|
498
|
+
readonly search?: string
|
|
464
499
|
|
|
465
500
|
/**
|
|
466
501
|
* 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>
|
|
@@ -475,6 +510,13 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
475
510
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
476
511
|
*/
|
|
477
512
|
readonly expand?: string
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* 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>
|
|
516
|
+
* @type {string}
|
|
517
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
518
|
+
*/
|
|
519
|
+
readonly filters?: string
|
|
478
520
|
}
|
|
479
521
|
|
|
480
522
|
/**
|
|
@@ -529,6 +571,6 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
529
571
|
* @memberof PaymentRemindersApi
|
|
530
572
|
*/
|
|
531
573
|
public listPaymentReminders(requestParameters: PaymentRemindersApiListPaymentRemindersRequest = {}, options?: AxiosRequestConfig) {
|
|
532
|
-
return PaymentRemindersApiFp(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
574
|
+
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));
|
|
533
575
|
}
|
|
534
576
|
}
|