@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
@@ -43,7 +43,7 @@ const FormData = require('form-data');
43
43
  export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Configuration) {
44
44
  return {
45
45
  /**
46
- * This will create a payment reminder in the database.
46
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
47
47
  * @summary Create the payment reminder
48
48
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
49
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -90,7 +90,7 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
90
90
  };
91
91
  },
92
92
  /**
93
- * This will deactivate the payment reminder
93
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
94
94
  * @summary Deactivate payment reminder
95
95
  * @param {string} code Unique identifier for the object.
96
96
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -141,16 +141,16 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
141
141
  };
142
142
  },
143
143
  /**
144
- * 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.
144
+ * 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\"
145
145
  * @summary Retrieve the payment reminder
146
146
  * @param {string} code
147
147
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
148
148
  * @param {*} [options] Override http request option.
149
149
  * @throws {RequiredError}
150
150
  */
151
- getPolicy: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
151
+ getPaymentReminder: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
152
152
  // verify required parameter 'code' is not null or undefined
153
- assertParamExists('getPolicy', 'code', code)
153
+ assertParamExists('getPaymentReminder', 'code', code)
154
154
  const localVarPath = `/paymentservice/v1/payment-reminders/{code}`
155
155
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
156
156
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -186,7 +186,7 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
186
186
  };
187
187
  },
188
188
  /**
189
- * 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.
189
+ * 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\"
190
190
  * @summary List payment reminders
191
191
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
192
192
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
@@ -257,7 +257,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
257
257
  const localVarAxiosParamCreator = PaymentRemindersApiAxiosParamCreator(configuration)
258
258
  return {
259
259
  /**
260
- * This will create a payment reminder in the database.
260
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
261
261
  * @summary Create the payment reminder
262
262
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
263
263
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -269,7 +269,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
269
269
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
270
270
  },
271
271
  /**
272
- * This will deactivate the payment reminder
272
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
273
273
  * @summary Deactivate payment reminder
274
274
  * @param {string} code Unique identifier for the object.
275
275
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -282,19 +282,19 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
282
282
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
283
283
  },
284
284
  /**
285
- * 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.
285
+ * 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\"
286
286
  * @summary Retrieve the payment reminder
287
287
  * @param {string} code
288
288
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
289
289
  * @param {*} [options] Override http request option.
290
290
  * @throws {RequiredError}
291
291
  */
