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

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 (93) 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/payment-setup-api.ts +16 -8
  9. package/api/payments-api.ts +52 -70
  10. package/api/refunds-api.ts +76 -88
  11. package/api/tenant-bank-account-api.ts +79 -63
  12. package/api/webhooks-api.ts +16 -12
  13. package/api.ts +2 -2
  14. package/base.ts +15 -7
  15. package/dist/api/bank-accounts-api.d.ts +37 -39
  16. package/dist/api/bank-accounts-api.js +18 -18
  17. package/dist/api/bank-transaction-api.d.ts +77 -79
  18. package/dist/api/bank-transaction-api.js +45 -45
  19. package/dist/api/health-check-api.d.ts +70 -0
  20. package/dist/api/{default-api.js → health-check-api.js} +30 -26
  21. package/dist/api/payment-methods-api.d.ts +49 -58
  22. package/dist/api/payment-methods-api.js +32 -42
  23. package/dist/api/payment-reminders-api.d.ts +55 -46
  24. package/dist/api/payment-reminders-api.js +40 -34
  25. package/dist/api/payment-setup-api.d.ts +16 -8
  26. package/dist/api/payment-setup-api.js +16 -8
  27. package/dist/api/payments-api.d.ts +49 -58
  28. package/dist/api/payments-api.js +32 -42
  29. package/dist/api/refunds-api.d.ts +76 -76
  30. package/dist/api/refunds-api.js +51 -49
  31. package/dist/api/tenant-bank-account-api.d.ts +71 -61
  32. package/dist/api/tenant-bank-account-api.js +51 -45
  33. package/dist/api/webhooks-api.d.ts +16 -12
  34. package/dist/api/webhooks-api.js +14 -10
  35. package/dist/api.d.ts +1 -1
  36. package/dist/api.js +1 -1
  37. package/dist/base.d.ts +3 -1
  38. package/dist/base.js +27 -20
  39. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +20 -34
  40. package/dist/models/create-tenant-bank-account-response-class.d.ts +4 -4
  41. package/dist/models/get-tenant-bank-account-response-class.d.ts +4 -4
  42. package/dist/models/index.d.ts +4 -14
  43. package/dist/models/index.js +4 -14
  44. package/dist/models/list-tenant-bank-account-response-class.d.ts +5 -5
  45. package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +10 -10
  46. package/dist/models/tenant-bank-account-class.d.ts +73 -0
  47. package/dist/models/{get-bank-account-response-class.d.ts → update-tenant-bank-account-response-class.d.ts} +7 -7
  48. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +20 -34
  49. package/models/create-tenant-bank-account-response-class.ts +4 -4
  50. package/models/get-tenant-bank-account-response-class.ts +4 -4
  51. package/models/index.ts +4 -14
  52. package/models/list-tenant-bank-account-response-class.ts +5 -5
  53. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +10 -10
  54. package/models/tenant-bank-account-class.ts +79 -0
  55. package/models/{create-refund-response-class.ts → update-tenant-bank-account-response-class.ts} +7 -7
  56. package/package.json +1 -1
  57. package/dist/api/default-api.d.ts +0 -66
  58. package/dist/models/bank-account-class.d.ts +0 -73
  59. package/dist/models/create-refund-response-class.d.ts +0 -25
  60. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  61. package/dist/models/get-bank-transactions-response-class.js +0 -15
  62. package/dist/models/get-refund-response-class.d.ts +0 -25
  63. package/dist/models/get-refund-response-class.js +0 -15
  64. package/dist/models/get-request-dto.d.ts +0 -30
  65. package/dist/models/get-request-dto.js +0 -15
  66. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  67. package/dist/models/list-bank-transactions-response-class.js +0 -15
  68. package/dist/models/list-refunds-response-class.d.ts +0 -31
  69. package/dist/models/list-refunds-response-class.js +0 -15
  70. package/dist/models/primary-bank-account-response-class.d.ts +0 -42
  71. package/dist/models/primary-bank-account-response-class.js +0 -15
  72. package/dist/models/refund-class.d.ts +0 -105
  73. package/dist/models/refund-class.js +0 -29
  74. package/dist/models/tenant-bank-account-response-class.js +0 -15
  75. package/dist/models/transaction-class.d.ts +0 -54
  76. package/dist/models/transaction-class.js +0 -15
  77. package/dist/models/update-bank-account-response-class.d.ts +0 -25
  78. package/dist/models/update-bank-account-response-class.js +0 -15
  79. package/models/bank-account-class.ts +0 -79
  80. package/models/get-bank-account-response-class.ts +0 -31
  81. package/models/get-bank-transactions-response-class.ts +0 -31
  82. package/models/get-refund-response-class.ts +0 -31
  83. package/models/get-request-dto.ts +0 -36
  84. package/models/list-bank-transactions-response-class.ts +0 -37
  85. package/models/list-refunds-response-class.ts +0 -37
  86. package/models/primary-bank-account-response-class.ts +0 -48
  87. package/models/refund-class.ts +0 -115
  88. package/models/transaction-class.ts +0 -60
  89. package/models/update-bank-account-response-class.ts +0 -31
  90. /package/dist/models/{bank-account-class.js → bank-transaction-class-without-expand-properties.js} +0 -0
  91. /package/dist/models/{bank-transaction-response-class.js → tenant-bank-account-class-without-expand-properties.js} +0 -0
  92. /package/dist/models/{create-refund-response-class.js → tenant-bank-account-class.js} +0 -0
  93. /package/dist/models/{get-bank-account-response-class.js → update-tenant-bank-account-response-class.js} +0 -0
