@emilgroup/payment-sdk 1.4.1-beta.9 → 1.5.1-beta.0

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 (140) hide show
  1. package/.openapi-generator/FILES +11 -11
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +500 -88
  4. package/api/bank-transaction-api.ts +93 -123
  5. package/api/{default-api.ts → health-check-api.ts} +22 -18
  6. package/api/payment-methods-api.ts +61 -242
  7. package/api/payment-reminders-api.ts +57 -99
  8. package/api/payment-setup-api.ts +17 -9
  9. package/api/payments-api.ts +72 -135
  10. package/api/refunds-api.ts +80 -120
  11. package/api/tenant-bank-account-api.ts +96 -118
  12. package/api/webhooks-api.ts +38 -21
  13. package/api.ts +3 -3
  14. package/base.ts +22 -10
  15. package/common.ts +2 -2
  16. package/configuration.ts +1 -1
  17. package/dist/api/bank-accounts-api.d.ts +292 -69
  18. package/dist/api/bank-accounts-api.js +432 -62
  19. package/dist/api/bank-transaction-api.d.ts +84 -104
  20. package/dist/api/bank-transaction-api.js +63 -74
  21. package/dist/api/health-check-api.d.ts +70 -0
  22. package/dist/api/{default-api.js → health-check-api.js} +31 -27
  23. package/dist/api/payment-methods-api.d.ts +51 -151
  24. package/dist/api/payment-methods-api.js +48 -178
  25. package/dist/api/payment-reminders-api.d.ts +52 -79
  26. package/dist/api/payment-reminders-api.js +44 -62
  27. package/dist/api/payment-setup-api.d.ts +17 -9
  28. package/dist/api/payment-setup-api.js +17 -9
  29. package/dist/api/payments-api.d.ts +62 -98
  30. package/dist/api/payments-api.js +55 -85
  31. package/dist/api/refunds-api.d.ts +73 -91
  32. package/dist/api/refunds-api.js +58 -68
  33. package/dist/api/tenant-bank-account-api.d.ts +90 -105
  34. package/dist/api/tenant-bank-account-api.js +63 -75
  35. package/dist/api/webhooks-api.d.ts +29 -16
  36. package/dist/api/webhooks-api.js +29 -19
  37. package/dist/api.d.ts +2 -2
  38. package/dist/api.js +2 -2
  39. package/dist/base.d.ts +6 -3
  40. package/dist/base.js +31 -22
  41. package/dist/common.d.ts +2 -2
  42. package/dist/common.js +1 -1
  43. package/dist/configuration.d.ts +1 -1
  44. package/dist/configuration.js +1 -1
  45. package/dist/index.d.ts +1 -1
  46. package/dist/index.js +1 -1
  47. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +31 -33
  48. package/dist/models/{bank-transaction-response-class.js → bank-transaction-class-without-expand-properties.js} +1 -1
  49. package/dist/models/create-bank-account-request-dto.d.ts +42 -0
  50. package/dist/models/{get-refund-response-class.js → create-bank-account-request-dto.js} +1 -1
  51. package/dist/models/create-payment-reminder-request-dto.d.ts +1 -1
  52. package/dist/models/create-payment-reminder-request-dto.js +1 -1
  53. package/dist/models/create-payment-request-dto.d.ts +3 -3
  54. package/dist/models/create-payment-request-dto.js +1 -1
  55. package/dist/models/create-refund-request-dto.d.ts +1 -1
  56. package/dist/models/create-refund-request-dto.js +1 -1
  57. package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
  58. package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
  59. package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
  60. package/dist/models/{create-refund-response-class.js → create-tenant-bank-account-response-class.js} +1 -1
  61. package/dist/models/deactivate-payment-reminder-request-dto.d.ts +1 -1
  62. package/dist/models/deactivate-payment-reminder-request-dto.js +1 -1
  63. package/dist/models/get-tenant-bank-account-response-class.d.ts +5 -5
  64. package/dist/models/get-tenant-bank-account-response-class.js +1 -1
  65. package/dist/models/index.d.ts +10 -10
  66. package/dist/models/index.js +10 -10
  67. package/dist/models/inline-response200.d.ts +1 -1
  68. package/dist/models/inline-response200.js +1 -1
  69. package/dist/models/inline-response503.d.ts +1 -1
  70. package/dist/models/inline-response503.js +1 -1
  71. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +1 -1
  72. package/dist/models/link-bank-transaction-request-dto-rest.js +1 -1
  73. package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
  74. package/dist/models/{get-bank-transactions-response-class.js → list-tenant-bank-account-response-class.js} +1 -1
  75. package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
  76. package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
  77. package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +23 -11
  78. package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
  79. package/dist/models/tenant-bank-account-class.d.ts +85 -0
  80. package/dist/models/tenant-bank-account-class.js +15 -0
  81. package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +2 -2
  82. package/dist/models/unlink-bank-transaction-request-dto-rest.js +1 -1
  83. package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
  84. package/dist/models/update-bank-account-request-dto-rest.js +15 -0
  85. package/dist/models/update-bank-account-request-dto.d.ts +36 -0
  86. package/dist/models/update-bank-account-request-dto.js +15 -0
  87. package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
  88. package/dist/models/update-tenant-bank-account-response-class.js +15 -0
  89. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +1 -1
  90. package/dist/models/update-tenant-bank-account-rest-request-dto.js +1 -1
  91. package/dist/models/validate-pspconfig-request-dto.d.ts +1 -1
  92. package/dist/models/validate-pspconfig-request-dto.js +1 -1
  93. package/index.ts +1 -1
  94. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +31 -33
  95. package/models/create-bank-account-request-dto.ts +48 -0
  96. package/models/create-payment-reminder-request-dto.ts +1 -1
  97. package/models/create-payment-request-dto.ts +3 -3
  98. package/models/create-refund-request-dto.ts +1 -1
  99. package/models/create-tenant-bank-account-request-dto.ts +1 -1
  100. package/models/create-tenant-bank-account-response-class.ts +31 -0
  101. package/models/deactivate-payment-reminder-request-dto.ts +1 -1
  102. package/models/get-tenant-bank-account-response-class.ts +5 -5
  103. package/models/index.ts +10 -10
  104. package/models/inline-response200.ts +1 -1
  105. package/models/inline-response503.ts +1 -1
  106. package/models/link-bank-transaction-request-dto-rest.ts +1 -1
  107. package/models/list-tenant-bank-account-response-class.ts +37 -0
  108. package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
  109. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +23 -11
  110. package/models/tenant-bank-account-class.ts +91 -0
  111. package/models/unlink-bank-transaction-request-dto-rest.ts +2 -2
  112. package/models/update-bank-account-request-dto-rest.ts +36 -0
  113. package/models/update-bank-account-request-dto.ts +42 -0
  114. package/models/update-tenant-bank-account-response-class.ts +31 -0
  115. package/models/update-tenant-bank-account-rest-request-dto.ts +1 -1
  116. package/models/validate-pspconfig-request-dto.ts +1 -1
  117. package/package.json +1 -1
  118. package/dist/api/default-api.d.ts +0 -66
  119. package/dist/models/create-refund-response-class.d.ts +0 -25
  120. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  121. package/dist/models/get-refund-response-class.d.ts +0 -25
  122. package/dist/models/get-request-dto.d.ts +0 -30
  123. package/dist/models/get-request-dto.js +0 -15
  124. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  125. package/dist/models/list-bank-transactions-response-class.js +0 -15
  126. package/dist/models/list-refunds-response-class.d.ts +0 -31
  127. package/dist/models/list-refunds-response-class.js +0 -15
  128. package/dist/models/refund-class.d.ts +0 -104
  129. package/dist/models/refund-class.js +0 -28
  130. package/dist/models/tenant-bank-account-response-class.js +0 -15
  131. package/dist/models/transaction-class.d.ts +0 -54
  132. package/dist/models/transaction-class.js +0 -15
  133. package/models/create-refund-response-class.ts +0 -31
  134. package/models/get-bank-transactions-response-class.ts +0 -31
  135. package/models/get-refund-response-class.ts +0 -31
  136. package/models/get-request-dto.ts +0 -36
  137. package/models/list-bank-transactions-response-class.ts +0 -37
  138. package/models/list-refunds-response-class.ts +0 -37
  139. package/models/refund-class.ts +0 -114
  140. package/models/transaction-class.ts +0 -60
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
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
4
  *
