@emilgroup/payment-sdk 1.4.1-beta.15 → 1.4.1-beta.17

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 (42) hide show
  1. package/.openapi-generator/FILES +5 -0
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +346 -22
  4. package/api/bank-transaction-api.ts +12 -12
  5. package/api/payment-methods-api.ts +38 -145
  6. package/api/payment-reminders-api.ts +12 -12
  7. package/api/payments-api.ts +42 -45
  8. package/api/refunds-api.ts +4 -4
  9. package/api/tenant-bank-account-api.ts +20 -20
  10. package/dist/api/bank-accounts-api.d.ts +193 -16
  11. package/dist/api/bank-accounts-api.js +302 -19
  12. package/dist/api/bank-transaction-api.d.ts +12 -12
  13. package/dist/api/bank-transaction-api.js +11 -11
  14. package/dist/api/payment-methods-api.d.ts +29 -84
  15. package/dist/api/payment-methods-api.js +33 -129
  16. package/dist/api/payment-reminders-api.d.ts +12 -12
  17. package/dist/api/payment-reminders-api.js +11 -11
  18. package/dist/api/payments-api.d.ts +33 -33
  19. package/dist/api/payments-api.js +37 -39
  20. package/dist/api/refunds-api.d.ts +4 -4
  21. package/dist/api/refunds-api.js +3 -3
  22. package/dist/api/tenant-bank-account-api.d.ts +20 -20
  23. package/dist/api/tenant-bank-account-api.js +14 -14
  24. package/dist/models/bank-account-class.d.ts +67 -0
  25. package/dist/models/bank-account-class.js +15 -0
  26. package/dist/models/create-bank-account-request-dto.d.ts +30 -0
  27. package/dist/models/create-bank-account-request-dto.js +15 -0
  28. package/dist/models/get-bank-account-response-class.d.ts +25 -0
  29. package/dist/models/get-bank-account-response-class.js +15 -0
  30. package/dist/models/index.d.ts +5 -0
  31. package/dist/models/index.js +5 -0
  32. package/dist/models/primary-bank-account-response-class.d.ts +42 -0
  33. package/dist/models/primary-bank-account-response-class.js +15 -0
  34. package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
  35. package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
  36. package/models/bank-account-class.ts +73 -0
  37. package/models/create-bank-account-request-dto.ts +36 -0
  38. package/models/get-bank-account-response-class.ts +31 -0
  39. package/models/index.ts +5 -0
  40. package/models/primary-bank-account-response-class.ts +48 -0
  41. package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
  42. package/package.json +1 -1
@@ -94,7 +94,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
94
94
  return {
95
95
  /**
96
96
  * 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.
97
- * @summary Create the payment-method
97
+ * @summary Create the payment method
98
98
  * @param {object} body
99
99
  * @param {string} [authorization] Bearer Token
100
100
  * @param {*} [options] Override http request option.
@@ -141,67 +141,17 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
141
141
  });
142
142
  });
143
143
  },
144
- /**
145
- * Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
146
- * @summary Delete a payment method
147
- * @param {number} id Unique identifier for payment method
148
- * @param {string} [authorization] Bearer Token
149
- * @param {*} [options] Override http request option.
150
- * @throws {RequiredError}
151
- */
152
- deletePaymentMethod: function (id, authorization, options) {
153
- if (options === void 0) { options = {}; }
154
- return __awaiter(_this, void 0, void 0, function () {
155
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
156
- return __generator(this, function (_a) {
157
- switch (_a.label) {
158
- case 0:
159
- // verify required parameter 'id' is not null or undefined
160
- (0, common_1.assertParamExists)('deletePaymentMethod', 'id', id);
161
- localVarPath = "/paymentservice/v1/payment-methods/{id}";
162
- localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
163
- if (configuration) {
164
- baseOptions = configuration.baseOptions;
165
- baseAccessToken = configuration.accessToken;
166
- }
167
- localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
168
- localVarHeaderParameter = {};
169
- localVarQueryParameter = {};
170
- // authentication bearer required
171
- // http bearer authentication required
172
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
173
- case 1:
174
- // authentication bearer required
175
- // http bearer authentication required
176
- _a.sent();
177
- if (id !== undefined) {
178
- localVarQueryParameter['id'] = id;
179
- }
180
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
181
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
182
- }
183
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
184
- headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
185
- localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
186
- return [2 /*return*/, {
187
- url: (0, common_1.toPathString)(localVarUrlObj),
188
- options: localVarRequestOptions,
189
- }];
190
- }
191
- });
192
- });
193
- },
194
144
  /**
195
145
  * Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
196
- * @summary Retrieve a payment method
197
- * @param {string} code Unique identifier for the object.
146
+ * @summary Retrieve the payment method
147
+ * @param {string} code
148
+ * @param {string} code2 Unique identifier for the object.
198
149
  * @param {string} expand Fields to expand response by
199
- * @param {string} expand2 Fields to expand response by
200
150
  * @param {string} [authorization] Bearer Token
201
151
  * @param {*} [options] Override http request option.
202
152
  * @throws {RequiredError}
203
153
  */
