@emilgroup/payment-sdk 1.4.1-beta.30 → 1.4.1-beta.31

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 (87) hide show
  1. package/.openapi-generator/FILES +5 -15
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +34 -38
  4. package/api/bank-transaction-api.ts +73 -77
  5. package/api/{default-api.ts → health-check-api.ts} +21 -17
  6. package/api/payment-methods-api.ts +52 -70
  7. package/api/payment-reminders-api.ts +63 -49
  8. package/api/payments-api.ts +52 -70
  9. package/api/refunds-api.ts +76 -88
  10. package/api/tenant-bank-account-api.ts +79 -63
  11. package/api/webhooks-api.ts +16 -12
  12. package/api.ts +2 -2
  13. package/dist/api/bank-accounts-api.d.ts +37 -39
  14. package/dist/api/bank-accounts-api.js +18 -18
  15. package/dist/api/bank-transaction-api.d.ts +77 -79
  16. package/dist/api/bank-transaction-api.js +45 -45
  17. package/dist/api/health-check-api.d.ts +70 -0
  18. package/dist/api/{default-api.js → health-check-api.js} +30 -26
  19. package/dist/api/payment-methods-api.d.ts +49 -58
  20. package/dist/api/payment-methods-api.js +32 -42
  21. package/dist/api/payment-reminders-api.d.ts +55 -46
  22. package/dist/api/payment-reminders-api.js +40 -34
  23. package/dist/api/payments-api.d.ts +49 -58
  24. package/dist/api/payments-api.js +32 -42
  25. package/dist/api/refunds-api.d.ts +76 -76
  26. package/dist/api/refunds-api.js +51 -49
  27. package/dist/api/tenant-bank-account-api.d.ts +71 -61
  28. package/dist/api/tenant-bank-account-api.js +51 -45
  29. package/dist/api/webhooks-api.d.ts +16 -12
  30. package/dist/api/webhooks-api.js +14 -10
  31. package/dist/api.d.ts +1 -1
  32. package/dist/api.js +1 -1
  33. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +20 -34
  34. package/dist/models/create-tenant-bank-account-response-class.d.ts +4 -4
  35. package/dist/models/get-tenant-bank-account-response-class.d.ts +4 -4
  36. package/dist/models/index.d.ts +4 -14
  37. package/dist/models/index.js +4 -14
  38. package/dist/models/list-tenant-bank-account-response-class.d.ts +5 -5
  39. package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +10 -10
  40. package/dist/models/tenant-bank-account-class.d.ts +73 -0
  41. package/dist/models/{get-bank-account-response-class.d.ts → update-tenant-bank-account-response-class.d.ts} +7 -7
  42. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +20 -34
  43. package/models/create-tenant-bank-account-response-class.ts +4 -4
  44. package/models/get-tenant-bank-account-response-class.ts +4 -4
  45. package/models/index.ts +4 -14
  46. package/models/list-tenant-bank-account-response-class.ts +5 -5
  47. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +10 -10
  48. package/models/tenant-bank-account-class.ts +79 -0
  49. package/models/{create-refund-response-class.ts → update-tenant-bank-account-response-class.ts} +7 -7
  50. package/package.json +1 -1
  51. package/dist/api/default-api.d.ts +0 -66
  52. package/dist/models/bank-account-class.d.ts +0 -73
  53. package/dist/models/create-refund-response-class.d.ts +0 -25
  54. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  55. package/dist/models/get-bank-transactions-response-class.js +0 -15
  56. package/dist/models/get-refund-response-class.d.ts +0 -25
  57. package/dist/models/get-refund-response-class.js +0 -15
  58. package/dist/models/get-request-dto.d.ts +0 -30
  59. package/dist/models/get-request-dto.js +0 -15
  60. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  61. package/dist/models/list-bank-transactions-response-class.js +0 -15
  62. package/dist/models/list-refunds-response-class.d.ts +0 -31
  63. package/dist/models/list-refunds-response-class.js +0 -15
  64. package/dist/models/primary-bank-account-response-class.d.ts +0 -42
  65. package/dist/models/primary-bank-account-response-class.js +0 -15
  66. package/dist/models/refund-class.d.ts +0 -105
  67. package/dist/models/refund-class.js +0 -29
  68. package/dist/models/tenant-bank-account-response-class.js +0 -15
  69. package/dist/models/transaction-class.d.ts +0 -54
  70. package/dist/models/transaction-class.js +0 -15
  71. package/dist/models/update-bank-account-response-class.d.ts +0 -25
  72. package/dist/models/update-bank-account-response-class.js +0 -15
  73. package/models/bank-account-class.ts +0 -79
  74. package/models/get-bank-account-response-class.ts +0 -31
  75. package/models/get-bank-transactions-response-class.ts +0 -31
  76. package/models/get-refund-response-class.ts +0 -31
  77. package/models/get-request-dto.ts +0 -36
  78. package/models/list-bank-transactions-response-class.ts +0 -37
  79. package/models/list-refunds-response-class.ts +0 -37
  80. package/models/primary-bank-account-response-class.ts +0 -48
  81. package/models/refund-class.ts +0 -115
  82. package/models/transaction-class.ts +0 -60
  83. package/models/update-bank-account-response-class.ts +0 -31
  84. /package/dist/models/{bank-account-class.js → bank-transaction-class-without-expand-properties.js} +0 -0
  85. /package/dist/models/{bank-transaction-response-class.js → tenant-bank-account-class-without-expand-properties.js} +0 -0
  86. /package/dist/models/{create-refund-response-class.js → tenant-bank-account-class.js} +0 -0
  87. /package/dist/models/{get-bank-account-response-class.js → update-tenant-bank-account-response-class.js} +0 -0