292
- async getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>> {
293
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPolicy(code, authorization, options);
292
+ async getPaymentReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>> {
293
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentReminder(code, authorization, options);
294
294
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
295
295
  },
296
296
  /**
297
- * 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.
297
+ * 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\"
298
298
  * @summary List payment reminders
299
299
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
300
300
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
@@ -319,7 +319,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
319
319
  const localVarFp = PaymentRemindersApiFp(configuration)
320
320
  return {
321
321
  /**
322
- * This will create a payment reminder in the database.
322
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
323
323
  * @summary Create the payment reminder
324
324
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
325
325
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -330,7 +330,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
330
330
  return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
331
331
  },
332
332
  /**
333
- * This will deactivate the payment reminder
333
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
334
334
  * @summary Deactivate payment reminder
335
335
  * @param {string} code Unique identifier for the object.
336
336
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -342,18 +342,18 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
342
342
  return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
343
343
  },
344
344
  /**
345
- * 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.
345
+ * 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\"
346
346
  * @summary Retrieve the payment reminder
347
347
  * @param {string} code
348
348
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
349
349
  * @param {*} [options] Override http request option.
350
350
  * @throws {RequiredError}
351
351
  */
352
- getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass> {
353
- return localVarFp.getPolicy(code, authorization, options).then((request) => request(axios, basePath));
352
+ getPaymentReminder(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass> {
353
+ return localVarFp.getPaymentReminder(code, authorization, options).then((request) => request(axios, basePath));
354
354
  },
355
355
  /**
356
- * 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.
356
+ * 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\"
357
357
  * @summary List payment reminders
358
358
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
359
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, policyCode, nextReminderDate&lt;/i&gt;
@@ -419,22 +419,22 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
419
419
  }
420
420
 
421
421
  /**
422
- * Request parameters for getPolicy operation in PaymentRemindersApi.
422
+ * Request parameters for getPaymentReminder operation in PaymentRemindersApi.
423
423
  * @export
424
- * @interface PaymentRemindersApiGetPolicyRequest
424
+ * @interface PaymentRemindersApiGetPaymentReminderRequest
425
425
  */
426
- export interface PaymentRemindersApiGetPolicyRequest {
426
+ export interface PaymentRemindersApiGetPaymentReminderRequest {
427
427
  /**
428
428
  *
429
429
  * @type {string}
430
- * @memberof PaymentRemindersApiGetPolicy
430
+ * @memberof PaymentRemindersApiGetPaymentReminder
431
431
  */
432
432
  readonly code: string
433
433
 
434
434
  /**
435
435
  * Bearer Token: provided by the login endpoint under the name accessToken.
436
436
  * @type {string}
437
- * @memberof PaymentRemindersApiGetPolicy
437
+ * @memberof PaymentRemindersApiGetPaymentReminder
438
438
  */
439
439
  readonly authorization?: string
440
440
  }
@@ -489,7 +489,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
489
489
  */
490
490
  export class PaymentRemindersApi extends BaseAPI {
491
491
  /**
492
- * This will create a payment reminder in the database.
492
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
493
493
  * @summary Create the payment reminder
494
494
  * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
495
495
  * @param {*} [options] Override http request option.
@@ -501,7 +501,7 @@ export class PaymentRemindersApi extends BaseAPI {
501
501
  }
502
502
 
503
503
  /**
504
- * This will deactivate the payment reminder
504
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
505
505
  * @summary Deactivate payment reminder
506
506
  * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
507
507
  * @param {*} [options] Override http request option.
@@ -513,19 +513,19 @@ export class PaymentRemindersApi extends BaseAPI {
513
513
  }
514
514
 
515
515
  /**
516
- * 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.
516
+ * 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\"
517
517
  * @summary Retrieve the payment reminder
518
- * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
518
+ * @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
519
519
  * @param {*} [options] Override http request option.
520
520
  * @throws {RequiredError}
521
521
  * @memberof PaymentRemindersApi
522
522
  */
523
- public getPolicy(requestParameters: PaymentRemindersApiGetPolicyRequest, options?: AxiosRequestConfig) {
524
- return PaymentRemindersApiFp(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
523
+ public getPaymentReminder(requestParameters: PaymentRemindersApiGetPaymentReminderRequest, options?: AxiosRequestConfig) {
524
+ return PaymentRemindersApiFp(this.configuration).getPaymentReminder(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
525
525
  }
526
526
 
527
527
  /**
528
- * 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.
528
+ * 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\"
529
529
  * @summary List payment reminders
530
530
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
531
531
  * @param {*} [options] Override http request option.
@@ -39,7 +39,7 @@ const FormData = require('form-data');
39
39
  export const PaymentSetupApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * 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.
42
+ * 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\"
43
43
  * @summary Complete a payment setup
44
44
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
45
45
  * @param {string} [authorization] Bearer Token
@@ -86,7 +86,7 @@ export const PaymentSetupApiAxiosParamCreator = function (configuration?: Config
86
86
  };
87
87
  },
88
88
  /**
89
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
89
+ * 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\"
90
90
  * @summary Initiate a payment setup
91
91
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
92
92
  * @param {string} [authorization] Bearer Token
@@ -143,7 +143,7 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
143
143
  const localVarAxiosParamCreator = PaymentSetupApiAxiosParamCreator(configuration)
144
144
  return {
145
145
  /**
146
- * 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.
146
+ * 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\"
147
147
  * @summary Complete a payment setup
148
148
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
149
149
  * @param {string} [authorization] Bearer Token
@@ -155,7 +155,7 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
155
155
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
156
156
  },
157
157
  /**
158
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
158
+ * 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\"
159
159
  * @summary Initiate a payment setup
160
160
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
161
161
  * @param {string} [authorization] Bearer Token
@@ -177,7 +177,7 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
177
177
  const localVarFp = PaymentSetupApiFp(configuration)
178
178
  return {
179
179
  /**
180
- * 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.
180
+ * 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\"
181
181
  * @summary Complete a payment setup
182
182
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
183
183
  * @param {string} [authorization] Bearer Token
@@ -188,7 +188,7 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
188
188
  return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, authorization, options).then((request) => request(axios, basePath));
189
189
  },
190
190
  /**
191
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
191
+ * 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\"
192
192
  * @summary Initiate a payment setup
193
193
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
194
194
  * @param {string} [authorization] Bearer Token
@@ -251,7 +251,7 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
251
251
  */
252
252
  export class PaymentSetupApi extends BaseAPI {
253
253
  /**
254
- * 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.
254
+ * 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\"
255
255
  * @summary Complete a payment setup
256
256
  * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
257
257
  * @param {*} [options] Override http request option.
@@ -263,7 +263,7 @@ export class PaymentSetupApi extends BaseAPI {
263
263
  }
264
264
 
265
265
  /**
266
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
266
+ * 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\"
267
267
  * @summary Initiate a payment setup
268
268
  * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
269
269
  * @param {*} [options] Override http request option.
@@ -39,7 +39,7 @@ const FormData = require('form-data');
39
39
  export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * This will create a payment for a specified account. This function is idempotent.
42
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
43
43
  * @summary Create the payment
44
44
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
45
45
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -93,7 +93,7 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
93
93
  };
94
94
  },
95
95
  /**
96
- * 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.
96
+ * 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\"
97
97
  * @summary Retrieve the payment
98
98
  * @param {string} code
99
99
  * @param {string} [authorization] Bearer Token
@@ -143,7 +143,7 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
143
143
  };
144
144
  },
145
145
  /**
146
- * 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.
146
+ * 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\"
147
147
  * @summary List payments
148
148
  * @param {string} [authorization] Bearer Token
149
149
  * @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;
@@ -214,7 +214,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
214
214
  const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
215
215
  return {
216
216
  /**
217
- * This will create a payment for a specified account. This function is idempotent.
217
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
218
218
  * @summary Create the payment
219
219
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
220
220
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -227,7 +227,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
227
227
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
228
228
  },
229
229
  /**
230
- * 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.
230
+ * 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\"
231
231
  * @summary Retrieve the payment
232
232
  * @param {string} code
233
233
  * @param {string} [authorization] Bearer Token
@@ -240,7 +240,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
240
240
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
241
241
  },
242
242
  /**
243
- * 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.
243
+ * 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\"
244
244
  * @summary List payments
245
245
  * @param {string} [authorization] Bearer Token
246
246
  * @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;
@@ -265,7 +265,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
265
265
  const localVarFp = PaymentsApiFp(configuration)
266
266
  return {
267
267
  /**
268
- * This will create a payment for a specified account. This function is idempotent.
268
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
269
269
  * @summary Create the payment
270
270
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
271
271
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -277,7 +277,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
277
277
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then((request) => request(axios, basePath));
278
278
  },
279
279
  /**
280
- * 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.
280
+ * 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\"
281
281
  * @summary Retrieve the payment
282
282
  * @param {string} code
283
283
  * @param {string} [authorization] Bearer Token
@@ -289,7 +289,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
289
289
  return localVarFp.getPayment(code, authorization, expand, options).then((request) => request(axios, basePath));
290
290
  },
291
291
  /**
292
- * 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.
292
+ * 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\"
293
293
  * @summary List payments
294
294
  * @param {string} [authorization] Bearer Token
295
295
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug&lt;/i&gt;
@@ -411,7 +411,7 @@ export interface PaymentsApiListPaymentsRequest {
411
411
  */
412
412
  export class PaymentsApi extends BaseAPI {
413
413
  /**
414
- * This will create a payment for a specified account. This function is idempotent.
414
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
415
415
  * @summary Create the payment
416
416
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
417
417
  * @param {*} [options] Override http request option.
@@ -423,7 +423,7 @@ export class PaymentsApi extends BaseAPI {
423
423
  }
424
424
 
425
425
  /**
426
- * 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.
426
+ * 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\"
427
427
  * @summary Retrieve the payment
428
428
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
429
429
  * @param {*} [options] Override http request option.
@@ -435,7 +435,7 @@ export class PaymentsApi extends BaseAPI {
435
435
  }
436
436
 
437
437
  /**
438
- * 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.
438
+ * 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\"
439
439
  * @summary List payments
440
440
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
441
441
  * @param {*} [options] Override http request option.
@@ -39,7 +39,7 @@ const FormData = require('form-data');
39
39
  export const RefundsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * This will create a refund in the database.
42
+ * This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
43
43
  * @summary Create the refund
44
44
  * @param {CreateRefundRequestDto} createRefundRequestDto
45
45
  * @param {string} [authorization] Bearer Token
@@ -86,7 +86,7 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
86
86
  };
87
87
  },
88
88
  /**
89
- * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
89
+ * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
90
90
  * @summary Retrieve the refund
91
91
  * @param {string} code
92
92
  * @param {string} [authorization] Bearer Token
@@ -136,7 +136,7 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
136
136
  };
137
137
  },
138
138
  /**
139
- * Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
139
+ * Returns a list of refunds you have previously created. The refunds 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\"
140
140
  * @summary List refunds
141
141
  * @param {string} [authorization] Bearer Token
142
142
  * @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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
@@ -212,7 +212,7 @@ export const RefundsApiFp = function(configuration?: Configuration) {
212
212
  const localVarAxiosParamCreator = RefundsApiAxiosParamCreator(configuration)
213
213
  return {
214
214
  /**
215
- * This will create a refund in the database.
215
+ * This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
216
216
  * @summary Create the refund
217
217
  * @param {CreateRefundRequestDto} createRefundRequestDto
218
218
  * @param {string} [authorization] Bearer Token
@@ -224,7 +224,7 @@ export const RefundsApiFp = function(configuration?: Configuration) {
224
224
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
225
225
  },
226
226
  /**
227
- * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
227
+ * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
228
228
  * @summary Retrieve the refund
229
229
  * @param {string} code
230
230
  * @param {string} [authorization] Bearer Token
@@ -237,7 +237,7 @@ export const RefundsApiFp = function(configuration?: Configuration) {
237
237
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
238
238
  },
239
239
  /**
240
- * Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
240
+ * Returns a list of refunds you have previously created. The refunds 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\"
241
241
  * @summary List refunds
242
242
  * @param {string} [authorization] Bearer Token
243
243
  * @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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
@@ -263,7 +263,7 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
263
263
  const localVarFp = RefundsApiFp(configuration)
264
264
  return {
265
265
  /**
266
- * This will create a refund in the database.
266
+ * This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
267
267
  * @summary Create the refund
268
268
  * @param {CreateRefundRequestDto} createRefundRequestDto
269
269
  * @param {string} [authorization] Bearer Token
@@ -274,7 +274,7 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
274
274
  return localVarFp.createRefund(createRefundRequestDto, authorization, options).then((request) => request(axios, basePath));
275
275
  },
276
276
  /**
277
- * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
277
+ * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
278
278
  * @summary Retrieve the refund
279
279
  * @param {string} code
280
280
  * @param {string} [authorization] Bearer Token
@@ -286,7 +286,7 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
286
286
  return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
287
287
  },
288
288
  /**
289
- * Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
289
+ * Returns a list of refunds you have previously created. The refunds 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\"
290
290
  * @summary List refunds
291
291
  * @param {string} [authorization] Bearer Token
292
292
  * @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, status, reason, psp, accountCode, invoiceCode&lt;/i&gt;
@@ -409,7 +409,7 @@ export interface RefundsApiListRefundsRequest {
409
409
  */
410
410
  export class RefundsApi extends BaseAPI {
411
411
  /**
412
- * This will create a refund in the database.
412
+ * This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
413
413
  * @summary Create the refund
414
414
  * @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
415
415
  * @param {*} [options] Override http request option.
@@ -421,7 +421,7 @@ export class RefundsApi extends BaseAPI {
421
421
  }
422
422
 
423
423
  /**
424
- * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
424
+ * Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
425
425
  * @summary Retrieve the refund
426
426
  * @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
427
427
  * @param {*} [options] Override http request option.
@@ -433,7 +433,7 @@ export class RefundsApi extends BaseAPI {
433
433
  }
434
434
 
435
435
  /**
436
- * Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
436
+ * Returns a list of refunds you have previously created. The refunds 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\"
437
437
  * @summary List refunds
438
438
  * @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
439
439
  * @param {*} [options] Override http request option.
@@ -31,7 +31,7 @@ const FormData = require('form-data');
31
31
  export const WebhooksApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
34
- * This will processes the webhook from external payment service provider.
34
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
35
35
  * @summary Handle the webhook from PSP
36
36
  * @param {string} pspType The type of the payment service provider (PSP).&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Supported PSP: braintree, stripe, b4u, eis, adyen&lt;/i&gt;
37
37
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -91,7 +91,7 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
91
91
  const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration)
92
92
  return {
93
93
  /**
94
- * This will processes the webhook from external payment service provider.
94
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
95
95
  * @summary Handle the webhook from PSP
96
96
  * @param {string} pspType The type of the payment service provider (PSP).&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Supported PSP: braintree, stripe, b4u, eis, adyen&lt;/i&gt;
97
97
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -115,7 +115,7 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
115
115
  const localVarFp = WebhooksApiFp(configuration)
116
116
  return {
117
117
  /**
118
- * This will processes the webhook from external payment service provider.
118
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
119
119
  * @summary Handle the webhook from PSP
120
120
  * @param {string} pspType The type of the payment service provider (PSP).&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Supported PSP: braintree, stripe, b4u, eis, adyen&lt;/i&gt;
121
121
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -173,7 +173,7 @@ export interface WebhooksApiPostWebhookRequest {
173
173
  */
174
174
  export class WebhooksApi extends BaseAPI {
175
175
  /**
176
- * This will processes the webhook from external payment service provider.
176
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
177
177
  * @summary Handle the webhook from PSP
178
178
  * @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
179
179
  * @param {*} [options] Override http request option.