@emilgroup/payment-sdk-node 1.21.1-beta.2 → 1.21.1-beta.3

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 (32) hide show
  1. package/README.md +2 -2
  2. package/api/bank-accounts-api.ts +24 -24
  3. package/api/bank-transaction-api.ts +20 -20
  4. package/api/payment-methods-api.ts +12 -12
  5. package/api/payment-reminders-api.ts +30 -30
  6. package/api/payment-setup-api.ts +8 -8
  7. package/api/payments-api.ts +12 -12
  8. package/api/refunds-api.ts +12 -12
  9. package/api/webhooks-api.ts +4 -4
  10. package/dist/api/bank-accounts-api.d.ts +24 -24
  11. package/dist/api/bank-accounts-api.js +24 -24
  12. package/dist/api/bank-transaction-api.d.ts +20 -20
  13. package/dist/api/bank-transaction-api.js +20 -20
  14. package/dist/api/payment-methods-api.d.ts +12 -12
  15. package/dist/api/payment-methods-api.js +12 -12
  16. package/dist/api/payment-reminders-api.d.ts +26 -26
  17. package/dist/api/payment-reminders-api.js +25 -25
  18. package/dist/api/payment-setup-api.d.ts +8 -8
  19. package/dist/api/payment-setup-api.js +8 -8
  20. package/dist/api/payments-api.d.ts +12 -12
  21. package/dist/api/payments-api.js +12 -12
  22. package/dist/api/refunds-api.d.ts +12 -12
  23. package/dist/api/refunds-api.js +12 -12
  24. package/dist/api/webhooks-api.d.ts +4 -4
  25. package/dist/api/webhooks-api.js +4 -4
  26. package/dist/models/bank-transaction-class-without-expand-properties.d.ts +8 -2
  27. package/dist/models/bank-transaction-class.d.ts +8 -2
  28. package/dist/models/unlinked-bank-transaction-response-class.d.ts +8 -2
  29. package/models/bank-transaction-class-without-expand-properties.ts +8 -2
  30. package/models/bank-transaction-class.ts +8 -2
  31. package/models/unlinked-bank-transaction-response-class.ts +8 -2
  32. package/package.json +1 -1
@@ -97,7 +97,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * This will create a payment reminder in the database.
100
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
101
101
  * @summary Create the payment reminder
102
102
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
103
103
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -146,7 +146,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
146
146
  });
147
147
  },
148
148
  /**
149
- * This will deactivate the payment reminder
149
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
150
150
  * @summary Deactivate payment reminder
151
151
  * @param {string} code Unique identifier for the object.
152
152
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -199,14 +199,14 @@ 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. **Required Permissions** \"payment-management.reminders.view\"
203
203
  * @summary Retrieve the payment reminder
204
204
  * @param {string} code
205
205
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
206
206
  * @param {*} [options] Override http request option.
207
207
  * @throws {RequiredError}
208
208
  */