@@ -93,11 +93,11 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
97
- * @summary Retrieve the Bank Transaction
98
- * @param {string} code
96
+ * Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
97
+ * @summary Retrieve the bank transaction
98
+ * @param {string} code Unique identifier for the object.
99
99
  * @param {string} [authorization] Bearer Token
100
- * @param {string} [expand] Expand the response with additional entities
100
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction.<i>
101
101
  * @param {*} [options] Override http request option.
102
102
  * @throws {RequiredError}
103
103
  */
@@ -145,7 +145,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
145
145
  });
146
146
  },
147
147
  /**
148
- * Import bank transactions from a swift MT940 file
148
+ * This will import bank transactions from a swift MT940 file
149
149
  * @summary Create the bank transactions
150
150
  * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
151
151
  * @param {string} [authorization] Bearer Token
@@ -198,7 +198,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
198
198
  },
199
199
  /**
200
200
  * Links a bank transaction with an invoice
201
- * @summary Link Bank Transaction
201
+ * @summary Link bank transaction
202
202
  * @param {string} code Code of the bank transaction to link
203
203
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
204
204
  * @param {string} [authorization] Bearer Token
@@ -250,16 +250,16 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
250
250
  });
251
251
  },
252
252
  /**
253
- * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
253
+ * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
254
254
  * @summary List bank transactions
255
255
  * @param {string} [authorization] Bearer Token
256
256
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
257
257
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
258
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
259
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
260
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
261
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
262
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
258
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
259
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
260
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, amount, transactionDate, entryDate</i>
261
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction.<i>
262
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
263
263
  * @param {*} [options] Override http request option.
264
264
  * @throws {RequiredError}
265
265
  */
@@ -323,7 +323,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
323
323
  },
324
324
  /**
325
325
  * Unlinks an already linked bank transaction
326
- * @summary Unlink Bank Transaction
326
+ * @summary Unlink bank transaction
327
327
  * @param {string} code Code of the bank transaction to unlink
328
328
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
329
329
  * @param {string} [authorization] Bearer Token
@@ -385,11 +385,11 @@ var BankTransactionApiFp = function (configuration) {
385
385
  var localVarAxiosParamCreator = (0, exports.BankTransactionApiAxiosParamCreator)(configuration);
386
386
  return {
387
387
  /**
388
- * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
389
- * @summary Retrieve the Bank Transaction
390
- * @param {string} code
388
+ * Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
389
+ * @summary Retrieve the bank transaction
390
+ * @param {string} code Unique identifier for the object.
391
391
  * @param {string} [authorization] Bearer Token
392
- * @param {string} [expand] Expand the response with additional entities
392
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction.<i>
393
393
  * @param {*} [options] Override http request option.
394
394
  * @throws {RequiredError}
395
395
  */
