@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.
Files changed (102) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +79 -37
  4. package/api/bank-orders-api.ts +691 -0
  5. package/api/bank-transaction-api.ts +187 -56
  6. package/api/payment-methods-api.ts +67 -25
  7. package/api/payment-reminders-api.ts +85 -43
  8. package/api/payment-setup-api.ts +8 -8
  9. package/api/payments-api.ts +67 -25
  10. package/api/refunds-api.ts +57 -29
  11. package/api/tenant-bank-account-api.ts +45 -17
  12. package/api/webhooks-api.ts +4 -4
  13. package/api.ts +2 -0
  14. package/base.ts +1 -1
  15. package/dist/api/bank-accounts-api.d.ts +59 -32
  16. package/dist/api/bank-accounts-api.js +53 -35
  17. package/dist/api/bank-orders-api.d.ts +393 -0
  18. package/dist/api/bank-orders-api.js +642 -0
  19. package/dist/api/bank-transaction-api.d.ts +123 -49
  20. package/dist/api/bank-transaction-api.js +151 -47
  21. package/dist/api/payment-methods-api.d.ts +47 -20
  22. package/dist/api/payment-methods-api.js +41 -23
  23. package/dist/api/payment-reminders-api.d.ts +61 -34
  24. package/dist/api/payment-reminders-api.js +54 -36
  25. package/dist/api/payment-setup-api.d.ts +8 -8
  26. package/dist/api/payment-setup-api.js +8 -8
  27. package/dist/api/payments-api.d.ts +47 -20
  28. package/dist/api/payments-api.js +41 -23
  29. package/dist/api/refunds-api.d.ts +40 -22
  30. package/dist/api/refunds-api.js +36 -24
  31. package/dist/api/tenant-bank-account-api.d.ts +28 -10
  32. package/dist/api/tenant-bank-account-api.js +24 -12
  33. package/dist/api/webhooks-api.d.ts +4 -4
  34. package/dist/api/webhooks-api.js +4 -4
  35. package/dist/api.d.ts +1 -0
  36. package/dist/api.js +1 -0
  37. package/dist/models/bank-order-class.d.ts +115 -0
  38. package/dist/models/bank-order-class.js +15 -0
  39. package/dist/models/bank-transaction-class-without-expand-properties.d.ts +8 -2
  40. package/dist/models/bank-transaction-class.d.ts +22 -2
  41. package/dist/models/create-bank-order-request-dto.d.ts +74 -0
  42. package/dist/models/create-bank-order-request-dto.js +28 -0
  43. package/dist/models/create-bank-order-response-class.d.ts +25 -0
  44. package/dist/models/create-bank-order-response-class.js +15 -0
  45. package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
  46. package/dist/models/create-payment-request-dto.d.ts +7 -1
  47. package/dist/models/create-psp-payment-method-request-dto.d.ts +7 -1
  48. package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
  49. package/dist/models/financial-account-class.d.ts +111 -0
  50. package/dist/models/financial-account-class.js +24 -0
  51. package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
  52. package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
  53. package/dist/models/get-bank-order-response-class.d.ts +25 -0
  54. package/dist/models/get-bank-order-response-class.js +15 -0
  55. package/dist/models/index.d.ts +11 -0
  56. package/dist/models/index.js +11 -0
  57. package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
  58. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
  59. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
  60. package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
  61. package/dist/models/invoice-match-suggestion-class.js +15 -0
  62. package/dist/models/list-bank-orders-response-class.d.ts +31 -0
  63. package/dist/models/list-bank-orders-response-class.js +15 -0
  64. package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
  65. package/dist/models/payment-class.d.ts +7 -1
  66. package/dist/models/payment-reminder-class.d.ts +7 -1
  67. package/dist/models/refund-class.d.ts +7 -1
  68. package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
  69. package/dist/models/suggestion-generation-progress-class.js +22 -0
  70. package/dist/models/unlinked-bank-transaction-response-class.d.ts +8 -2
  71. package/dist/models/update-bank-order-request-dto.d.ts +56 -0
  72. package/dist/models/update-bank-order-request-dto.js +23 -0
  73. package/dist/models/update-bank-order-response-class.d.ts +25 -0
  74. package/dist/models/update-bank-order-response-class.js +15 -0
  75. package/models/bank-order-class.ts +121 -0
  76. package/models/bank-transaction-class-without-expand-properties.ts +8 -2
  77. package/models/bank-transaction-class.ts +22 -2
  78. package/models/create-bank-order-request-dto.ts +84 -0
  79. package/models/create-bank-order-response-class.ts +31 -0
  80. package/models/create-payment-reminder-request-dto.ts +7 -1
  81. package/models/create-payment-request-dto.ts +7 -1
  82. package/models/create-psp-payment-method-request-dto.ts +7 -1
  83. package/models/deactivated-payment-reminder-class.ts +7 -1
  84. package/models/financial-account-class.ts +120 -0
  85. package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
  86. package/models/get-bank-order-response-class.ts +31 -0
  87. package/models/index.ts +11 -0
  88. package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
  89. package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
  90. package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
  91. package/models/invoice-match-suggestion-class.ts +66 -0
  92. package/models/list-bank-orders-response-class.ts +37 -0
  93. package/models/payment-class-without-expand-properties.ts +7 -1
  94. package/models/payment-class.ts +7 -1
  95. package/models/payment-reminder-class.ts +7 -1
  96. package/models/refund-class.ts +7 -1
  97. package/models/suggestion-generation-progress-class.ts +52 -0
  98. package/models/unlinked-bank-transaction-response-class.ts +8 -2
  99. package/models/update-bank-order-request-dto.ts +65 -0
  100. package/models/update-bank-order-response-class.ts +31 -0
  101. package/package.json +1 -1
  102. package/tsconfig.json +1 -0
