@emilgroup/payment-sdk 1.13.1-beta.2 → 1.13.1-beta.4

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
@@ -93,7 +93,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * This will create a payment reminder in the database.
96
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
97
97
  * @summary Create the payment reminder
98
98
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
99
99
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -142,7 +142,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
142
142
  });
143
143
  },
144
144
  /**
145
- * This will deactivate the payment reminder
145
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
146
146
  * @summary Deactivate payment reminder
147
147
  * @param {string} code Unique identifier for the object.
148
148
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -195,14 +195,14 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
195
195
  });
196
196
  },
197
197
  /**
198
- * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
198
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
199
199
  * @summary Retrieve the payment reminder
200
200
  * @param {string} code
201
201
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
202
202
  * @param {*} [options] Override http request option.
203
203
  * @throws {RequiredError}
204
204
  */
205
- getPolicy: function (code, authorization, options) {
205
+ getPaymentReminder: function (code, authorization, options) {
206
206
  if (options === void 0) { options = {}; }
207
207
  return __awaiter(_this, void 0, void 0, function () {
208
208
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -210,7 +210,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
210
210
  switch (_a.label) {
211
211
  case 0:
212
212
  // verify required parameter 'code' is not null or undefined
213
- (0, common_1.assertParamExists)('getPolicy', 'code', code);
213
+ (0, common_1.assertParamExists)('getPaymentReminder', 'code', code);
214
214
  localVarPath = "/paymentservice/v1/payment-reminders/{code}"
215
215
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
216
216
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -243,7 +243,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
243
243
  });
244
244
  },
245
245
  /**
246
- * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
246
+ * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
247
247
  * @summary List payment reminders
248
248
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
249
249
  * @param {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>
@@ -313,7 +313,7 @@ var PaymentRemindersApiFp = function (configuration) {
313
313
  var localVarAxiosParamCreator = (0, exports.PaymentRemindersApiAxiosParamCreator)(configuration);
314
314
  return {
315
315
  /**
316
- * This will create a payment reminder in the database.
316
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
317
317
  * @summary Create the payment reminder
318
318
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
319
319
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -334,7 +334,7 @@ var PaymentRemindersApiFp = function (configuration) {
334
334
  });
335
335
  },
336
336
  /**
337
- * This will deactivate the payment reminder
337
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
338
338
  * @summary Deactivate payment reminder
339
339
  * @param {string} code Unique identifier for the object.
340
340
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -356,19 +356,19 @@ var PaymentRemindersApiFp = function (configuration) {
356
356
  });
357
357
  },
358
358
  /**
359
- * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
359
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
360
360
  * @summary Retrieve the payment reminder
361
361
  * @param {string} code
362
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
363
  * @param {*} [options] Override http request option.
364
364
  * @throws {RequiredError}
365
365
  */
366
- getPolicy: function (code, authorization, options) {
366
+ getPaymentReminder: function (code, authorization, options) {
367
367
  return __awaiter(this, void 0, void 0, function () {
368
368
  var localVarAxiosArgs;
369
369
  return __generator(this, function (_a) {
370
370
  switch (_a.label) {
371
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPolicy(code, authorization, options)];
371
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPaymentReminder(code, authorization, options)];
372
372
  case 1:
373
373
  localVarAxiosArgs = _a.sent();
374
374
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -377,7 +377,7 @@ var PaymentRemindersApiFp = function (configuration) {
377
377
  });
378
378
  },
379
379
  /**
380
- * 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.
380
+ * 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\"
381
381
  * @summary List payment reminders
382
382
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
383
383
  * @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>
@@ -411,7 +411,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
411
411
  var localVarFp = (0, exports.PaymentRemindersApiFp)(configuration);
412
412
  return {
413
413
  /**
414
- * This will create a payment reminder in the database.
414
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
415
415
  * @summary Create the payment reminder
416
416
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
417
417
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -422,7 +422,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
422
422
  return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
423
423
  },
424
424
  /**
425
- * This will deactivate the payment reminder
425
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
426
426
  * @summary Deactivate payment reminder
427
427
  * @param {string} code Unique identifier for the object.
428
428
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -434,18 +434,18 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
434
434
  return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
435
435
  },
436
436
  /**
437
- * 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.
437
+ * 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\"
438
438
  * @summary Retrieve the payment reminder
439
439
  * @param {string} code
440
440
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
441
441
  * @param {*} [options] Override http request option.
442
442
  * @throws {RequiredError}
443
443
  */
444
- getPolicy: function (code, authorization, options) {
445
- return localVarFp.getPolicy(code, authorization, options).then(function (request) { return request(axios, basePath); });
444
+ getPaymentReminder: function (code, authorization, options) {
445
+ return localVarFp.getPaymentReminder(code, authorization, options).then(function (request) { return request(axios, basePath); });
446
446
  },
447
447
  /**
448
- * 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.
448
+ * 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\"
449
449
  * @summary List payment reminders
450
450
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
451
451
  * @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>
@@ -473,7 +473,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
473
473
  return _super !== null && _super.apply(this, arguments) || this;
474
474
  }
475
475
  /**
476
- * This will create a payment reminder in the database.
476
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
477
477
  * @summary Create the payment reminder
478
478
  * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
479
479
  * @param {*} [options] Override http request option.
@@ -485,7 +485,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
485
485
  return (0, exports.PaymentRemindersApiFp)(this.configuration).createPaymentReminder(requestParameters.createPaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
486
486
  };
487
487
  /**
488
- * This will deactivate the payment reminder
488
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
489
489
  * @summary Deactivate payment reminder
490
490
  * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
491
491
  * @param {*} [options] Override http request option.
@@ -497,19 +497,19 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
497
497
  return (0, exports.PaymentRemindersApiFp)(this.configuration).deactivatePaymentReminder(requestParameters.code, requestParameters.deactivatePaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
498
498
  };
499
499
  /**
500
- * 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.
500
+ * 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\"
501
501
  * @summary Retrieve the payment reminder
502
- * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
502
+ * @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
503
503
  * @param {*} [options] Override http request option.
504
504
  * @throws {RequiredError}
505
505
  * @memberof PaymentRemindersApi
506
506
  */
507
- PaymentRemindersApi.prototype.getPolicy = function (requestParameters, options) {
507
+ PaymentRemindersApi.prototype.getPaymentReminder = function (requestParameters, options) {
508
508
  var _this = this;
509
- return (0, exports.PaymentRemindersApiFp)(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
509
+ return (0, exports.PaymentRemindersApiFp)(this.configuration).getPaymentReminder(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
510
510
  };
511
511
  /**
512
- * 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.
512
+ * 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\"
513
513
  * @summary List payment reminders
514
514
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
515
515
  * @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.
@@ -93,7 +93,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * 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.
96
+ * 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\"
97
97
  * @summary Complete a payment setup
98
98
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
99
99
  * @param {string} [authorization] Bearer Token
@@ -142,7 +142,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
142
142
  });
143
143
  },
144
144
  /**
145
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
145
+ * 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\"
146
146
  * @summary Initiate a payment setup
147
147
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
148
148
  * @param {string} [authorization] Bearer Token
@@ -201,7 +201,7 @@ var PaymentSetupApiFp = function (configuration) {
201
201
  var localVarAxiosParamCreator = (0, exports.PaymentSetupApiAxiosParamCreator)(configuration);
202
202
  return {
203
203
  /**
204
- * 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.
204
+ * 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\"
205
205
  * @summary Complete a payment setup
206
206
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
207
207
  * @param {string} [authorization] Bearer Token
@@ -222,7 +222,7 @@ var PaymentSetupApiFp = function (configuration) {
222
222
  });
223
223
  },
224
224
  /**
225
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
225
+ * 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\"
226
226
  * @summary Initiate a payment setup
227
227
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
228
228
  * @param {string} [authorization] Bearer Token
@@ -253,7 +253,7 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
253
253
  var localVarFp = (0, exports.PaymentSetupApiFp)(configuration);
254
254
  return {
255
255
  /**
256
- * 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.
256
+ * 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\"
257
257
  * @summary Complete a payment setup
258
258
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
259
259
  * @param {string} [authorization] Bearer Token
@@ -264,7 +264,7 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
264
264
  return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
265
265
  },
266
266
  /**
267
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
267
+ * 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\"
268
268
  * @summary Initiate a payment setup
269
269
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
270
270
  * @param {string} [authorization] Bearer Token
@@ -289,7 +289,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
289
289
  return _super !== null && _super.apply(this, arguments) || this;
290
290
  }
291
291
  /**
292
- * 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.
292
+ * 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\"
293
293
  * @summary Complete a payment setup
294
294
  * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
295
295
  * @param {*} [options] Override http request option.
@@ -301,7 +301,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
301
301
  return (0, exports.PaymentSetupApiFp)(this.configuration).completePaymentSetup(requestParameters.completePaymentSetupRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
302
302
  };
303
303
  /**
304
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
304
+ * 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\"
305
305
  * @summary Initiate a payment setup
306
306
  * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
307
307
  * @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.
@@ -93,7 +93,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * This will create a payment for a specified account. This function is idempotent.
96
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
97
97
  * @summary Create the payment
98
98
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
99
99
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -148,7 +148,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
148
148
  });
149
149
  },
150
150
  /**
151
- * 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.
151
+ * 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\"
152
152
  * @summary Retrieve the payment
153
153
  * @param {string} code
154
154
  * @param {string} [authorization] Bearer Token
@@ -200,7 +200,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
200
200
  });
201
201
  },
202
202
  /**
203
- * 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.
203
+ * 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\"
204
204
  * @summary List payments
205
205
  * @param {string} [authorization] Bearer Token
206
206
  * @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;
@@ -270,7 +270,7 @@ var PaymentsApiFp = function (configuration) {
270
270
  var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
271
271
  return {
272
272
  /**
273
- * This will create a payment for a specified account. This function is idempotent.
273
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
274
274
  * @summary Create the payment
275
275
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
276
276
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -292,7 +292,7 @@ var PaymentsApiFp = function (configuration) {
292
292
  });
293
293
  },
294
294
  /**
295
- * 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.
295
+ * 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\"
296
296
  * @summary Retrieve the payment
297
297
  * @param {string} code
298
298
  * @param {string} [authorization] Bearer Token
@@ -314,7 +314,7 @@ var PaymentsApiFp = function (configuration) {
314
314
  });
315
315
  },
316
316
  /**
317
- * 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.
317
+ * 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\"
318
318
  * @summary List payments
319
319
  * @param {string} [authorization] Bearer Token
320
320
  * @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;
@@ -348,7 +348,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
348
348
  var localVarFp = (0, exports.PaymentsApiFp)(configuration);
349
349
  return {
350
350
  /**
351
- * This will create a payment for a specified account. This function is idempotent.
351
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
352
352
  * @summary Create the payment
353
353
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
354
354
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -360,7 +360,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
360
360
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
361
361
  },
362
362
  /**
363
- * 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.
363
+ * 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\"
364
364
  * @summary Retrieve the payment
365
365
  * @param {string} code
366
366
  * @param {string} [authorization] Bearer Token
@@ -372,7 +372,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
372
372
  return localVarFp.getPayment(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
373
373
  },
374
374
  /**
375
- * 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.
375
+ * 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\"
376
376
  * @summary List payments
377
377
  * @param {string} [authorization] Bearer Token
378
378
  * @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;
@@ -400,7 +400,7 @@ var PaymentsApi = /** @class */ (function (_super) {
400
400
  return _super !== null && _super.apply(this, arguments) || this;
401
401
  }
402
402
  /**
403
- * This will create a payment for a specified account. This function is idempotent.
403
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
404
404
  * @summary Create the payment
405
405
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
406
406
  * @param {*} [options] Override http request option.
@@ -412,7 +412,7 @@ var PaymentsApi = /** @class */ (function (_super) {
412
412
  return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
413
413
  };
414
414
  /**
415
- * 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.
415
+ * 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\"
416
416
  * @summary Retrieve the payment
417
417
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
418
418
  * @param {*} [options] Override http request option.
@@ -424,7 +424,7 @@ var PaymentsApi = /** @class */ (function (_super) {
424
424
  return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
425
425
  };
426
426
  /**
427
- * 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.
427
+ * 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\"
428
428
  * @summary List payments
429
429
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
430
430
  * @param {*} [options] Override http request option.