5
5
  * The version of the OpenAPI document: 1.0
6
6
  * Contact: kontakt@emil.de
@@ -12,9 +12,7 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
- import { GetBankTransactionsResponseClass } from '../models';
16
15
  import { LinkBankTransactionRequestDtoRest } from '../models';
17
- import { ListBankTransactionsResponseClass } from '../models';
18
16
  import { UnlinkBankTransactionRequestDtoRest } from '../models';
19
17
  /**
20
18
  * BankTransactionApi - axios parameter creator
@@ -22,27 +20,27 @@ import { UnlinkBankTransactionRequestDtoRest } from '../models';
22
20
  */
23
21
  export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
24
22
  /**
25
- * 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.
26
- * @summary Retrieve the Bank Transaction
23
+ * 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.
24
+ * @summary Retrieve the bank transaction
27
25
  * @param {string} code
28
26
  * @param {string} [authorization] Bearer Token
29
- * @param {string} [expand] Expand the response with additional entities
27
+ * @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>
30
28
  * @param {*} [options] Override http request option.
31
29
  * @throws {RequiredError}
32
30
  */
33
31
  getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
32
  /**
35
- * Import bank transactions from a swift MT940 file
33
+ * This will import bank transactions from a swift MT940 file
36
34
  * @summary Create the bank transactions
35
+ * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.&lt;br/&gt; Allowed Content Types: text/plain, application/octet-stream
37
36
  * @param {string} [authorization] Bearer Token
38
- * @param {any} [file]
39
37
  * @param {*} [options] Override http request option.
40
38
  * @throws {RequiredError}
41
39
  */