204
- getPaymentMethod: function (code, expand, expand2, authorization, options) {
154
+ getPaymentMethod: function (code, code2, expand, authorization, options) {
205
155
  if (options === void 0) { options = {}; }
206
156
  return __awaiter(_this, void 0, void 0, function () {
207
157
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -210,11 +160,12 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
210
160
  case 0:
211
161
  // verify required parameter 'code' is not null or undefined
212
162
  (0, common_1.assertParamExists)('getPaymentMethod', 'code', code);
163
+ // verify required parameter 'code2' is not null or undefined
164
+ (0, common_1.assertParamExists)('getPaymentMethod', 'code2', code2);
213
165
  // verify required parameter 'expand' is not null or undefined
214
166
  (0, common_1.assertParamExists)('getPaymentMethod', 'expand', expand);
215
- // verify required parameter 'expand2' is not null or undefined
216
- (0, common_1.assertParamExists)('getPaymentMethod', 'expand2', expand2);
217
- localVarPath = "/paymentservice/v1/payment-methods/{code}";
167
+ localVarPath = "/paymentservice/v1/payment-methods/{code}"
168
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
218
169
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
219
170
  if (configuration) {
220
171
  baseOptions = configuration.baseOptions;
@@ -230,15 +181,12 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
230
181
  // authentication bearer required
231
182
  // http bearer authentication required
232
183
  _a.sent();
233
- if (code !== undefined) {
234
- localVarQueryParameter['code'] = code;
184
+ if (code2 !== undefined) {
185
+ localVarQueryParameter['code'] = code2;
235
186
  }
236
187
  if (expand !== undefined) {
237
188
  localVarQueryParameter['expand'] = expand;
238
189
  }
239
- if (expand2 !== undefined) {
240
- localVarQueryParameter['expand'] = expand2;
241
- }
242
190
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
243
191
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
244
192
  }
@@ -254,13 +202,13 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
254
202
  });
255
203
  },
256
204
  /**
257
- * Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
205
+ * 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.
258
206
  * @summary List payment methods
259
207
  * @param {string} [authorization] Bearer Token
260
208
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
261
209
  * @param {any} [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.
262
210
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
263
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
211
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
264
212
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
265
213
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
266
214
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -337,7 +285,7 @@ var PaymentMethodsApiFp = function (configuration) {
337
285
  return {
338
286
  /**
339
287
  * 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.
340
- * @summary Create the payment-method
288
+ * @summary Create the payment method
341
289
  * @param {object} body
342
290
  * @param {string} [authorization] Bearer Token
343
291
  * @param {*} [options] Override http request option.
@@ -356,43 +304,22 @@ var PaymentMethodsApiFp = function (configuration) {
356
304
  });
357
305
  });
358
306
  },
359
- /**
360
- * Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
361
- * @summary Delete a payment method
362
- * @param {number} id Unique identifier for payment method
363
- * @param {string} [authorization] Bearer Token
364
- * @param {*} [options] Override http request option.
365
- * @throws {RequiredError}
366
- */
367
- deletePaymentMethod: function (id, authorization, options) {
368
- return __awaiter(this, void 0, void 0, function () {
369
- var localVarAxiosArgs;
370
- return __generator(this, function (_a) {
371
- switch (_a.label) {
372
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.deletePaymentMethod(id, authorization, options)];
373
- case 1:
374
- localVarAxiosArgs = _a.sent();
375
- return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
376
- }
377
- });
378
- });
379
- },
380
307
  /**
381
308
  * Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
382
- * @summary Retrieve a payment method
383
- * @param {string} code Unique identifier for the object.
309
+ * @summary Retrieve the payment method
310
+ * @param {string} code
311
+ * @param {string} code2 Unique identifier for the object.
384
312
  * @param {string} expand Fields to expand response by
385
- * @param {string} expand2 Fields to expand response by
386
313
  * @param {string} [authorization] Bearer Token
387
314
  * @param {*} [options] Override http request option.
388
315
  * @throws {RequiredError}
389
316
  */
390
- getPaymentMethod: function (code, expand, expand2, authorization, options) {
317
+ getPaymentMethod: function (code, code2, expand, authorization, options) {
391
318
  return __awaiter(this, void 0, void 0, function () {
392
319
  var localVarAxiosArgs;
393
320
  return __generator(this, function (_a) {
394
321
  switch (_a.label) {
395
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPaymentMethod(code, expand, expand2, authorization, options)];
322
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPaymentMethod(code, code2, expand, authorization, options)];
396
323
  case 1:
397
324
  localVarAxiosArgs = _a.sent();
398
325
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -401,13 +328,13 @@ var PaymentMethodsApiFp = function (configuration) {
401
328
  });
402
329
  },
403
330
  /**
404
- * Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
331
+ * 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.
405
332
  * @summary List payment methods
406
333
  * @param {string} [authorization] Bearer Token
407
334
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
408
335
  * @param {any} [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.
409
336
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
410
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
337
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
411
338
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
412
339
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
413
340
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -439,7 +366,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
439
366
  return {
440
367
  /**
441
368
  * 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.
442
- * @summary Create the payment-method
369
+ * @summary Create the payment method
443
370
  * @param {object} body
444
371
  * @param {string} [authorization] Bearer Token
445
372
  * @param {*} [options] Override http request option.
@@ -448,38 +375,27 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
448
375
  createPaymentMethod: function (body, authorization, options) {
449
376
  return localVarFp.createPaymentMethod(body, authorization, options).then(function (request) { return request(axios, basePath); });
450
377
  },
451
- /**
452
- * Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
453
- * @summary Delete a payment method
454
- * @param {number} id Unique identifier for payment method
455
- * @param {string} [authorization] Bearer Token
456
- * @param {*} [options] Override http request option.
457
- * @throws {RequiredError}
458
- */
459
- deletePaymentMethod: function (id, authorization, options) {
460
- return localVarFp.deletePaymentMethod(id, authorization, options).then(function (request) { return request(axios, basePath); });
461
- },
462
378
  /**
463
379
  * Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
464
- * @summary Retrieve a payment method
465
- * @param {string} code Unique identifier for the object.
380
+ * @summary Retrieve the payment method
381
+ * @param {string} code
382
+ * @param {string} code2 Unique identifier for the object.
466
383
  * @param {string} expand Fields to expand response by
467
- * @param {string} expand2 Fields to expand response by
468
384
  * @param {string} [authorization] Bearer Token
469
385
  * @param {*} [options] Override http request option.
470
386
  * @throws {RequiredError}
471
387
  */
472
- getPaymentMethod: function (code, expand, expand2, authorization, options) {
473
- return localVarFp.getPaymentMethod(code, expand, expand2, authorization, options).then(function (request) { return request(axios, basePath); });
388
+ getPaymentMethod: function (code, code2, expand, authorization, options) {
389
+ return localVarFp.getPaymentMethod(code, code2, expand, authorization, options).then(function (request) { return request(axios, basePath); });
474
390
  },
475
391
  /**
476
- * Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
392
+ * 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.
477
393
  * @summary List payment methods
478
394
  * @param {string} [authorization] Bearer Token
479
395
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
480
396
  * @param {any} [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.
481
397
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
482
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
398
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
483
399
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
484
400
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
485
401
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -505,7 +421,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
505
421
  }
506
422
  /**
507
423
  * 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.
508
- * @summary Create the payment-method
424
+ * @summary Create the payment method
509
425
  * @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
510
426
  * @param {*} [options] Override http request option.
511
427
  * @throws {RequiredError}
@@ -515,21 +431,9 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
515
431
  var _this = this;
516
432
  return (0, exports.PaymentMethodsApiFp)(this.configuration).createPaymentMethod(requestParameters.body, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
517
433
  };
518
- /**
519
- * Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
520
- * @summary Delete a payment method
521
- * @param {PaymentMethodsApiDeletePaymentMethodRequest} requestParameters Request parameters.
522
- * @param {*} [options] Override http request option.
523
- * @throws {RequiredError}
524
- * @memberof PaymentMethodsApi
525
- */
526
- PaymentMethodsApi.prototype.deletePaymentMethod = function (requestParameters, options) {
527
- var _this = this;
528
- return (0, exports.PaymentMethodsApiFp)(this.configuration).deletePaymentMethod(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
529
- };
530
434
  /**
531
435
  * Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
532
- * @summary Retrieve a payment method
436
+ * @summary Retrieve the payment method
533
437
  * @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
534
438
  * @param {*} [options] Override http request option.
535
439
  * @throws {RequiredError}
@@ -537,10 +441,10 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
537
441
  */
538
442
  PaymentMethodsApi.prototype.getPaymentMethod = function (requestParameters, options) {
539
443
  var _this = this;
540
- return (0, exports.PaymentMethodsApiFp)(this.configuration).getPaymentMethod(requestParameters.code, requestParameters.expand, requestParameters.expand2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
444
+ return (0, exports.PaymentMethodsApiFp)(this.configuration).getPaymentMethod(requestParameters.code, requestParameters.code2, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
541
445
  };
542
446
  /**
543
- * Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
447
+ * 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.
544
448
  * @summary List payment methods
545
449
  * @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
546
450
  * @param {*} [options] Override http request option.
@@ -39,7 +39,7 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
39
39
  */
40
40
  deactivatePaymentReminder: (code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
41
  /**
42
- * 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.
42
+ * 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.
43
43
  * @summary Retrieve the payment reminder
44
44
  * @param {string} code Unique identifier for the object.
45
45
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -48,13 +48,13 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
48
48
  */
49
49
  getPolicy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
50
  /**
51
- * 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.
51
+ * 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.
52
52
  * @summary List payment reminders
53
53
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
54
54
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
55
55
  * @param {any} [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.
56
56
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
57
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
57
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
58
58
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
59
59
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
60
60
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -88,7 +88,7 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
88
88
  */
89
89
  deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
90
90
  /**
91
- * 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.
91
+ * 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.
92
92
  * @summary Retrieve the payment reminder
93
93
  * @param {string} code Unique identifier for the object.
94
94
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -97,13 +97,13 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
97
97
  */
98
98
  getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
99
99
  /**
100
- * 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.
100
+ * 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.
101
101
  * @summary List payment reminders
102
102
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
103
103
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
104
104
  * @param {any} [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.
105
105
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
106
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
106
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
107
107
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
108
108
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
109
109
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -137,7 +137,7 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
137
137
  */
138
138
  deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
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.
141
141
  * @summary Retrieve the payment reminder
142
142
  * @param {string} code Unique identifier for the object.
143
143
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -146,13 +146,13 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
146
146
  */
147
147
  getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<void>;
148
148
  /**
149
- * 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.
149
+ * 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.
150
150
  * @summary List payment reminders
151
151
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
152
152
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
153
153
  * @param {any} [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.
154
154
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
155
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
155
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
156
156
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
157
157
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
158
158
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -255,7 +255,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
255
255
  */
256
256
  readonly filter?: any;
257
257
  /**
258
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
258
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
259
259
  * @type {any}
260
260
  * @memberof PaymentRemindersApiListPaymentReminders
261
261
  */
@@ -305,7 +305,7 @@ export declare class PaymentRemindersApi extends BaseAPI {
305
305
  */
306
306
  deactivatePaymentReminder(requestParameters: PaymentRemindersApiDeactivatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
307
307
  /**
308
- * 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.
308
+ * 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.
309
309
  * @summary Retrieve the payment reminder
310
310
  * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
311
311
  * @param {*} [options] Override http request option.
@@ -314,7 +314,7 @@ export declare class PaymentRemindersApi extends BaseAPI {
314
314
  */
315
315
  getPolicy(requestParameters: PaymentRemindersApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
316
316
  /**
317
- * 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.
317
+ * 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.
318
318
  * @summary List payment reminders
319
319
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
320
320
  * @param {*} [options] Override http request option.
@@ -195,7 +195,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
195
195
  });
196
196
  },
197
197
  /**
198
- * 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.
198
+ * 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.
199
199
  * @summary Retrieve the payment reminder
200
200
  * @param {string} code Unique identifier for the object.
201
201
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -243,13 +243,13 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
243
243
  });
244
244
  },
245
245
  /**
246
- * 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.
246
+ * 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.
247
247
  * @summary List payment reminders
248
248
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
249
249
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
250
250
  * @param {any} [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.
251
251
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
252
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
252
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
253
253
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
254
254
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
255
255
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -368,7 +368,7 @@ var PaymentRemindersApiFp = function (configuration) {
368
368
  });
369
369
  },
370
370
  /**
371
- * 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.
371
+ * 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.
372
372
  * @summary Retrieve the payment reminder
373
373
  * @param {string} code Unique identifier for the object.
374
374
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -389,13 +389,13 @@ var PaymentRemindersApiFp = function (configuration) {
389
389
  });
390
390
  },
391
391
  /**
392
- * 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.
392
+ * 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.
393
393
  * @summary List payment reminders
394
394
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
395
395
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
396
396
  * @param {any} [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.
397
397
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
398
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
398
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
399
399
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
400
400
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
401
401
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -449,7 +449,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
449
449
  return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
450
450
  },
451
451
  /**
452
- * 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.
452
+ * 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.
453
453
  * @summary Retrieve the payment reminder
454
454
  * @param {string} code Unique identifier for the object.
455
455
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -460,13 +460,13 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
460
460
  return localVarFp.getPolicy(code, authorization, options).then(function (request) { return request(axios, basePath); });
461
461
  },
462
462
  /**
463
- * 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.
463
+ * 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.
464
464
  * @summary List payment reminders
465
465
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
466
466
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
467
467
  * @param {any} [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.
468
468
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
469
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
469
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
470
470
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
471
471
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
472
472
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -515,7 +515,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
515
515
  return (0, exports.PaymentRemindersApiFp)(this.configuration).deactivatePaymentReminder(requestParameters.code, requestParameters.deactivatePaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
516
516
  };
517
517
  /**
518
- * 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.
518
+ * 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.
519
519
  * @summary Retrieve the payment reminder
520
520
  * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
521
521
  * @param {*} [options] Override http request option.
@@ -527,7 +527,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
527
527
  return (0, exports.PaymentRemindersApiFp)(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
528
528
  };
529
529
  /**
530
- * 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.
530
+ * 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.
531
531
  * @summary List payment reminders
532
532
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
533
533
  * @param {*} [options] Override http request option.