@emilgroup/payment-sdk-node 1.13.1-beta.13 → 1.13.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
@@ -98,7 +98,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
98
98
  return {
99
99
  /**
100
100
  * 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.
101
- * @summary Create the payment-method
101
+ * @summary Create the payment method
102
102
  * @param {object} body
103
103
  * @param {string} [authorization] Bearer Token
104
104
  * @param {*} [options] Override http request option.
@@ -145,67 +145,17 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
145
145
  });
146
146
  });
147
147
  },
148
- /**
149
- * 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.
150
- * @summary Delete a payment method
151
- * @param {number} id Unique identifier for payment method
152
- * @param {string} [authorization] Bearer Token
153
- * @param {*} [options] Override http request option.
154
- * @throws {RequiredError}
155
- */
156
- deletePaymentMethod: function (id, authorization, options) {
157
- if (options === void 0) { options = {}; }
158
- return __awaiter(_this, void 0, void 0, function () {
159
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
160
- return __generator(this, function (_a) {
161
- switch (_a.label) {
162
- case 0:
163
- // verify required parameter 'id' is not null or undefined
164
- (0, common_1.assertParamExists)('deletePaymentMethod', 'id', id);
165
- localVarPath = "/paymentservice/v1/payment-methods/{id}";
166
- localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
167
- if (configuration) {
168
- baseOptions = configuration.baseOptions;
169
- baseAccessToken = configuration.accessToken;
170
- }
171
- localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
172
- localVarHeaderParameter = {};
173
- localVarQueryParameter = {};
174
- // authentication bearer required
175
- // http bearer authentication required
176
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
177
- case 1:
178
- // authentication bearer required
179
- // http bearer authentication required
180
- _a.sent();
181
- if (id !== undefined) {
182
- localVarQueryParameter['id'] = id;
183
- }
184
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
185
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
186
- }
187
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
188
- headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
189
- localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
190
- return [2 /*return*/, {
191
- url: (0, common_1.toPathString)(localVarUrlObj),
192
- options: localVarRequestOptions,
193
- }];
194
- }
195
- });
196
- });
197
- },
198
148
  /**
199
149
  * 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.
200
- * @summary Retrieve a payment method
201
- * @param {string} code Unique identifier for the object.
150
+ * @summary Retrieve the payment method
151
+ * @param {string} code
152
+ * @param {string} code2 Unique identifier for the object.
202
153
  * @param {string} expand Fields to expand response by
203
- * @param {string} expand2 Fields to expand response by
204
154
  * @param {string} [authorization] Bearer Token
205
155
  * @param {*} [options] Override http request option.
206
156
  * @throws {RequiredError}
207
157
  */
