@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
@@ -39,7 +39,7 @@ import { ListPaymentRemindersResponseClass } from '../models';
39
39
  export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * This will create a payment reminder in the database.
42
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
43
43
  * @summary Create the payment reminder
44
44
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
45
45
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -86,7 +86,7 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
86
86
  };
87
87
  },
88
88
  /**
89
- * This will deactivate the payment reminder
89
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
90
90
  * @summary Deactivate payment reminder
91
91
  * @param {string} code Unique identifier for the object.
92
92
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -137,16 +137,16 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
137
137
  };
138
138
  },
139
139
  /**
140
- * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
140
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
141
141
  * @summary Retrieve the payment reminder
142
142
  * @param {string} code
143
143
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
144
  * @param {*} [options] Override http request option.
145
145
  * @throws {RequiredError}
146
146
  */
147
- getPolicy: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
147
+ getPaymentReminder: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
148
148
  // verify required parameter 'code' is not null or undefined
149
- assertParamExists('getPolicy', 'code', code)
149
+ assertParamExists('getPaymentReminder', 'code', code)
150
150
  const localVarPath = `/paymentservice/v1/payment-reminders/{code}`
151
151
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
152
152
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -182,7 +182,7 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
182
182
  };
183
183
  },
184
184
  /**
185
- * 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.
185
+ * 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\"
186
186
  * @summary List payment reminders
187
187
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
188
188
  * @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;
@@ -253,7 +253,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
253
253
  const localVarAxiosParamCreator = PaymentRemindersApiAxiosParamCreator(configuration)
254
254
  return {
255
255
  /**
256
- * This will create a payment reminder in the database.
256
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
257
257
  * @summary Create the payment reminder
258
258
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
259
259
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -265,7 +265,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
265
265
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
266
266
  },
267
267
  /**
268
- * This will deactivate the payment reminder
268
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
269
269
  * @summary Deactivate payment reminder
270
270
  * @param {string} code Unique identifier for the object.
271
271
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -278,19 +278,19 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
278
278
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
279
279
  },
280
280
  /**
281
- * 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.
281
+ * 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\"
282
282
  * @summary Retrieve the payment reminder
283
283
  * @param {string} code
284
284
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
285
285
  * @param {*} [options] Override http request option.
286
286
  * @throws {RequiredError}
287
287
  */