@@ -35,7 +35,7 @@ import { ListPaymentMethodsResponseClass } from '../models';
35
35
  export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * 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.
38
+ * 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\"
39
39
  * @summary Create the payment method
40
40
  * @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
41
41
  * @param {string} [authorization] Bearer Token
@@ -82,7 +82,7 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
82
82
  };
83
83
  },
84
84
  /**
85
- * 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.
85
+ * 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\"
86
86
  * @summary Retrieve the payment method
87
87
  * @param {string} code
88
88
  * @param {string} [authorization] Bearer Token
@@ -127,17 +127,20 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
127
127
  };
128
128
  },
129
129
  /**
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.
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 {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.
133
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</i>
134
- * @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>
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</i>
137
140
  * @param {*} [options] Override http request option.
138
141
  * @throws {RequiredError}
139
142
  */
140
- listPaymentMethods: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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 (filters !== undefined) {
164
- localVarQueryParameter['filters'] = filters;
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
  }
@@ -198,7 +213,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
198
213
  const localVarAxiosParamCreator = PaymentMethodsApiAxiosParamCreator(configuration)
199
214
  return {
200
215
  /**
201
- * 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.
216
+ * 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\"
202
217
  * @summary Create the payment method
203
218
  * @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
204
219
  * @param {string} [authorization] Bearer Token
@@ -210,7 +225,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
210
225
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
211
226
  },
212
227
  /**
213
- * 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.
228
+ * 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\"
214
229
  * @summary Retrieve the payment method
215
230
  * @param {string} code
216
231
  * @param {string} [authorization] Bearer Token
@@ -222,18 +237,21 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
222
237
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
223
238
  },
224
239
  /**
225
- * 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.
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
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
228
245
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
229
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
246
+ * @param {string} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
249
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
232
250
  * @param {*} [options] Override http request option.
233
251
  * @throws {RequiredError}
234
252
  */
235
- async listPaymentMethods(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentMethodsResponseClass>> {
236
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentMethods(authorization, filter, filters, order, expand, options);
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
  }
@@ -247,7 +265,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
247
265
  const localVarFp = PaymentMethodsApiFp(configuration)
248
266
  return {
249
267
  /**
250
- * 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.
268
+ * 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\"
251
269
  * @summary Create the payment method
252
270
  * @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
253
271
  * @param {string} [authorization] Bearer Token
@@ -258,7 +276,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
258
276
  return localVarFp.createPaymentMethod(createPspPaymentMethodRequestDto, authorization, options).then((request) => request(axios, basePath));
259
277
  },
260
278
  /**
261
- * 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.
279
+ * 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\"
262
280
  * @summary Retrieve the payment method
263
281
  * @param {string} code
264
282
  * @param {string} [authorization] Bearer Token
@@ -269,18 +287,21 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
269
287
  return localVarFp.getPaymentMethod(code, authorization, options).then((request) => request(axios, basePath));
270
288
  },
271
289
  /**
272
- * 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.
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
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
275
295
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
276
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
296
+ * @param {string} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
299
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
279
300
  * @param {*} [options] Override http request option.
280
301
  * @throws {RequiredError}
281
302
  */
282
- listPaymentMethods(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPaymentMethodsResponseClass> {
283
- return localVarFp.listPaymentMethods(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
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
  };
@@ -340,6 +361,20 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
340
361
  */
341
362
  readonly authorization?: string
342
363
 
364
+ /**
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
373
+ * @type {string}
374
+ * @memberof PaymentMethodsApiListPaymentMethods
375
+ */
376
+ readonly pageToken?: string
377
+
343
378
  /**
344
379
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
345
380
  * @type {string}
@@ -348,11 +383,11 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
348
383
  readonly filter?: string
349
384
 
350
385
  /**
351
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
386
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
352
387
  * @type {string}
353
388
  * @memberof PaymentMethodsApiListPaymentMethods
354
389
  */
355
- readonly filters?: string
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
@@ -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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, productSlug&lt;/i&gt;
408
+ * @type {string}
409
+ * @memberof PaymentMethodsApiListPaymentMethods
410
+ */
411
+ readonly filters?: string
370
412
  }
371
413
 
372
414
  /**
@@ -377,7 +419,7 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
377
419
  */
378
420
  export class PaymentMethodsApi extends BaseAPI {
379
421
  /**
380
- * 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.
422
+ * 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\"
381
423
  * @summary Create the payment method
382
424
  * @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
383
425
  * @param {*} [options] Override http request option.
@@ -389,7 +431,7 @@ export class PaymentMethodsApi extends BaseAPI {
389
431
  }
390
432
 
391
433
  /**
392
- * 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.
434
+ * 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\"
393
435
  * @summary Retrieve the payment method
394
436
  * @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
395
437
  * @param {*} [options] Override http request option.
@@ -401,7 +443,7 @@ export class PaymentMethodsApi extends BaseAPI {
401
443
  }
402
444
 
403
445
  /**
404
- * 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.
446
+ * 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\"
405
447
  * @summary List payment methods
406
448
  * @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
407
449
  * @param {*} [options] Override http request option.
@@ -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.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
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
  }
@@ -39,7 +39,7 @@ import { ListPaymentRemindersResponseClass } from '../models';
39
39
  export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * This will create a payment reminder in the database.
42
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
43
43
  * @summary Create the payment reminder
44
44
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
45
45
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -86,7 +86,7 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
86
86
  };
87
87
  },
88
88
  /**
89
- * This will deactivate the payment reminder
89
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
90
90
  * @summary Deactivate payment reminder
91
91
  * @param {string} code Unique identifier for the object.
92
92
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -137,16 +137,16 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
137
137
  };
138
138
  },
139
139
  /**
140
- * 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.
140
+ * 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\"
141
141
  * @summary Retrieve the payment reminder
142
142
  * @param {string} code
143
143
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
144
  * @param {*} [options] Override http request option.
145
145
  * @throws {RequiredError}
146
146
  */
147
- getPolicy: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
147
+ getPaymentReminder: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
148
148
  // verify required parameter 'code' is not null or undefined
149
- assertParamExists('getPolicy', 'code', code)
149
+ assertParamExists('getPaymentReminder', 'code', code)
150
150
  const localVarPath = `/paymentservice/v1/payment-reminders/{code}`
151
151
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
152
152
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -182,17 +182,20 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
182
182
  };
183
183
  },
184
184
  /**
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.
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
189
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
191
+ * @param {string} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
194
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
192
195
  * @param {*} [options] Override http request option.
193
196
  * @throws {RequiredError}
194
197
  */
195
- listPaymentReminders: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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 (filters !== undefined) {
219
- localVarQueryParameter['filters'] = filters;
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
  }
@@ -253,7 +268,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
253
268
  const localVarAxiosParamCreator = PaymentRemindersApiAxiosParamCreator(configuration)
254
269
  return {
255
270
  /**
256
- * This will create a payment reminder in the database.
271
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
257
272
  * @summary Create the payment reminder
258
273
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
259
274
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -265,7 +280,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
265
280
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
266
281
  },
267
282
  /**
268
- * This will deactivate the payment reminder
283
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
269
284
  * @summary Deactivate payment reminder
270
285
  * @param {string} code Unique identifier for the object.
271
286
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -278,30 +293,33 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
278
293
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
279
294
  },
280
295
  /**
281
- * 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.
296
+ * 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\"
282
297
  * @summary Retrieve the payment reminder
283
298
  * @param {string} code
284
299
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
285
300
  * @param {*} [options] Override http request option.
286
301
  * @throws {RequiredError}
287
302
  */
288
- async getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>> {
289
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPolicy(code, authorization, options);
303
+ async getPaymentReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>> {
304
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentReminder(code, authorization, options);
290
305
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
291
306
  },
292
307
  /**
293
- * 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.
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
297
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
314
+ * @param {string} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
317
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
300
318
  * @param {*} [options] Override http request option.
301
319
  * @throws {RequiredError}
302
320
  */
303
- async listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentRemindersResponseClass>> {
304
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization, filter, filters, order, expand, options);
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
  }
@@ -315,7 +333,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
315
333
  const localVarFp = PaymentRemindersApiFp(configuration)
316
334
  return {
317
335
  /**
318
- * This will create a payment reminder in the database.
336
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
319
337
  * @summary Create the payment reminder
320
338
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
321
339
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -326,7 +344,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
326
344
  return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
327
345
  },
328
346
  /**
329
- * This will deactivate the payment reminder
347
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
330
348
  * @summary Deactivate payment reminder
331
349
  * @param {string} code Unique identifier for the object.
332
350
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -338,29 +356,32 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
338
356
  return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
339
357
  },
340
358
  /**
341
- * 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.
359
+ * 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\"
342
360
  * @summary Retrieve the payment reminder
343
361
  * @param {string} code
344
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
345
363
  * @param {*} [options] Override http request option.
346
364
  * @throws {RequiredError}
347
365
  */
348
- getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass> {
349
- return localVarFp.getPolicy(code, authorization, options).then((request) => request(axios, basePath));
366
+ getPaymentReminder(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass> {
367
+ return localVarFp.getPaymentReminder(code, authorization, options).then((request) => request(axios, basePath));
350
368
  },
351
369
  /**
352
- * 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.
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
356
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
376
+ * @param {string} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
379
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
359
380
  * @param {*} [options] Override http request option.
360
381
  * @throws {RequiredError}
361
382
  */
362
- listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPaymentRemindersResponseClass> {
363
- return localVarFp.listPaymentReminders(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
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
  };
@@ -415,22 +436,22 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
415
436
  }
416
437
 
417
438
  /**
418
- * Request parameters for getPolicy operation in PaymentRemindersApi.
439
+ * Request parameters for getPaymentReminder operation in PaymentRemindersApi.
419
440
  * @export
420
- * @interface PaymentRemindersApiGetPolicyRequest
441
+ * @interface PaymentRemindersApiGetPaymentReminderRequest
421
442
  */
422
- export interface PaymentRemindersApiGetPolicyRequest {
443
+ export interface PaymentRemindersApiGetPaymentReminderRequest {
423
444
  /**
424
445
  *
425
446
  * @type {string}
426
- * @memberof PaymentRemindersApiGetPolicy
447
+ * @memberof PaymentRemindersApiGetPaymentReminder
427
448
  */
428
449
  readonly code: string
429
450
 
430
451
  /**
431
452
  * Bearer Token: provided by the login endpoint under the name accessToken.
432
453
  * @type {string}
433
- * @memberof PaymentRemindersApiGetPolicy
454
+ * @memberof PaymentRemindersApiGetPaymentReminder
434
455
  */
435
456
  readonly authorization?: string
436
457
  }
@@ -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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
453
488
  * @type {string}
@@ -456,11 +491,11 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
456
491
  readonly filter?: string
457
492
 
458
493
  /**
459
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
494
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
460
495
  * @type {string}
461
496
  * @memberof PaymentRemindersApiListPaymentReminders
462
497
  */
463
- readonly filters?: string
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
@@ -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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
516
+ * @type {string}
517
+ * @memberof PaymentRemindersApiListPaymentReminders
518
+ */
519
+ readonly filters?: string
478
520
  }
479
521
 
480
522
  /**
@@ -485,7 +527,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
485
527
  */
486
528
  export class PaymentRemindersApi extends BaseAPI {
487
529
  /**
488
- * This will create a payment reminder in the database.
530
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
489
531
  * @summary Create the payment reminder
490
532
  * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
491
533
  * @param {*} [options] Override http request option.
@@ -497,7 +539,7 @@ export class PaymentRemindersApi extends BaseAPI {
497
539
  }
498
540
 
499
541
  /**
500
- * This will deactivate the payment reminder
542
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
501
543
  * @summary Deactivate payment reminder
502
544
  * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
503
545
  * @param {*} [options] Override http request option.
@@ -509,19 +551,19 @@ export class PaymentRemindersApi extends BaseAPI {
509
551
  }
510
552
 
511
553
  /**
512
- * 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.
554
+ * 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\"
513
555
  * @summary Retrieve the payment reminder
514
- * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
556
+ * @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
515
557
  * @param {*} [options] Override http request option.
516
558
  * @throws {RequiredError}
517
559
  * @memberof PaymentRemindersApi
518
560
  */
519
- public getPolicy(requestParameters: PaymentRemindersApiGetPolicyRequest, options?: AxiosRequestConfig) {
520
- return PaymentRemindersApiFp(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
561
+ public getPaymentReminder(requestParameters: PaymentRemindersApiGetPaymentReminderRequest, options?: AxiosRequestConfig) {
562
+ return PaymentRemindersApiFp(this.configuration).getPaymentReminder(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
521
563
  }
522
564
 
523
565
  /**
524
- * 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.
566
+ * 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\"
525
567
  * @summary List payment reminders
526
568
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
527
569
  * @param {*} [options] Override http request option.
@@ -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.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
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
  }