208
- getPaymentMethod: function (code, expand, expand2, authorization, options) {
158
+ getPaymentMethod: function (code, code2, expand, authorization, options) {
209
159
  if (options === void 0) { options = {}; }
210
160
  return __awaiter(_this, void 0, void 0, function () {
211
161
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -214,11 +164,12 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
214
164
  case 0:
215
165
  // verify required parameter 'code' is not null or undefined
216
166
  (0, common_1.assertParamExists)('getPaymentMethod', 'code', code);
167
+ // verify required parameter 'code2' is not null or undefined
168
+ (0, common_1.assertParamExists)('getPaymentMethod', 'code2', code2);
217
169
  // verify required parameter 'expand' is not null or undefined
218
170
  (0, common_1.assertParamExists)('getPaymentMethod', 'expand', expand);
219
- // verify required parameter 'expand2' is not null or undefined
220
- (0, common_1.assertParamExists)('getPaymentMethod', 'expand2', expand2);
221
- localVarPath = "/paymentservice/v1/payment-methods/{code}";
171
+ localVarPath = "/paymentservice/v1/payment-methods/{code}"
172
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
222
173
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
223
174
  if (configuration) {
224
175
  baseOptions = configuration.baseOptions;
@@ -234,15 +185,12 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
234
185
  // authentication bearer required
235
186
  // http bearer authentication required
236
187
  _a.sent();
237
- if (code !== undefined) {
238
- localVarQueryParameter['code'] = code;
188
+ if (code2 !== undefined) {
189
+ localVarQueryParameter['code'] = code2;
239
190
  }
240
191
  if (expand !== undefined) {
241
192
  localVarQueryParameter['expand'] = expand;
242
193
  }
243
- if (expand2 !== undefined) {
244
- localVarQueryParameter['expand'] = expand2;
245
- }
246
194
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
247
195
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
248
196
  }
@@ -258,13 +206,13 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
258
206
  });
259
207
  },
260
208
  /**
261
- * 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.
209
+ * 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.
262
210
  * @summary List payment methods
263
211
  * @param {string} [authorization] Bearer Token
264
212
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
265
213
  * @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.
266
214
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
267
- * @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.
215
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
268
216
  * @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.
269
217
  * @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.
270
218
  * @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.
@@ -341,7 +289,7 @@ var PaymentMethodsApiFp = function (configuration) {
341
289
  return {
342
290
  /**
343
291
  * 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.
344
- * @summary Create the payment-method
292
+ * @summary Create the payment method
345
293
  * @param {object} body
346
294
  * @param {string} [authorization] Bearer Token
347
295
  * @param {*} [options] Override http request option.
@@ -360,43 +308,22 @@ var PaymentMethodsApiFp = function (configuration) {
360
308
  });
361
309
  });
362
310
  },
363
- /**
364
- * 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.
365
- * @summary Delete a payment method
366
- * @param {number} id Unique identifier for payment method
367
- * @param {string} [authorization] Bearer Token
368
- * @param {*} [options] Override http request option.
369
- * @throws {RequiredError}
370
- */
371
- deletePaymentMethod: function (id, authorization, options) {
372
- return __awaiter(this, void 0, void 0, function () {
373
- var localVarAxiosArgs;
374
- return __generator(this, function (_a) {
375
- switch (_a.label) {
376
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.deletePaymentMethod(id, authorization, options)];
377
- case 1:
378
- localVarAxiosArgs = _a.sent();
379
- return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
380
- }
381
- });
382
- });
383
- },
384
311
  /**
385
312
  * 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.
386
- * @summary Retrieve a payment method
387
- * @param {string} code Unique identifier for the object.
313
+ * @summary Retrieve the payment method
314
+ * @param {string} code
315
+ * @param {string} code2 Unique identifier for the object.
388
316
  * @param {string} expand Fields to expand response by
389
- * @param {string} expand2 Fields to expand response by
390
317
  * @param {string} [authorization] Bearer Token
391
318
  * @param {*} [options] Override http request option.
392
319
  * @throws {RequiredError}
393
320
  */
394
- getPaymentMethod: function (code, expand, expand2, authorization, options) {
321
+ getPaymentMethod: function (code, code2, expand, authorization, options) {
395
322
  return __awaiter(this, void 0, void 0, function () {
396
323
  var localVarAxiosArgs;
397
324
  return __generator(this, function (_a) {
398
325
  switch (_a.label) {
399
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPaymentMethod(code, expand, expand2, authorization, options)];
326
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPaymentMethod(code, code2, expand, authorization, options)];
400
327
  case 1:
401
328
  localVarAxiosArgs = _a.sent();
402
329
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -405,13 +332,13 @@ var PaymentMethodsApiFp = function (configuration) {
405
332
  });
406
333
  },
407
334
  /**
408
- * 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.
335
+ * 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.
409
336
  * @summary List payment methods
410
337
  * @param {string} [authorization] Bearer Token
411
338
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
412
339
  * @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.
413
340
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
414
- * @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.
341
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
415
342
  * @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.
416
343
  * @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.
417
344
  * @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.
@@ -443,7 +370,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
443
370
  return {
444
371
  /**
445
372
  * 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.
446
- * @summary Create the payment-method
373
+ * @summary Create the payment method
447
374
  * @param {object} body
448
375
  * @param {string} [authorization] Bearer Token
449
376
  * @param {*} [options] Override http request option.
@@ -452,38 +379,27 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
452
379
  createPaymentMethod: function (body, authorization, options) {
453
380
  return localVarFp.createPaymentMethod(body, authorization, options).then(function (request) { return request(axios, basePath); });
454
381
  },
455
- /**
456
- * 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.
457
- * @summary Delete a payment method
458
- * @param {number} id Unique identifier for payment method
459
- * @param {string} [authorization] Bearer Token
460
- * @param {*} [options] Override http request option.
461
- * @throws {RequiredError}
462
- */
463
- deletePaymentMethod: function (id, authorization, options) {
464
- return localVarFp.deletePaymentMethod(id, authorization, options).then(function (request) { return request(axios, basePath); });
465
- },
466
382
  /**
467
383
  * 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.
468
- * @summary Retrieve a payment method
469
- * @param {string} code Unique identifier for the object.
384
+ * @summary Retrieve the payment method
385
+ * @param {string} code
386
+ * @param {string} code2 Unique identifier for the object.
470
387
  * @param {string} expand Fields to expand response by
471
- * @param {string} expand2 Fields to expand response by
472
388
  * @param {string} [authorization] Bearer Token
473
389
  * @param {*} [options] Override http request option.
474
390
  * @throws {RequiredError}
475
391
  */
476
- getPaymentMethod: function (code, expand, expand2, authorization, options) {
477
- return localVarFp.getPaymentMethod(code, expand, expand2, authorization, options).then(function (request) { return request(axios, basePath); });
392
+ getPaymentMethod: function (code, code2, expand, authorization, options) {
393
+ return localVarFp.getPaymentMethod(code, code2, expand, authorization, options).then(function (request) { return request(axios, basePath); });
478
394
  },
479
395
  /**
480
- * 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.
396
+ * 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.
481
397
  * @summary List payment methods
482
398
  * @param {string} [authorization] Bearer Token
483
399
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
484
400
  * @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.
485
401
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
486
- * @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.
402
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
487
403
  * @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.
488
404
  * @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.
489
405
  * @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.
@@ -509,7 +425,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
509
425
  }
510
426
  /**
511
427
  * 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.
512
- * @summary Create the payment-method
428
+ * @summary Create the payment method
513
429
  * @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
514
430
  * @param {*} [options] Override http request option.
515
431
  * @throws {RequiredError}
@@ -519,21 +435,9 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
519
435
  var _this = this;
520
436
  return (0, exports.PaymentMethodsApiFp)(this.configuration).createPaymentMethod(requestParameters.body, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
521
437
  };
522
- /**
523
- * 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.
524
- * @summary Delete a payment method
525
- * @param {PaymentMethodsApiDeletePaymentMethodRequest} requestParameters Request parameters.
526
- * @param {*} [options] Override http request option.
527
- * @throws {RequiredError}
528
- * @memberof PaymentMethodsApi
529
- */
530
- PaymentMethodsApi.prototype.deletePaymentMethod = function (requestParameters, options) {
531
- var _this = this;
532
- return (0, exports.PaymentMethodsApiFp)(this.configuration).deletePaymentMethod(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
533
- };
534
438
  /**
535
439
  * 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.
536
- * @summary Retrieve a payment method
440
+ * @summary Retrieve the payment method
537
441
  * @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
538
442
  * @param {*} [options] Override http request option.
539
443
  * @throws {RequiredError}
@@ -541,10 +445,10 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
541
445
  */
542
446
  PaymentMethodsApi.prototype.getPaymentMethod = function (requestParameters, options) {
543
447
  var _this = this;
544
- 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); });
448
+ 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); });
545
449
  };