288
- async getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>> {
289
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPolicy(code, authorization, options);
288
+ async getPaymentReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>> {
289
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentReminder(code, authorization, options);
290
290
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
291
291
  },
292
292
  /**
293
- * 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.
293
+ * 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\"
294
294
  * @summary List payment reminders
295
295
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
296
296
  * @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;
@@ -315,7 +315,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
315
315
  const localVarFp = PaymentRemindersApiFp(configuration)
316
316
  return {
317
317
  /**
318
- * This will create a payment reminder in the database.
318
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
319
319
  * @summary Create the payment reminder
320
320
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
321
321
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -326,7 +326,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
326
326
  return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
327
327
  },
328
328
  /**
329
- * This will deactivate the payment reminder
329
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
330
330
  * @summary Deactivate payment reminder
331
331
  * @param {string} code Unique identifier for the object.
332
332
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
@@ -338,18 +338,18 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
338
338
  return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
339
339
  },
340
340
  /**
341
- * 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.
341
+ * 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\"
342
342
  * @summary Retrieve the payment reminder
343
343
  * @param {string} code
344
344
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
345
345
  * @param {*} [options] Override http request option.
346
346
  * @throws {RequiredError}
347
347
  */
348
- getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass> {
349
- return localVarFp.getPolicy(code, authorization, options).then((request) => request(axios, basePath));
348
+ getPaymentReminder(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass> {
349
+ return localVarFp.getPaymentReminder(code, authorization, options).then((request) => request(axios, basePath));
350
350
  },
351
351
  /**
352
- * 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.
352
+ * 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\"
353
353
  * @summary List payment reminders
354
354
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
355
355
  * @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;
@@ -415,22 +415,22 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
415
415
  }
416
416
 
417
417
  /**
418
- * Request parameters for getPolicy operation in PaymentRemindersApi.
418
+ * Request parameters for getPaymentReminder operation in PaymentRemindersApi.
419
419
  * @export
420
- * @interface PaymentRemindersApiGetPolicyRequest
420
+ * @interface PaymentRemindersApiGetPaymentReminderRequest
421
421
  */
422
- export interface PaymentRemindersApiGetPolicyRequest {
422
+ export interface PaymentRemindersApiGetPaymentReminderRequest {
423
423
  /**
424
424
  *
425
425
  * @type {string}
426
- * @memberof PaymentRemindersApiGetPolicy
426
+ * @memberof PaymentRemindersApiGetPaymentReminder
427
427
  */
428
428
  readonly code: string
429
429
 
430
430
  /**
431
431
  * Bearer Token: provided by the login endpoint under the name accessToken.
432
432
  * @type {string}
433
- * @memberof PaymentRemindersApiGetPolicy
433
+ * @memberof PaymentRemindersApiGetPaymentReminder
434
434
  */
435
435
  readonly authorization?: string
436
436
  }
@@ -485,7 +485,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
485
485
  */
486
486
  export class PaymentRemindersApi extends BaseAPI {
487
487
  /**
488
- * This will create a payment reminder in the database.
488
+ * This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
489
489
  * @summary Create the payment reminder
490
490
  * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
491
491
  * @param {*} [options] Override http request option.
@@ -497,7 +497,7 @@ export class PaymentRemindersApi extends BaseAPI {
497
497
  }
498
498
 
499
499
  /**
500
- * This will deactivate the payment reminder
500
+ * This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
501
501
  * @summary Deactivate payment reminder
502
502
  * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
503
503
  * @param {*} [options] Override http request option.
@@ -509,19 +509,19 @@ export class PaymentRemindersApi extends BaseAPI {
509
509
  }
510
510
 
511
511
  /**
512
- * 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.
512
+ * 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\"
513
513
  * @summary Retrieve the payment reminder
514
- * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
514
+ * @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
515
515
  * @param {*} [options] Override http request option.
516
516
  * @throws {RequiredError}
517
517
  * @memberof PaymentRemindersApi
518
518
  */
519
- public getPolicy(requestParameters: PaymentRemindersApiGetPolicyRequest, options?: AxiosRequestConfig) {
520
- return PaymentRemindersApiFp(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
519
+ public getPaymentReminder(requestParameters: PaymentRemindersApiGetPaymentReminderRequest, options?: AxiosRequestConfig) {
520
+ return PaymentRemindersApiFp(this.configuration).getPaymentReminder(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
521
521
  }
522
522
 
523
523
  /**
524
- * 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.
524
+ * 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\"
525
525
  * @summary List payment reminders
526
526
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
527
527
  * @param {*} [options] Override http request option.
@@ -35,7 +35,7 @@ import { InitiatePaymentSetupResponseClass } from '../models';
35
35
  export const PaymentSetupApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * 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.
38
+ * 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\"
39
39
  * @summary Complete a payment setup
40
40
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
41
41
  * @param {string} [authorization] Bearer Token
@@ -82,7 +82,7 @@ export const PaymentSetupApiAxiosParamCreator = function (configuration?: Config
82
82
  };
83
83
  },
84
84
  /**
85
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
85
+ * 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\"
86
86
  * @summary Initiate a payment setup
87
87
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
88
88
  * @param {string} [authorization] Bearer Token
@@ -139,7 +139,7 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
139
139
  const localVarAxiosParamCreator = PaymentSetupApiAxiosParamCreator(configuration)
140
140
  return {
141
141
  /**
142
- * 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.
142
+ * 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\"
143
143
  * @summary Complete a payment setup
144
144
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
145
145
  * @param {string} [authorization] Bearer Token
@@ -151,7 +151,7 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
151
151
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
152
152
  },
153
153
  /**
154
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
154
+ * 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\"
155
155
  * @summary Initiate a payment setup
156
156
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
157
157
  * @param {string} [authorization] Bearer Token
@@ -173,7 +173,7 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
173
173
  const localVarFp = PaymentSetupApiFp(configuration)
174
174
  return {
175
175
  /**
176
- * 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.
176
+ * 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\"
177
177
  * @summary Complete a payment setup
178
178
  * @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
179
179
  * @param {string} [authorization] Bearer Token
@@ -184,7 +184,7 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
184
184
  return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, authorization, options).then((request) => request(axios, basePath));
185
185
  },
186
186
  /**
187
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
187
+ * 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\"
188
188
  * @summary Initiate a payment setup
189
189
  * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
190
190
  * @param {string} [authorization] Bearer Token
@@ -247,7 +247,7 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
247
247
  */
248
248
  export class PaymentSetupApi extends BaseAPI {
249
249
  /**
250
- * 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.
250
+ * 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\"
251
251
  * @summary Complete a payment setup
252
252
  * @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
253
253
  * @param {*} [options] Override http request option.
@@ -259,7 +259,7 @@ export class PaymentSetupApi extends BaseAPI {
259
259
  }
260
260
 
261
261
  /**
262
- * This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
262
+ * 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\"
263
263
  * @summary Initiate a payment setup
264
264
  * @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
265
265
  * @param {*} [options] Override http request option.
@@ -35,7 +35,7 @@ import { ListPaymentsResponseClass } from '../models';
35
35
  export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * This will create a payment for a specified account. This function is idempotent.
38
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
39
39
  * @summary Create the payment
40
40
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
41
41
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -89,7 +89,7 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
89
89
  };
90
90
  },
91
91
  /**
92
- * 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.
92
+ * 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\"
93
93
  * @summary Retrieve the payment
94
94
  * @param {string} code
95
95
  * @param {string} [authorization] Bearer Token
@@ -139,7 +139,7 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
139
139
  };
140
140
  },
141
141
  /**
142
- * 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.
142
+ * 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\"
143
143
  * @summary List payments
144
144
  * @param {string} [authorization] Bearer Token
145
145
  * @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;
@@ -210,7 +210,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
210
210
  const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
211
211
  return {
212
212
  /**
213
- * This will create a payment for a specified account. This function is idempotent.
213
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
214
214
  * @summary Create the payment
215
215
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
216
216
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -223,7 +223,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
223
223
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
224
224
  },
225
225
  /**
226
- * 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.
226
+ * 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\"
227
227
  * @summary Retrieve the payment
228
228
  * @param {string} code
229
229
  * @param {string} [authorization] Bearer Token
@@ -236,7 +236,7 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
236
236
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
237
237
  },
238
238
  /**
239
- * 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.
239
+ * 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\"
240
240
  * @summary List payments
241
241
  * @param {string} [authorization] Bearer Token
242
242
  * @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;
@@ -261,7 +261,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
261
261
  const localVarFp = PaymentsApiFp(configuration)
262
262
  return {
263
263
  /**
264
- * This will create a payment for a specified account. This function is idempotent.
264
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
265
265
  * @summary Create the payment
266
266
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
267
267
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
@@ -273,7 +273,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
273
273
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then((request) => request(axios, basePath));
274
274
  },
275
275
  /**
276
- * 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.
276
+ * 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\"
277
277
  * @summary Retrieve the payment
278
278
  * @param {string} code
279
279
  * @param {string} [authorization] Bearer Token
@@ -285,7 +285,7 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
285
285
  return localVarFp.getPayment(code, authorization, expand, options).then((request) => request(axios, basePath));
286
286
  },
287
287
  /**
288
- * 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.
288
+ * 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\"
289
289
  * @summary List payments
290
290
  * @param {string} [authorization] Bearer Token
291
291
  * @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;
@@ -407,7 +407,7 @@ export interface PaymentsApiListPaymentsRequest {
407
407
  */
408
408
  export class PaymentsApi extends BaseAPI {
409
409
  /**
410
- * This will create a payment for a specified account. This function is idempotent.
410
+ * This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
411
411
  * @summary Create the payment
412
412
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
413
413
  * @param {*} [options] Override http request option.
@@ -419,7 +419,7 @@ export class PaymentsApi extends BaseAPI {
419
419
  }
420
420
 
421
421
  /**
422
- * 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.
422
+ * 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\"
423
423
  * @summary Retrieve the payment
424
424
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
425
425
  * @param {*} [options] Override http request option.
@@ -431,7 +431,7 @@ export class PaymentsApi extends BaseAPI {
431
431
  }
432
432
 
433
433
  /**
434
- * 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.
434
+ * 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\"
435
435
  * @summary List payments
436
436
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
437
437
  * @param {*} [options] Override http request option.
@@ -35,7 +35,7 @@ import { ListRefundsResponseClass } from '../models';
35
35
  export const RefundsApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * This will create a refund in the database.
38
+ * This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
39
39
  * @summary Create the refund
40
40
  * @param {CreateRefundRequestDto} createRefundRequestDto
41
41
  * @param {string} [authorization] Bearer Token
@@ -82,7 +82,7 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
82
82
  };
83
83
  },
84
84
  /**
85
- * 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.
85
+ * 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\"
86
86
  * @summary Retrieve the refund
87
87
  * @param {string} code
88
88
  * @param {string} [authorization] Bearer Token
@@ -132,7 +132,7 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
132
132
  };
133
133
  },
134
134
  /**
135
- * 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.
135
+ * 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\"
136
136
  * @summary List refunds
137
137
  * @param {string} [authorization] Bearer Token
138
138
  * @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;
@@ -208,7 +208,7 @@ export const RefundsApiFp = function(configuration?: Configuration) {
208
208
  const localVarAxiosParamCreator = RefundsApiAxiosParamCreator(configuration)
209
209
  return {
210
210
  /**
211
- * This will create a refund in the database.
211
+ * This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
212
212
  * @summary Create the refund
213
213
  * @param {CreateRefundRequestDto} createRefundRequestDto
214
214
  * @param {string} [authorization] Bearer Token
@@ -220,7 +220,7 @@ export const RefundsApiFp = function(configuration?: Configuration) {
220
220
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
221
221
  },
222
222
  /**
223
- * 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.
223
+ * 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\"
224
224
  * @summary Retrieve the refund
225
225
  * @param {string} code
226
226
  * @param {string} [authorization] Bearer Token
@@ -233,7 +233,7 @@ export const RefundsApiFp = function(configuration?: Configuration) {
233
233
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
234
234
  },
235
235
  /**
236
- * 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.
236
+ * 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\"
237
237
  * @summary List refunds
238
238
  * @param {string} [authorization] Bearer Token
239
239
  * @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;
@@ -259,7 +259,7 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
259
259
  const localVarFp = RefundsApiFp(configuration)
260
260
  return {
261
261
  /**
262
- * This will create a refund in the database.
262
+ * This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
263
263
  * @summary Create the refund
264
264
  * @param {CreateRefundRequestDto} createRefundRequestDto
265
265
  * @param {string} [authorization] Bearer Token
@@ -270,7 +270,7 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
270
270
  return localVarFp.createRefund(createRefundRequestDto, authorization, options).then((request) => request(axios, basePath));
271
271
  },
272
272
  /**
273
- * 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.
273
+ * 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\"
274
274
  * @summary Retrieve the refund
275
275
  * @param {string} code
276
276
  * @param {string} [authorization] Bearer Token
@@ -282,7 +282,7 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
282
282
  return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
283
283
  },
284
284
  /**
285
- * 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.
285
+ * 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\"
286
286
  * @summary List refunds
287
287
  * @param {string} [authorization] Bearer Token
288
288
  * @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;
@@ -405,7 +405,7 @@ export interface RefundsApiListRefundsRequest {
405
405
  */
406
406
  export class RefundsApi extends BaseAPI {
407
407
  /**
408
- * This will create a refund in the database.
408
+ * This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
409
409
  * @summary Create the refund
410
410
  * @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
411
411
  * @param {*} [options] Override http request option.
@@ -417,7 +417,7 @@ export class RefundsApi extends BaseAPI {
417
417
  }
418
418
 
419
419
  /**
420
- * 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.
420
+ * 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\"
421
421
  * @summary Retrieve the refund
422
422
  * @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
423
423
  * @param {*} [options] Override http request option.
@@ -429,7 +429,7 @@ export class RefundsApi extends BaseAPI {
429
429
  }
430
430
 
431
431
  /**
432
- * 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.
432
+ * 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\"
433
433
  * @summary List refunds
434
434
  * @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
435
435
  * @param {*} [options] Override http request option.
@@ -27,7 +27,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
27
27
  export const WebhooksApiAxiosParamCreator = function (configuration?: Configuration) {
28
28
  return {
29
29
  /**
30
- * This will processes the webhook from external payment service provider.
30
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
31
31
  * @summary Handle the webhook from PSP
32
32
  * @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;
33
33
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -87,7 +87,7 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
87
87
  const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration)
88
88
  return {
89
89
  /**
90
- * This will processes the webhook from external payment service provider.
90
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
91
91
  * @summary Handle the webhook from PSP
92
92
  * @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;
93
93
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -111,7 +111,7 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
111
111
  const localVarFp = WebhooksApiFp(configuration)
112
112
  return {
113
113
  /**
114
- * This will processes the webhook from external payment service provider.
114
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
115
115
  * @summary Handle the webhook from PSP
116
116
  * @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;
117
117
  * @param {string} tenantSlug Unique slug identifier representing a tenant.
@@ -169,7 +169,7 @@ export interface WebhooksApiPostWebhookRequest {
169
169
  */
170
170
  export class WebhooksApi extends BaseAPI {
171
171
  /**
172
- * This will processes the webhook from external payment service provider.
172
+ * This will processes the webhook from external payment service provider. **Required Permissions** none
173
173
  * @summary Handle the webhook from PSP
174
174
  * @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
175
175
  * @param {*} [options] Override http request option.