@@ -21,12 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
- import { GetBankTransactionsResponseClass } from '../models';
25
- // @ts-ignore
26
24
  import { LinkBankTransactionRequestDtoRest } from '../models';
27
25
  // @ts-ignore
28
- import { ListBankTransactionsResponseClass } from '../models';
29
- // @ts-ignore
30
26
  import { UnlinkBankTransactionRequestDtoRest } from '../models';
31
27
  /**
32
28
  * BankTransactionApi - axios parameter creator
@@ -35,11 +31,11 @@ import { UnlinkBankTransactionRequestDtoRest } from '../models';
35
31
  export const BankTransactionApiAxiosParamCreator = function (configuration?: Configuration) {
36
32
  return {
37
33
  /**
38
- * 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.
39
- * @summary Retrieve the Bank Transaction
40
- * @param {string} code
34
+ * 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.
35
+ * @summary Retrieve the bank transaction
36
+ * @param {string} code Unique identifier for the object.
41
37
  * @param {string} [authorization] Bearer Token
42
- * @param {string} [expand] Expand the response with additional entities
38
+ * @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>
43
39
  * @param {*} [options] Override http request option.
44
40
  * @throws {RequiredError}
45
41
  */
@@ -85,7 +81,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
85
81
  };
86
82
  },
87
83
  /**
88
- * Import bank transactions from a swift MT940 file
84
+ * This will import bank transactions from a swift MT940 file
89
85
  * @summary Create the bank transactions
90
86
  * @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
91
87
  * @param {string} [authorization] Bearer Token
@@ -138,7 +134,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
138
134
  },
139
135
  /**
140
136
  * Links a bank transaction with an invoice
141
- * @summary Link Bank Transaction
137
+ * @summary Link bank transaction
142
138
  * @param {string} code Code of the bank transaction to link
143
139
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
144
140
  * @param {string} [authorization] Bearer Token
@@ -188,20 +184,20 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
188
184
  };
189
185
  },
190
186
  /**
191
- * 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.
187
+ * 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.
192
188
  * @summary List bank transactions
193
189
  * @param {string} [authorization] Bearer Token
194
190
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
195
191
  * @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.
196
- * @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>
197
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
198
- * @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.
199
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
200
- * @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.
192
+ * @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>
193
+ * @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>
194
+ * @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>
195
+ * @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>
196
+ * @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>
201
197
  * @param {*} [options] Override http request option.
202
198
  * @throws {RequiredError}
203
199
  */
204
- listBankTransactions: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
200
+ listBankTransactions: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
205
201
  const localVarPath = `/paymentservice/v1/tenant/bank-transactions`;
206
202
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
207
203
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -265,7 +261,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
265
261
  },
266
262
  /**
267
263
  * Unlinks an already linked bank transaction
268
- * @summary Unlink Bank Transaction
264
+ * @summary Unlink bank transaction
269
265
  * @param {string} code Code of the bank transaction to unlink
270
266
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
271
267
  * @param {string} [authorization] Bearer Token
@@ -325,71 +321,71 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
325
321
  const localVarAxiosParamCreator = BankTransactionApiAxiosParamCreator(configuration)
326
322
  return {
327
323
  /**
328
- * 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.
329
- * @summary Retrieve the Bank Transaction
330
- * @param {string} code
324
+ * 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.
325
+ * @summary Retrieve the bank transaction
326
+ * @param {string} code Unique identifier for the object.
331
327
  * @param {string} [authorization] Bearer Token
332
- * @param {string} [expand] Expand the response with additional entities
328
+ * @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;
333
329
  * @param {*} [options] Override http request option.
334
330
  * @throws {RequiredError}
335
331
  */