546
450
  /**
547
- * 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.
451
+ * 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.
548
452
  * @summary List payment methods
549
453
  * @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
550
454
  * @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.
@@ -199,7 +199,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
199
199
  });
200
200
  },
201
201
  /**
202
- * 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.
202
+ * 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.
203
203
  * @summary Retrieve the payment reminder
204
204
  * @param {string} code Unique identifier for the object.
205
205
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -247,13 +247,13 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
247
247
  });
248
248
  },
249
249
  /**
250
- * 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.
250
+ * 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.
251
251
  * @summary List payment reminders
252
252
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
253
253
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
254
254
  * @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.
255
255
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
256
- * @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.
256
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
257
257
  * @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.
258
258
  * @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.
259
259
  * @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.
@@ -372,7 +372,7 @@ var PaymentRemindersApiFp = function (configuration) {
372
372
  });
373
373
  },
374
374
  /**
375
- * 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.
375
+ * 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.
376
376
  * @summary Retrieve the payment reminder
377
377
  * @param {string} code Unique identifier for the object.
378
378
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -393,13 +393,13 @@ var PaymentRemindersApiFp = function (configuration) {
393
393
  });
394
394
  },
395
395
  /**
396
- * 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.
396
+ * 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.
397
397
  * @summary List payment reminders
398
398
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
399
399
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
400
400
  * @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.
401
401
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
402
- * @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.
402
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
403
403
  * @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.
404
404
  * @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.
405
405
  * @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.
@@ -453,7 +453,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
453
453
  return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
454
454
  },
455
455
  /**
456
- * 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.
456
+ * 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.
457
457
  * @summary Retrieve the payment reminder
458
458
  * @param {string} code Unique identifier for the object.
459
459
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -464,13 +464,13 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
464
464
  return localVarFp.getPolicy(code, authorization, options).then(function (request) { return request(axios, basePath); });
465
465
  },
466
466
  /**
467
- * 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.
467
+ * 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.
468
468
  * @summary List payment reminders
469
469
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
470
470
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
471
471
  * @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.
472
472
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
473
- * @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.
473
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
474
474
  * @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.
475
475
  * @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.
476
476
  * @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.
@@ -519,7 +519,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
519
519
  return (0, exports.PaymentRemindersApiFp)(this.configuration).deactivatePaymentReminder(requestParameters.code, requestParameters.deactivatePaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
520
520
  };
521
521
  /**
522
- * 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.
522
+ * 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.
523
523
  * @summary Retrieve the payment reminder
524
524
  * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
525
525
  * @param {*} [options] Override http request option.
@@ -531,7 +531,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
531
531
  return (0, exports.PaymentRemindersApiFp)(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
532
532
  };
533
533
  /**
534
- * 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.
534
+ * 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.
535
535
  * @summary List payment reminders
536
536
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
537
537
  * @param {*} [options] Override http request option.