@@ -407,7 +407,7 @@ var BankTransactionApiFp = function (configuration) {
407
407
  });
408
408
  },
409
409
  /**
410
- * Import bank transactions from a swift MT940 file
410
+ * This will import bank transactions from a swift MT940 file
411
411
  * @summary Create the bank transactions
412
412
  * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
413
413
  * @param {string} [authorization] Bearer Token
@@ -429,7 +429,7 @@ var BankTransactionApiFp = function (configuration) {
429
429
  },
430
430
  /**
431
431
  * Links a bank transaction with an invoice
432
- * @summary Link Bank Transaction
432
+ * @summary Link bank transaction
433
433
  * @param {string} code Code of the bank transaction to link
434
434
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
435
435
  * @param {string} [authorization] Bearer Token
@@ -450,16 +450,16 @@ var BankTransactionApiFp = function (configuration) {
450
450
  });
451
451
  },
452
452
  /**
453
- * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
453
+ * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
454
454
  * @summary List bank transactions
455
455
  * @param {string} [authorization] Bearer Token
456
456
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
457
457
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
458
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
459
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
460
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
461
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
462
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
458
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
459
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
460
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, amount, transactionDate, entryDate</i>
461
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction.<i>
462
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
463
463
  * @param {*} [options] Override http request option.
464
464
  * @throws {RequiredError}
465
465
  */
@@ -478,7 +478,7 @@ var BankTransactionApiFp = function (configuration) {
478
478
  },
479
479
  /**
480
480
  * Unlinks an already linked bank transaction
481
- * @summary Unlink Bank Transaction
481
+ * @summary Unlink bank transaction
482
482
  * @param {string} code Code of the bank transaction to unlink
483
483
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
484
484
  * @param {string} [authorization] Bearer Token
@@ -509,11 +509,11 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
509
509
  var localVarFp = (0, exports.BankTransactionApiFp)(configuration);
510
510
  return {
511
511
  /**
512
- * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
513
- * @summary Retrieve the Bank Transaction
514
- * @param {string} code
512
+ * Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
513
+ * @summary Retrieve the bank transaction
514
+ * @param {string} code Unique identifier for the object.
515
515
  * @param {string} [authorization] Bearer Token
516
- * @param {string} [expand] Expand the response with additional entities
516
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction.<i>
517
517
  * @param {*} [options] Override http request option.
518
518
  * @throws {RequiredError}
519
519
  */
@@ -521,7 +521,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
521
521
  return localVarFp.getBankTransaction(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
522
522
  },
523
523
  /**
524
- * Import bank transactions from a swift MT940 file
524
+ * This will import bank transactions from a swift MT940 file
525
525
  * @summary Create the bank transactions
526
526
  * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
527
527
  * @param {string} [authorization] Bearer Token
@@ -533,7 +533,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
533
533
  },
534
534
  /**
535
535
  * Links a bank transaction with an invoice
536
- * @summary Link Bank Transaction
536
+ * @summary Link bank transaction
537
537
  * @param {string} code Code of the bank transaction to link
538
538
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
539
539
  * @param {string} [authorization] Bearer Token
@@ -544,16 +544,16 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
544
544
  return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
545
545
  },
546
546
  /**
547
- * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
547
+ * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
548
548
  * @summary List bank transactions
549
549
  * @param {string} [authorization] Bearer Token
550
550
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
551
551
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
552
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
553
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
554
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
555
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
556
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
552
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
553
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
554
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, amount, transactionDate, entryDate</i>
555
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction.<i>
556
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
557
557
  * @param {*} [options] Override http request option.
558
558
  * @throws {RequiredError}
559
559
  */
@@ -562,7 +562,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
562
562
  },