336
- async getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>> {
332
+ async getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
337
333
  const localVarAxiosArgs = await localVarAxiosParamCreator.getBankTransaction(code, authorization, expand, options);
338
334
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
339
335
  },
340
336
  /**
341
- * Import bank transactions from a swift MT940 file
337
+ * This will import bank transactions from a swift MT940 file
342
338
  * @summary Create the bank transactions
343
339
  * @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
344
340
  * @param {string} [authorization] Bearer Token
345
341
  * @param {*} [options] Override http request option.
346
342
  * @throws {RequiredError}
347
343
  */
348
- async importBankTransactions(file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>> {
344
+ async importBankTransactions(file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
349
345
  const localVarAxiosArgs = await localVarAxiosParamCreator.importBankTransactions(file, authorization, options);
350
346
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
351
347
  },
352
348
  /**
353
349
  * Links a bank transaction with an invoice
354
- * @summary Link Bank Transaction
350
+ * @summary Link bank transaction
355
351
  * @param {string} code Code of the bank transaction to link
356
352
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
357
353
  * @param {string} [authorization] Bearer Token
358
354
  * @param {*} [options] Override http request option.
359
355
  * @throws {RequiredError}
360
356
  */
361
- async linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>> {
357
+ async linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
362
358
  const localVarAxiosArgs = await localVarAxiosParamCreator.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options);
363
359
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
364
360
  },
365
361
  /**
366
- * 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.
362
+ * 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.
367
363
  * @summary List bank transactions
368
364
  * @param {string} [authorization] Bearer Token
369
365
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
370
366
  * @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.
371
- * @param {any} [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;
372
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
373
- * @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.
374
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
375
- * @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.
367
+ * @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;
368
+ * @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;
369
+ * @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;
370
+ * @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;
371
+ * @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;
376
372
  * @param {*} [options] Override http request option.
377
373
  * @throws {RequiredError}
378
374
  */
379
- async listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
375
+ async listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
380
376
  const localVarAxiosArgs = await localVarAxiosParamCreator.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
381
377
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
382
378
  },
383
379
  /**
384
380
  * Unlinks an already linked bank transaction
385
- * @summary Unlink Bank Transaction
381
+ * @summary Unlink bank transaction
386
382
  * @param {string} code Code of the bank transaction to unlink
387
383
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
388
384
  * @param {string} [authorization] Bearer Token
389
385
  * @param {*} [options] Override http request option.
390
386
  * @throws {RequiredError}
391
387
  */
392
- async unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>> {
388
+ async unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
393
389
  const localVarAxiosArgs = await localVarAxiosParamCreator.unlinkBankTransaction(code, unlinkBankTransactionRequestDtoRest, authorization, options);
394
390
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
395
391
  },
@@ -404,67 +400,67 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
404
400
  const localVarFp = BankTransactionApiFp(configuration)