42
- importBankTransactions: (authorization?: string, file?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
40
+ importBankTransactions: (file: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
41
  /**
44
42
  * Links a bank transaction with an invoice
45
- * @summary Link Bank Transaction
43
+ * @summary Link bank transaction
46
44
  * @param {string} code Code of the bank transaction to link
47
45
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
48
46
  * @param {string} [authorization] Bearer Token
@@ -51,23 +49,21 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
51
49
  */
52
50
  linkBankTransaction: (code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
51
  /**
54
- * 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.
52
+ * 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.
55
53
  * @summary List bank transactions
56
54
  * @param {string} [authorization] Bearer Token
57
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
58
- * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
59
- * @param {'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked'} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
60
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
61
- * @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.
62
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
63
- * @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.
55
+ * @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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
56
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
57
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, createdAt, amount&lt;/i&gt;
58
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, amount, transactionDate, entryDate&lt;/i&gt;
59
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankAccount, transaction&lt;i&gt;
64
60
  * @param {*} [options] Override http request option.
65
61
  * @throws {RequiredError}
66
62
  */
67
- listBankTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked', search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
+ listBankTransactions: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
64
  /**
69
65
  * Unlinks an already linked bank transaction
70
- * @summary Unlink Bank Transaction
66
+ * @summary Unlink bank transaction
71
67
  * @param {string} code Code of the bank transaction to unlink
72
68
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
73
69
  * @param {string} [authorization] Bearer Token
@@ -82,59 +78,57 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
82
78
  */
83
79
  export declare const BankTransactionApiFp: (configuration?: Configuration) => {
84
80
  /**
85
- * 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.
86
- * @summary Retrieve the Bank Transaction
81
+ * 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.
82
+ * @summary Retrieve the bank transaction
87
83
  * @param {string} code
88
84
  * @param {string} [authorization] Bearer Token
89
- * @param {string} [expand] Expand the response with additional entities
85
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankAccount, transaction&lt;i&gt;
90
86
  * @param {*} [options] Override http request option.
91
87
  * @throws {RequiredError}
92
88
  */
93
- getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
89
+ getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
94
90
  /**
95
- * Import bank transactions from a swift MT940 file
91
+ * This will import bank transactions from a swift MT940 file
96
92
  * @summary Create the bank transactions
93
+ * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.&lt;br/&gt; Allowed Content Types: text/plain, application/octet-stream
97
94
  * @param {string} [authorization] Bearer Token
98
- * @param {any} [file]
99
95
  * @param {*} [options] Override http request option.
100
96
  * @throws {RequiredError}
101
97
  */
102
- importBankTransactions(authorization?: string, file?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>>;
98
+ importBankTransactions(file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
103
99
  /**
104
100
  * Links a bank transaction with an invoice
105
- * @summary Link Bank Transaction
101
+ * @summary Link bank transaction
106
102
  * @param {string} code Code of the bank transaction to link
107
103
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
108
104
  * @param {string} [authorization] Bearer Token
109
105
  * @param {*} [options] Override http request option.
110
106
  * @throws {RequiredError}
111
107
  */
112
- linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
108
+ linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
113
109
  /**
114
- * 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.
110
+ * 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.
115
111
  * @summary List bank transactions
116
112
  * @param {string} [authorization] Bearer Token
117
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
118
- * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
119
- * @param {'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked'} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
120
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
121
- * @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.
122
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
123
- * @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.
113
+ * @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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
114
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
115
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, createdAt, amount&lt;/i&gt;
116
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, amount, transactionDate, entryDate&lt;/i&gt;
117
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankAccount, transaction&lt;i&gt;
124
118
  * @param {*} [options] Override http request option.
125
119
  * @throws {RequiredError}
126
120
  */
127
- listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked', search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
121
+ listBankTransactions(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
128
122
  /**
129
123
  * Unlinks an already linked bank transaction
130
- * @summary Unlink Bank Transaction
124
+ * @summary Unlink bank transaction
131
125
  * @param {string} code Code of the bank transaction to unlink
132
126
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
133
127
  * @param {string} [authorization] Bearer Token
134
128
  * @param {*} [options] Override http request option.
135
129
  * @throws {RequiredError}
136
130
  */
137
- unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
131
+ unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
138
132
  };
139
133
  /**
140
134
  * BankTransactionApi - factory interface
@@ -142,59 +136,57 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
142
136
  */
143
137
  export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
144
138
  /**
145
- * 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.
146
- * @summary Retrieve the Bank Transaction
139
+ * 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.
140
+ * @summary Retrieve the bank transaction
147
141
  * @param {string} code
148
142
  * @param {string} [authorization] Bearer Token
149
- * @param {string} [expand] Expand the response with additional entities
143
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankAccount, transaction&lt;i&gt;
150
144
  * @param {*} [options] Override http request option.
151
145
  * @throws {RequiredError}
152
146
  */
153
- getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
147
+ getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
154
148
  /**
155
- * Import bank transactions from a swift MT940 file
149
+ * This will import bank transactions from a swift MT940 file
156
150
  * @summary Create the bank transactions
151
+ * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.&lt;br/&gt; Allowed Content Types: text/plain, application/octet-stream
157
152
  * @param {string} [authorization] Bearer Token
158
- * @param {any} [file]
159
153
  * @param {*} [options] Override http request option.
160
154
  * @throws {RequiredError}
161
155
  */
162
- importBankTransactions(authorization?: string, file?: any, options?: any): AxiosPromise<ListBankTransactionsResponseClass>;
156
+ importBankTransactions(file: any, authorization?: string, options?: any): AxiosPromise<void>;
163
157
  /**
164
158
  * Links a bank transaction with an invoice
165
- * @summary Link Bank Transaction
159
+ * @summary Link bank transaction
166
160
  * @param {string} code Code of the bank transaction to link
167
161
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
168
162
  * @param {string} [authorization] Bearer Token
169
163
  * @param {*} [options] Override http request option.
170
164
  * @throws {RequiredError}
171
165
  */
172
- linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
166
+ linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
173
167
  /**
174
- * 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.
168
+ * 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.
175
169
  * @summary List bank transactions
176
170
  * @param {string} [authorization] Bearer Token
177
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
178
- * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
179
- * @param {'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked'} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
180
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
181
- * @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.
182
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
183
- * @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.
171
+ * @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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
172
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
173
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, createdAt, amount&lt;/i&gt;
174
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, amount, transactionDate, entryDate&lt;/i&gt;
175
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankAccount, transaction&lt;i&gt;
184
176
  * @param {*} [options] Override http request option.
185
177
  * @throws {RequiredError}
186
178
  */
187
- listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked', search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options?: any): AxiosPromise<void>;
179
+ listBankTransactions(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<void>;
188
180
  /**
189
181
  * Unlinks an already linked bank transaction
190
- * @summary Unlink Bank Transaction
182
+ * @summary Unlink bank transaction
191
183
  * @param {string} code Code of the bank transaction to unlink
192
184
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
193
185
  * @param {string} [authorization] Bearer Token
194
186
  * @param {*} [options] Override http request option.
195
187
  * @throws {RequiredError}
196
188
  */
197
- unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
189
+ unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
198
190
  };
199
191
  /**
200
192
  * Request parameters for getBankTransaction operation in BankTransactionApi.
@@ -215,7 +207,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
215
207
  */
216
208
  readonly authorization?: string;
217
209
  /**
218
- * Expand the response with additional entities
210
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankAccount, transaction&lt;i&gt;
219
211
  * @type {string}
220
212
  * @memberof BankTransactionApiGetBankTransaction
221
213
  */
@@ -228,17 +220,17 @@ export interface BankTransactionApiGetBankTransactionRequest {
228
220
  */
229
221
  export interface BankTransactionApiImportBankTransactionsRequest {
230
222
  /**
231
- * Bearer Token
232
- * @type {string}
223
+ * Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.&lt;br/&gt; Allowed Content Types: text/plain, application/octet-stream
224
+ * @type {any}
233
225
  * @memberof BankTransactionApiImportBankTransactions
234
226
  */
235
- readonly authorization?: string;
227
+ readonly file: any;
236
228
  /**
237
- *
238
- * @type {any}
229
+ * Bearer Token
230
+ * @type {string}
239
231
  * @memberof BankTransactionApiImportBankTransactions
240
232
  */
241
- readonly file?: any;
233
+ readonly authorization?: string;
242
234
  }
243
235
  /**
244
236
  * Request parameters for linkBankTransaction operation in BankTransactionApi.
@@ -278,47 +270,35 @@ export interface BankTransactionApiListBankTransactionsRequest {
278
270
  */
279
271
  readonly authorization?: string;
280
272
  /**
281
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
282
- * @type {any}
283
- * @memberof BankTransactionApiListBankTransactions
284
- */
285
- readonly pageSize?: any;
286
- /**
287
- * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
288
- * @type {any}
289
- * @memberof BankTransactionApiListBankTransactions
290
- */
291
- readonly pageToken?: any;
292
- /**
293
- * 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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
294
- * @type {'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked'}
273
+ * 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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
274
+ * @type {string}
295
275
  * @memberof BankTransactionApiListBankTransactions
296
276
  */
297
- readonly filter?: 'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked';
277
+ readonly filter?: string;
298
278
  /**
299
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
300
- * @type {any}
279
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
280
+ * @type {string}
301
281
  * @memberof BankTransactionApiListBankTransactions
302
282
  */
303
- readonly search?: any;
283
+ readonly filters?: string;
304
284
  /**
305
- * 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.
306
- * @type {any}
285
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, createdAt, amount&lt;/i&gt;
286
+ * @type {string}
307
287
  * @memberof BankTransactionApiListBankTransactions
308
288
  */
309
- readonly order?: any;
289
+ readonly search?: string;
310
290
  /**
311
- * Expand the response with additional entities
312
- * @type {'bankAccount' | 'transaction'}
291
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, amount, transactionDate, entryDate&lt;/i&gt;
292
+ * @type {string}
313
293
  * @memberof BankTransactionApiListBankTransactions
314
294
  */
315
- readonly expand?: 'bankAccount' | 'transaction';
295
+ readonly order?: string;
316
296
  /**
317
- * 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.
318
- * @type {any}
297
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: bankAccount, transaction&lt;i&gt;
298
+ * @type {string}
319
299
  * @memberof BankTransactionApiListBankTransactions
320
300
  */
321
- readonly filters?: any;
301
+ readonly expand?: string;
322
302
  }
323
303
  /**
324
304
  * Request parameters for unlinkBankTransaction operation in BankTransactionApi.
@@ -353,34 +333,34 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
353
333
  */
354
334
  export declare class BankTransactionApi extends BaseAPI {
355
335
  /**
356
- * 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.
357
- * @summary Retrieve the Bank Transaction
336
+ * 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.
337
+ * @summary Retrieve the bank transaction
358
338
  * @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
359
339
  * @param {*} [options] Override http request option.
360
340
  * @throws {RequiredError}
361
341
  * @memberof BankTransactionApi
362
342
  */
363
- getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
343
+ getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
364
344
  /**
365
- * Import bank transactions from a swift MT940 file
345
+ * This will import bank transactions from a swift MT940 file
366
346
  * @summary Create the bank transactions
367
347
  * @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
368
348
  * @param {*} [options] Override http request option.
369
349
  * @throws {RequiredError}
370
350
  * @memberof BankTransactionApi
371
351
  */
372
- importBankTransactions(requestParameters?: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any>>;
352
+ importBankTransactions(requestParameters: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
373
353
  /**
374
354
  * Links a bank transaction with an invoice
375
- * @summary Link Bank Transaction
355
+ * @summary Link bank transaction
376
356
  * @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
377
357
  * @param {*} [options] Override http request option.
378
358
  * @throws {RequiredError}
379
359
  * @memberof BankTransactionApi
380
360
  */
381
- linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
361
+ linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
382
362
  /**
383
- * 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.
363
+ * 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.
384
364
  * @summary List bank transactions
385
365
  * @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
386
366
  * @param {*} [options] Override http request option.
@@ -390,11 +370,11 @@ export declare class BankTransactionApi extends BaseAPI {
390
370
  listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
391
371
  /**
392
372
  * Unlinks an already linked bank transaction
393
- * @summary Unlink Bank Transaction
373
+ * @summary Unlink bank transaction
394
374
  * @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
395
375
  * @param {*} [options] Override http request option.
396
376
  * @throws {RequiredError}
397
377
  * @memberof BankTransactionApi
398
378
  */
399
- unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
379
+ unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
400
380
  }