563
563
  /**
564
564
  * Unlinks an already linked bank transaction
565
- * @summary Unlink Bank Transaction
565
+ * @summary Unlink bank transaction
566
566
  * @param {string} code Code of the bank transaction to unlink
567
567
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
568
568
  * @param {string} [authorization] Bearer Token
@@ -587,8 +587,8 @@ var BankTransactionApi = /** @class */ (function (_super) {
587
587
  return _super !== null && _super.apply(this, arguments) || this;
588
588
  }
589
589
  /**
590
- * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
591
- * @summary Retrieve the Bank Transaction
590
+ * Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
591
+ * @summary Retrieve the bank transaction
592
592
  * @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
593
593
  * @param {*} [options] Override http request option.
594
594
  * @throws {RequiredError}
@@ -599,7 +599,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
599
599
  return (0, exports.BankTransactionApiFp)(this.configuration).getBankTransaction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
600
600
  };
601
601
  /**
602
- * Import bank transactions from a swift MT940 file
602
+ * This will import bank transactions from a swift MT940 file
603
603
  * @summary Create the bank transactions
604
604
  * @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
605
605
  * @param {*} [options] Override http request option.
@@ -612,7 +612,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
612
612
  };
613
613
  /**
614
614
  * Links a bank transaction with an invoice
615
- * @summary Link Bank Transaction
615
+ * @summary Link bank transaction
616
616
  * @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
617
617
  * @param {*} [options] Override http request option.
618
618
  * @throws {RequiredError}
@@ -623,7 +623,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
623
623
  return (0, exports.BankTransactionApiFp)(this.configuration).linkBankTransaction(requestParameters.code, requestParameters.linkBankTransactionRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
624
624
  };
625
625
  /**
626
- * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
626
+ * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
627
627
  * @summary List bank transactions
628
628
  * @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
629
629
  * @param {*} [options] Override http request option.
@@ -637,7 +637,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
637
637
  };
638
638
  /**
639
639
  * Unlinks an already linked bank transaction
640
- * @summary Unlink Bank Transaction
640
+ * @summary Unlink bank transaction
641
641
  * @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
642
642
  * @param {*} [options] Override http request option.
643
643
  * @throws {RequiredError}
@@ -0,0 +1,70 @@
1
+ /**
2
+ * Emil Payment Service
3
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { InlineResponse200 } from '../models';
16
+ /**
17
+ * HealthCheckApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const HealthCheckApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ * Returns the health status of the payment service. This endpoint is used to monitor the operational status of the payment service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
23
+ * @summary Health Check
24
+ * @param {*} [options] Override http request option.
25
+ * @throws {RequiredError}
26
+ */
27
+ check: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
28
+ };
29
+ /**
30
+ * HealthCheckApi - functional programming interface
31
+ * @export
32
+ */
33
+ export declare const HealthCheckApiFp: (configuration?: Configuration) => {
34
+ /**
35
+ * Returns the health status of the payment service. This endpoint is used to monitor the operational status of the payment service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
36
+ * @summary Health Check
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
41
+ };
42
+ /**
43
+ * HealthCheckApi - factory interface
44
+ * @export
45
+ */
46
+ export declare const HealthCheckApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
47
+ /**
48
+ * Returns the health status of the payment service. This endpoint is used to monitor the operational status of the payment service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
49
+ * @summary Health Check
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ */
53
+ check(options?: any): AxiosPromise<InlineResponse200>;
54
+ };
55
+ /**
56
+ * HealthCheckApi - object-oriented interface
57
+ * @export
58
+ * @class HealthCheckApi
59
+ * @extends {BaseAPI}
60
+ */
61
+ export declare class HealthCheckApi extends BaseAPI {
62
+ /**
63
+ * Returns the health status of the payment service. This endpoint is used to monitor the operational status of the payment service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
64
+ * @summary Health Check
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ * @memberof HealthCheckApi
68
+ */
69
+ check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any>>;
70
+ }
@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
78
78
  return (mod && mod.__esModule) ? mod : { "default": mod };
79
79
  };
80
80
  Object.defineProperty(exports, "__esModule", { value: true });
81
- exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = void 0;
81
+ exports.HealthCheckApi = exports.HealthCheckApiFactory = exports.HealthCheckApiFp = exports.HealthCheckApiAxiosParamCreator = void 0;
82
82
  var axios_1 = __importDefault(require("axios"));
83
83
  // Some imports not used depending on template conditions
84
84
  // @ts-ignore
@@ -86,14 +86,15 @@ var common_1 = require("../common");
86
86
  // @ts-ignore
87
87
  var base_1 = require("../base");
88
88
  /**
89
- * DefaultApi - axios parameter creator
89
+ * HealthCheckApi - axios parameter creator
90
90
  * @export
91
91
  */