405
401
  return {
406
402
  /**
407
- * 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.
408
- * @summary Retrieve the Bank Transaction
409
- * @param {string} code
403
+ * 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.
404
+ * @summary Retrieve the bank transaction
405
+ * @param {string} code Unique identifier for the object.
410
406
  * @param {string} [authorization] Bearer Token
411
- * @param {string} [expand] Expand the response with additional entities
407
+ * @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;
412
408
  * @param {*} [options] Override http request option.
413
409
  * @throws {RequiredError}
414
410
  */
415
- getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass> {
411
+ getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
416
412
  return localVarFp.getBankTransaction(code, authorization, expand, options).then((request) => request(axios, basePath));
417
413
  },
418
414
  /**
419
- * Import bank transactions from a swift MT940 file
415
+ * This will import bank transactions from a swift MT940 file
420
416
  * @summary Create the bank transactions
421
417
  * @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
422
418
  * @param {string} [authorization] Bearer Token
423
419
  * @param {*} [options] Override http request option.
424
420
  * @throws {RequiredError}
425
421
  */
426
- importBankTransactions(file: any, authorization?: string, options?: any): AxiosPromise<ListBankTransactionsResponseClass> {
422
+ importBankTransactions(file: any, authorization?: string, options?: any): AxiosPromise<void> {
427
423
  return localVarFp.importBankTransactions(file, authorization, options).then((request) => request(axios, basePath));
428
424
  },
429
425
  /**
430
426
  * Links a bank transaction with an invoice
431
- * @summary Link Bank Transaction
427
+ * @summary Link bank transaction
432
428
  * @param {string} code Code of the bank transaction to link
433
429
  * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
434
430
  * @param {string} [authorization] Bearer Token
435
431
  * @param {*} [options] Override http request option.
436
432
  * @throws {RequiredError}
437
433
  */
438
- linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass> {
434
+ linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void> {
439
435
  return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
440
436
  },
441
437
  /**
442
- * 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.
438
+ * 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.
443
439
  * @summary List bank transactions
444
440
  * @param {string} [authorization] Bearer Token
445
441
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
446
442
  * @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.
447
- * @param {any} [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;
448
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
449
- * @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.
450
- * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
451
- * @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.
443
+ * @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;
444
+ * @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;
445
+ * @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;
446
+ * @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;
447
+ * @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;
452
448
  * @param {*} [options] Override http request option.
453
449
  * @throws {RequiredError}
454
450
  */
455
- listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options?: any): AxiosPromise<void> {
451
+ listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
456
452
  return localVarFp.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
457
453
  },
458
454
  /**
459
455
  * Unlinks an already linked bank transaction
460
- * @summary Unlink Bank Transaction
456
+ * @summary Unlink bank transaction
461
457
  * @param {string} code Code of the bank transaction to unlink
462
458
  * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
463
459
  * @param {string} [authorization] Bearer Token
464
460
  * @param {*} [options] Override http request option.
465
461
  * @throws {RequiredError}
466
462
  */
467
- unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass> {
463
+ unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void> {
468
464
  return localVarFp.unlinkBankTransaction(code, unlinkBankTransactionRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
469
465
  },
470
466
  };
@@ -477,7 +473,7 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
477
473
  */
478
474
  export interface BankTransactionApiGetBankTransactionRequest {
479
475
  /**
480
- *
476
+ * Unique identifier for the object.
481
477
  * @type {string}
482
478
  * @memberof BankTransactionApiGetBankTransaction
483
479
  */
@@ -491,7 +487,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
491
487
  readonly authorization?: string
492
488
 
493
489
  /**
494
- * Expand the response with additional entities
490
+ * 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;
495
491
  * @type {string}
496
492
  * @memberof BankTransactionApiGetBankTransaction
497
493
  */
@@ -575,39 +571,39 @@ export interface BankTransactionApiListBankTransactionsRequest {
575
571
  readonly pageToken?: any
576
572
 
577
573
  /**
578
- * 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;
579
- * @type {any}
574
+ * 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;
575
+ * @type {string}
580
576
  * @memberof BankTransactionApiListBankTransactions
581
577
  */
582
- readonly filter?: any
578
+ readonly filter?: string
583
579
 
584
580
  /**
585
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
586
- * @type {any}
581
+ * 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;
582
+ * @type {string}
587
583
  * @memberof BankTransactionApiListBankTransactions
588
584
  */
589
- readonly search?: any
585
+ readonly search?: string
590
586
 
591
587
  /**
592
- * 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.
593
- * @type {any}
588
+ * 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;
589
+ * @type {string}
594
590
  * @memberof BankTransactionApiListBankTransactions
595
591
  */
596
- readonly order?: any
592
+ readonly order?: string
597
593
 
598
594
  /**
599
- * Expand the response with additional entities
600
- * @type {'bankAccount' | 'transaction'}
595
+ * 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;
596
+ * @type {string}
601
597
  * @memberof BankTransactionApiListBankTransactions
602
598
  */
603
- readonly expand?: 'bankAccount' | 'transaction'
599
+ readonly expand?: string
604
600
 
605
601
  /**
606
- * 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.
607
- * @type {any}
602
+ * 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;
603
+ * @type {string}
608
604
  * @memberof BankTransactionApiListBankTransactions
609
605
  */
610
- readonly filters?: any
606
+ readonly filters?: string
611
607
  }
612
608
 
613
609
  /**
@@ -646,8 +642,8 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
646
642
  */
647
643
  export class BankTransactionApi extends BaseAPI {
648
644
  /**
649
- * 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.
650
- * @summary Retrieve the Bank Transaction
645
+ * 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.
646
+ * @summary Retrieve the bank transaction
651
647
  * @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
652
648
  * @param {*} [options] Override http request option.
653
649
  * @throws {RequiredError}
@@ -658,7 +654,7 @@ export class BankTransactionApi extends BaseAPI {
658
654
  }
659
655
 
660
656
  /**
661
- * Import bank transactions from a swift MT940 file
657
+ * This will import bank transactions from a swift MT940 file
662
658
  * @summary Create the bank transactions
663
659
  * @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
664
660
  * @param {*} [options] Override http request option.
@@ -671,7 +667,7 @@ export class BankTransactionApi extends BaseAPI {
671
667
 
672
668
  /**
673
669
  * Links a bank transaction with an invoice
674
- * @summary Link Bank Transaction
670
+ * @summary Link bank transaction
675
671
  * @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
676
672
  * @param {*} [options] Override http request option.
677
673
  * @throws {RequiredError}
@@ -682,7 +678,7 @@ export class BankTransactionApi extends BaseAPI {
682
678
  }
683
679
 
684
680
  /**
685
- * 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.
681
+ * 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.
686
682
  * @summary List bank transactions
687
683
  * @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
688
684
  * @param {*} [options] Override http request option.
@@ -695,7 +691,7 @@ export class BankTransactionApi extends BaseAPI {
695
691
 
696
692
  /**
697
693
  * Unlinks an already linked bank transaction
698
- * @summary Unlink Bank Transaction
694
+ * @summary Unlink bank transaction
699
695
  * @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
700
696
  * @param {*} [options] Override http request option.
701
697
  * @throws {RequiredError}
@@ -25,13 +25,14 @@ import { InlineResponse200 } from '../models';
25
25
  // @ts-ignore
26
26
  import { InlineResponse503 } from '../models';
27
27
  /**
28
- * DefaultApi - axios parameter creator
28
+ * HealthCheckApi - axios parameter creator
29
29
  * @export
30
30
  */
31
- export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
31
+ export const HealthCheckApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
34
- *
34
+ * 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.
35
+ * @summary Health Check
35
36
  * @param {*} [options] Override http request option.
36
37
  * @throws {RequiredError}
37
38
  */
@@ -65,14 +66,15 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
65
66
  };
66
67
 
67
68
  /**
68
- * DefaultApi - functional programming interface
69
+ * HealthCheckApi - functional programming interface
69
70
  * @export
70
71
  */
71
- export const DefaultApiFp = function(configuration?: Configuration) {
72
- const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
72
+ export const HealthCheckApiFp = function(configuration?: Configuration) {
73
+ const localVarAxiosParamCreator = HealthCheckApiAxiosParamCreator(configuration)
73
74
  return {
74
75
  /**
75
- *
76
+ * 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.
77
+ * @summary Health Check
76
78
  * @param {*} [options] Override http request option.
77
79
  * @throws {RequiredError}
78
80
  */
@@ -84,14 +86,15 @@ export const DefaultApiFp = function(configuration?: Configuration) {
84
86
  };
85
87
 
86
88
  /**
87
- * DefaultApi - factory interface
89
+ * HealthCheckApi - factory interface
88
90
  * @export
89
91
  */
90
- export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
91
- const localVarFp = DefaultApiFp(configuration)
92
+ export const HealthCheckApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
93
+ const localVarFp = HealthCheckApiFp(configuration)
92
94
  return {
93
95
  /**
94
- *
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
95
98
  * @param {*} [options] Override http request option.
96
99
  * @throws {RequiredError}
97
100
  */
@@ -102,19 +105,20 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
102
105
  };
103
106
 
104
107
  /**
105
- * DefaultApi - object-oriented interface
108
+ * HealthCheckApi - object-oriented interface
106
109
  * @export
107
- * @class DefaultApi
110
+ * @class HealthCheckApi
108
111
  * @extends {BaseAPI}
109
112
  */
110
- export class DefaultApi extends BaseAPI {
113
+ export class HealthCheckApi extends BaseAPI {
111
114
  /**
112
- *
115
+ * 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.
116
+ * @summary Health Check
113
117
  * @param {*} [options] Override http request option.
114
118
  * @throws {RequiredError}
115
- * @memberof DefaultApi
119
+ * @memberof HealthCheckApi
116
120
  */
117
121
  public check(options?: AxiosRequestConfig) {
118
- return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
122
+ return HealthCheckApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
119
123
  }
120
124
  }