209
- getPolicy: function (code, authorization, options) {
209
+ getPaymentReminder: function (code, authorization, options) {
210
210
  if (options === void 0) { options = {}; }
211
211
  return __awaiter(_this, void 0, void 0, function () {
212
212
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -214,7 +214,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
214
214
  switch (_a.label) {
215
215
  case 0:
216
216
  // verify required parameter 'code' is not null or undefined
217
- (0, common_1.assertParamExists)('getPolicy', 'code', code);
217
+ (0, common_1.assertParamExists)('getPaymentReminder', 'code', code);
218
218
  localVarPath = "/paymentservice/v1/payment-reminders/{code}"
219
219
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
220
220
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -247,7 +247,7 @@ 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. **Required Permissions** \"payment-management.reminders.view\"
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 {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
@@ -317,7 +317,7 @@ var PaymentRemindersApiFp = function (configuration) {
317
317
  var localVarAxiosParamCreator = (0, exports.PaymentRemindersApiAxiosParamCreator)(configuration);
318
318
  return {
319
319
  /**
320
- * This will create a payment reminder in the database.
320
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
321
321
  * @summary Create the payment reminder
322
322
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
323
323
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -338,7 +338,7 @@ var PaymentRemindersApiFp = function (configuration) {
338
338
  });
339
339
  },
340
340
  /**
341
- * This will deactivate the payment reminder
341
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
342
342
  * @summary Deactivate payment reminder
343
343
  * @param {string} code Unique identifier for the object.
344
344
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -360,19 +360,19 @@ var PaymentRemindersApiFp = function (configuration) {
360
360
  });
361
361
  },
362
362
  /**
363
- * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
363
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
364
364
  * @summary Retrieve the payment reminder
365
365
  * @param {string} code
366
366
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
367
367
  * @param {*} [options] Override http request option.
368
368
  * @throws {RequiredError}
369
369
  */
370
- getPolicy: function (code, authorization, options) {
370
+ getPaymentReminder: function (code, authorization, options) {
371
371
  return __awaiter(this, void 0, void 0, function () {
372
372
  var localVarAxiosArgs;
373
373
  return __generator(this, function (_a) {
374
374
  switch (_a.label) {
375
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPolicy(code, authorization, options)];
375
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPaymentReminder(code, authorization, options)];
376
376
  case 1:
377
377
  localVarAxiosArgs = _a.sent();
378
378
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -381,7 +381,7 @@ var PaymentRemindersApiFp = function (configuration) {
381
381
  });
382
382
  },
383
383
  /**
384
- * 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.
384
+ * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
385
385
  * @summary List payment reminders
386
386
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
387
387
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
@@ -415,7 +415,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
415
415
  var localVarFp = (0, exports.PaymentRemindersApiFp)(configuration);
416
416
  return {
417
417
  /**
418
- * This will create a payment reminder in the database.
418
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
419
419
  * @summary Create the payment reminder
420
420
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
421
421
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -426,7 +426,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
426
426
  return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
427
427
  },
428
428
  /**
429
- * This will deactivate the payment reminder
429
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
430
430
  * @summary Deactivate payment reminder
431
431
  * @param {string} code Unique identifier for the object.
432
432
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -438,18 +438,18 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
438
438
  return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
439
439
  },
440
440
  /**
441
- * 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.
441
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
442
442
  * @summary Retrieve the payment reminder
443
443
  * @param {string} code
444
444
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
445
445
  * @param {*} [options] Override http request option.
446
446
  * @throws {RequiredError}
447
447
  */
448
- getPolicy: function (code, authorization, options) {
449
- return localVarFp.getPolicy(code, authorization, options).then(function (request) { return request(axios, basePath); });
448
+ getPaymentReminder: function (code, authorization, options) {
449
+ return localVarFp.getPaymentReminder(code, authorization, options).then(function (request) { return request(axios, basePath); });
450
450
  },
451
451
  /**
452
- * 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.
452
+ * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
453
453
  * @summary List payment reminders
454
454
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
455
455
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
@@ -477,7 +477,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
477
477
  return _super !== null && _super.apply(this, arguments) || this;
478
478
  }
479
479
  /**
480
- * This will create a payment reminder in the database.
480
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
481
481
  * @summary Create the payment reminder
482
482
  * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
483
483
  * @param {*} [options] Override http request option.
@@ -489,7 +489,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
489
489
  return (0, exports.PaymentRemindersApiFp)(this.configuration).createPaymentReminder(requestParameters.createPaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
490
490
  };
491
491
  /**
492
- * This will deactivate the payment reminder
492
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
493
493
  * @summary Deactivate payment reminder
494
494
  * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
495
495
  * @param {*} [options] Override http request option.
@@ -501,19 +501,19 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
501
501
  return (0, exports.PaymentRemindersApiFp)(this.configuration).deactivatePaymentReminder(requestParameters.code, requestParameters.deactivatePaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
502
502
  };
503
503
  /**
504
- * 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.
504
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
505
505
  * @summary Retrieve the payment reminder
506
- * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
506
+ * @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
507
507
  * @param {*} [options] Override http request option.
508
508
  * @throws {RequiredError}
509
509
  * @memberof PaymentRemindersApi
510
510
  */
511
- PaymentRemindersApi.prototype.getPolicy = function (requestParameters, options) {
511
+ PaymentRemindersApi.prototype.getPaymentReminder = function (requestParameters, options) {
512
512
  var _this = this;
513
- return (0, exports.PaymentRemindersApiFp)(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
513
+ return (0, exports.PaymentRemindersApiFp)(this.configuration).getPaymentReminder(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
514
514
  };
515
515
  /**
516
- * 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.
516
+ * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
517
517
  * @summary List payment reminders
518
518
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
519
519
  * @param {*} [options] Override http request option.
@@ -22,7 +22,7 @@ import { InitiatePaymentSetupResponseClass } from '../models';
22
22
  */
23
23
  export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
25
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
26
26
  * @summary Complete a payment setup
27
27
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
28
28
  * @param {string} [authorization] Bearer Token
@@ -31,7 +31,7 @@ export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configur
31
31
  */
32
32
  completePaymentSetup: (completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
33
  /**
34
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
34
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
35
35
  * @summary Initiate a payment setup
36
36
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
37
37
  * @param {string} [authorization] Bearer Token
@@ -46,7 +46,7 @@ export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configur
46
46
  */
47
47
  export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
48
48
  /**
49
- * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
49
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
50
50
  * @summary Complete a payment setup
51
51
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
52
52
  * @param {string} [authorization] Bearer Token
@@ -55,7 +55,7 @@ export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
55
55
  */
56
56
  completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompletePaymentSetupResponseClass>>;
57
57
  /**
58
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
58
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
59
59
  * @summary Initiate a payment setup
60
60
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
61
61
  * @param {string} [authorization] Bearer Token
@@ -70,7 +70,7 @@ export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
70
70
  */
71
71
  export declare const PaymentSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
72
72
  /**
73
- * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
73
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
74
74
  * @summary Complete a payment setup
75
75
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
76
76
  * @param {string} [authorization] Bearer Token
@@ -79,7 +79,7 @@ export declare const PaymentSetupApiFactory: (configuration?: Configuration, bas
79
79
  */
80
80
  completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: any): AxiosPromise<CompletePaymentSetupResponseClass>;
81
81
  /**
82
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
82
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
83
83
  * @summary Initiate a payment setup
84
84
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
85
85
  * @param {string} [authorization] Bearer Token
@@ -134,7 +134,7 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
134
134
  */
135
135
  export declare class PaymentSetupApi extends BaseAPI {
136
136
  /**
137
- * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
137
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
138
138
  * @summary Complete a payment setup
139
139
  * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
140
140
  * @param {*} [options] Override http request option.
@@ -143,7 +143,7 @@ export declare class PaymentSetupApi extends BaseAPI {
143
143
  */
144
144
  completePaymentSetup(requestParameters: PaymentSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompletePaymentSetupResponseClass, any>>;
145
145
  /**
146
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
146
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
147
147
  * @summary Initiate a payment setup
148
148
  * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
149
149
  * @param {*} [options] Override http request option.
@@ -97,7 +97,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
100
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
101
101
  * @summary Complete a payment setup
102
102
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
103
103
  * @param {string} [authorization] Bearer Token
@@ -146,7 +146,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
146
146
  });
147
147
  },
148
148
  /**
149
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
149
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
150
150
  * @summary Initiate a payment setup
151
151
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
152
152
  * @param {string} [authorization] Bearer Token
@@ -205,7 +205,7 @@ var PaymentSetupApiFp = function (configuration) {
205
205
  var localVarAxiosParamCreator = (0, exports.PaymentSetupApiAxiosParamCreator)(configuration);
206
206
  return {
207
207
  /**
208
- * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
208
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
209
209
  * @summary Complete a payment setup
210
210
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
211
211
  * @param {string} [authorization] Bearer Token
@@ -226,7 +226,7 @@ var PaymentSetupApiFp = function (configuration) {
226
226
  });
227
227
  },
228
228
  /**
229
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
229
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
230
230
  * @summary Initiate a payment setup
231
231
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
232
232
  * @param {string} [authorization] Bearer Token
@@ -257,7 +257,7 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
257
257
  var localVarFp = (0, exports.PaymentSetupApiFp)(configuration);
258
258
  return {
259
259
  /**
260
- * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
260
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
261
261
  * @summary Complete a payment setup
262
262
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
263
263
  * @param {string} [authorization] Bearer Token
@@ -268,7 +268,7 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
268
268
  return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
269
269
  },
270
270
  /**
271
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
271
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
272
272
  * @summary Initiate a payment setup
273
273
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
274
274
  * @param {string} [authorization] Bearer Token
@@ -293,7 +293,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
293
293
  return _super !== null && _super.apply(this, arguments) || this;
294
294
  }
295
295
  /**
296
- * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
296
+ * This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data. **Required Permissions** \"payment-management.payments.create\"
297
297
  * @summary Complete a payment setup
298
298
  * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
299
299
  * @param {*} [options] Override http request option.
@@ -305,7 +305,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
305
305
  return (0, exports.PaymentSetupApiFp)(this.configuration).completePaymentSetup(requestParameters.completePaymentSetupRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
306
306
  };
307
307
  /**
308
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
308
+ * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information. **Required Permissions** \"payment-management.payments.create\"
309
309
  * @summary Initiate a payment setup
310
310
  * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
311
311
  * @param {*} [options] Override http request option.
@@ -22,7 +22,7 @@ import { ListPaymentsResponseClass } from '../models';
22
22
  */
23
23
  export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * This will create a payment for a specified account. This function is idempotent.
25
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
26
26
  * @summary Create the payment
27
27
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
28
28
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -32,7 +32,7 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
32
32
  */
33
33
  createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
34
  /**
35
- * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
35
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
36
36
  * @summary Retrieve the payment
37
37
  * @param {string} code
38
38
  * @param {string} [authorization] Bearer Token
@@ -42,7 +42,7 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
42
42
  */
43
43
  getPayment: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
44
  /**
45
- * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
45
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
46
46
  * @summary List payments
47
47
  * @param {string} [authorization] Bearer Token
48
48
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
@@ -60,7 +60,7 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
60
60
  */
61
61
  export declare const PaymentsApiFp: (configuration?: Configuration) => {
62
62
  /**
63
- * This will create a payment for a specified account. This function is idempotent.
63
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
64
64
  * @summary Create the payment
65
65
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
66
66
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -70,7 +70,7 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
70
70
  */
71
71
  createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
72
72
  /**
73
- * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
73
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
74
74
  * @summary Retrieve the payment
75
75
  * @param {string} code
76
76
  * @param {string} [authorization] Bearer Token
@@ -80,7 +80,7 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
80
80
  */
81
81
  getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentResponseClass>>;
82
82
  /**
83
- * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
83
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
84
84
  * @summary List payments
85
85
  * @param {string} [authorization] Bearer Token
86
86
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
@@ -98,7 +98,7 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
98
98
  */
99
99
  export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
100
100
  /**
101
- * This will create a payment for a specified account. This function is idempotent.
101
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
102
102
  * @summary Create the payment
103
103
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
104
104
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -108,7 +108,7 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
108
108
  */
109
109
  createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
110
110
  /**
111
- * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
111
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
112
112
  * @summary Retrieve the payment
113
113
  * @param {string} code
114
114
  * @param {string} [authorization] Bearer Token
@@ -118,7 +118,7 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
118
118
  */
119
119
  getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPaymentResponseClass>;
120
120
  /**
121
- * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
121
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
122
122
  * @summary List payments
123
123
  * @param {string} [authorization] Bearer Token
124
124
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
@@ -225,7 +225,7 @@ export interface PaymentsApiListPaymentsRequest {
225
225
  */
226
226
  export declare class PaymentsApi extends BaseAPI {
227
227
  /**
228
- * This will create a payment for a specified account. This function is idempotent.
228
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
229
229
  * @summary Create the payment
230
230
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
231
231
  * @param {*} [options] Override http request option.
@@ -234,7 +234,7 @@ export declare class PaymentsApi extends BaseAPI {
234
234
  */
235
235
  createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
236
236
  /**
237
- * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
237
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
238
238
  * @summary Retrieve the payment
239
239
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
240
240
  * @param {*} [options] Override http request option.
@@ -243,7 +243,7 @@ export declare class PaymentsApi extends BaseAPI {
243
243
  */
244
244
  getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentResponseClass, any>>;
245
245
  /**
246
- * Returns a list of payments you have previously created. The payments 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 payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
247
247
  * @summary List payments
248
248
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
249
249
  * @param {*} [options] Override http request option.
@@ -97,7 +97,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * This will create a payment for a specified account. This function is idempotent.
100
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
101
101
  * @summary Create the payment
102
102
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
103
103
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -152,7 +152,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
152
152
  });
153
153
  },
154
154
  /**
155
- * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
155
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
156
156
  * @summary Retrieve the payment
157
157
  * @param {string} code
158
158
  * @param {string} [authorization] Bearer Token
@@ -204,7 +204,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
204
204
  });
205
205
  },
206
206
  /**
207
- * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
207
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
208
208
  * @summary List payments
209
209
  * @param {string} [authorization] Bearer Token
210
210
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
@@ -274,7 +274,7 @@ var PaymentsApiFp = function (configuration) {
274
274
  var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
275
275
  return {
276
276
  /**
277
- * This will create a payment for a specified account. This function is idempotent.
277
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
278
278
  * @summary Create the payment
279
279
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
280
280
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -296,7 +296,7 @@ var PaymentsApiFp = function (configuration) {
296
296
  });
297
297
  },
298
298
  /**
299
- * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
299
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
300
300
  * @summary Retrieve the payment
301
301
  * @param {string} code
302
302
  * @param {string} [authorization] Bearer Token
@@ -318,7 +318,7 @@ var PaymentsApiFp = function (configuration) {
318
318
  });
319
319
  },
320
320
  /**
321
- * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
321
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
322
322
  * @summary List payments
323
323
  * @param {string} [authorization] Bearer Token
324
324
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
@@ -352,7 +352,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
352
352
  var localVarFp = (0, exports.PaymentsApiFp)(configuration);
353
353
  return {
354
354
  /**
355
- * This will create a payment for a specified account. This function is idempotent.
355
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
356
356
  * @summary Create the payment
357
357
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
358
358
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -364,7 +364,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
364
364
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
365
365
  },
366
366
  /**
367
- * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
367
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
368
368
  * @summary Retrieve the payment
369
369
  * @param {string} code
370
370
  * @param {string} [authorization] Bearer Token
@@ -376,7 +376,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
376
376
  return localVarFp.getPayment(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
377
377
  },
378
378
  /**
379
- * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
379
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
380
380
  * @summary List payments
381
381
  * @param {string} [authorization] Bearer Token
382
382
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
@@ -404,7 +404,7 @@ var PaymentsApi = /** @class */ (function (_super) {
404
404
  return _super !== null && _super.apply(this, arguments) || this;
405
405
  }
406
406
  /**
407
- * This will create a payment for a specified account. This function is idempotent.
407
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
408
408
  * @summary Create the payment
409
409
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
410
410
  * @param {*} [options] Override http request option.
@@ -416,7 +416,7 @@ var PaymentsApi = /** @class */ (function (_super) {
416
416
  return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
417
417
  };
418
418
  /**
419
- * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
419
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
420
420
  * @summary Retrieve the payment
421
421
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
422
422
  * @param {*} [options] Override http request option.
@@ -428,7 +428,7 @@ var PaymentsApi = /** @class */ (function (_super) {
428
428
  return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
429
429
  };
430
430
  /**
431
- * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
431
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
432
432
  * @summary List payments
433
433
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
434
434
  * @param {*} [options] Override http request option.