92
- var DefaultApiAxiosParamCreator = function (configuration) {
92
+ var HealthCheckApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- *
96
+ * Returns the health status of the payment service. This endpoint is used to monitor the operational status of the payment service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
97
+ * @summary Health Check
97
98
  * @param {*} [options] Override http request option.
98
99
  * @throws {RequiredError}
99
100
  */
@@ -123,16 +124,17 @@ var DefaultApiAxiosParamCreator = function (configuration) {
123
124
  },
124
125
  };
125
126
  };
126
- exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
127
+ exports.HealthCheckApiAxiosParamCreator = HealthCheckApiAxiosParamCreator;
127
128
  /**
128
- * DefaultApi - functional programming interface
129
+ * HealthCheckApi - functional programming interface
129
130
  * @export
130
131
  */
131
- var DefaultApiFp = function (configuration) {
132
- var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
132
+ var HealthCheckApiFp = function (configuration) {
133
+ var localVarAxiosParamCreator = (0, exports.HealthCheckApiAxiosParamCreator)(configuration);
133
134
  return {
134
135
  /**
135
- *
136
+ * Returns the health status of the payment service. This endpoint is used to monitor the operational status of the payment service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
137
+ * @summary Health Check
136
138
  * @param {*} [options] Override http request option.
137
139
  * @throws {RequiredError}
138
140
  */
@@ -151,16 +153,17 @@ var DefaultApiFp = function (configuration) {
151
153
  },
152
154
  };
153
155
  };
154
- exports.DefaultApiFp = DefaultApiFp;
156
+ exports.HealthCheckApiFp = HealthCheckApiFp;
155
157
  /**
156
- * DefaultApi - factory interface
158
+ * HealthCheckApi - factory interface
157
159
  * @export
158
160
  */
159
- var DefaultApiFactory = function (configuration, basePath, axios) {
160
- var localVarFp = (0, exports.DefaultApiFp)(configuration);
161
+ var HealthCheckApiFactory = function (configuration, basePath, axios) {
162
+ var localVarFp = (0, exports.HealthCheckApiFp)(configuration);
161
163
  return {
162
164
  /**
163
- *
165
+ * Returns the health status of the payment service. This endpoint is used to monitor the operational status of the payment service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
166
+ * @summary Health Check
164
167
  * @param {*} [options] Override http request option.
165
168
  * @throws {RequiredError}
166
169
  */
@@ -169,28 +172,29 @@ var DefaultApiFactory = function (configuration, basePath, axios) {
169
172
  },
170
173
  };
171
174
  };
172
- exports.DefaultApiFactory = DefaultApiFactory;
175
+ exports.HealthCheckApiFactory = HealthCheckApiFactory;
173
176
  /**
174
- * DefaultApi - object-oriented interface
177
+ * HealthCheckApi - object-oriented interface
175
178
  * @export
176
- * @class DefaultApi
179
+ * @class HealthCheckApi
177
180
  * @extends {BaseAPI}
178
181
  */
179
- var DefaultApi = /** @class */ (function (_super) {
180
- __extends(DefaultApi, _super);
181
- function DefaultApi() {
182
+ var HealthCheckApi = /** @class */ (function (_super) {
183
+ __extends(HealthCheckApi, _super);
184
+ function HealthCheckApi() {
182
185
  return _super !== null && _super.apply(this, arguments) || this;
183
186
  }
184
187
  /**
185
- *
188
+ * Returns the health status of the payment service. This endpoint is used to monitor the operational status of the payment service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
189
+ * @summary Health Check
186
190
  * @param {*} [options] Override http request option.
187
191
  * @throws {RequiredError}
188
- * @memberof DefaultApi
192
+ * @memberof HealthCheckApi
189
193
  */
190
- DefaultApi.prototype.check = function (options) {
194
+ HealthCheckApi.prototype.check = function (options) {
191
195
  var _this = this;
192
- return (0, exports.DefaultApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
196
+ return (0, exports.HealthCheckApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
193
197
  };
194
- return DefaultApi;
198
+ return HealthCheckApi;
195
199
  }(base_1.BaseAPI));
196
- exports.DefaultApi = DefaultApi;
200
+ exports.HealthCheckApi = HealthCheckApi;