@emilgroup/payment-sdk 1.22.1-beta.36 → 1.22.1-beta.38

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 (70) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/api/bank-orders-api.ts +8 -8
  4. package/api/exceeding-credits-api.ts +107 -0
  5. package/api/jobs-api.ts +165 -0
  6. package/api/payment-requests-api.ts +12 -12
  7. package/api.ts +2 -0
  8. package/dist/api/bank-orders-api.d.ts +8 -8
  9. package/dist/api/bank-orders-api.js +6 -6
  10. package/dist/api/exceeding-credits-api.d.ts +57 -0
  11. package/dist/api/exceeding-credits-api.js +93 -0
  12. package/dist/api/jobs-api.d.ts +97 -0
  13. package/dist/api/jobs-api.js +224 -0
  14. package/dist/api/payment-requests-api.d.ts +12 -12
  15. package/dist/api/payment-requests-api.js +9 -9
  16. package/dist/api.d.ts +1 -0
  17. package/dist/api.js +1 -0
  18. package/dist/models/create-bank-order-request-dto.d.ts +2 -2
  19. package/dist/models/create-exceeding-credit-request-dto.d.ts +48 -0
  20. package/dist/models/create-exceeding-credit-request-dto.js +15 -0
  21. package/dist/models/create-exceeding-credit-response-class.d.ts +25 -0
  22. package/dist/models/create-exceeding-credit-response-class.js +15 -0
  23. package/dist/models/create-payment-request-request-dto.d.ts +12 -0
  24. package/dist/models/credit-allocation-class.d.ts +6 -0
  25. package/dist/models/credit-allocation-entity.d.ts +6 -0
  26. package/dist/models/index.d.ts +5 -0
  27. package/dist/models/index.js +5 -0
  28. package/dist/models/list-billing-addresses-response-class.d.ts +9 -9
  29. package/dist/models/list-exceeding-credits-response-class.d.ts +6 -18
  30. package/dist/models/list-payment-receipts-response-class.d.ts +9 -9
  31. package/dist/models/list-payment-requests-response-class.d.ts +6 -18
  32. package/dist/models/list-payout-methods-response-class.d.ts +9 -9
  33. package/dist/models/list-refunds-response-class.d.ts +6 -18
  34. package/dist/models/payment-class-without-expand-properties.d.ts +1 -1
  35. package/dist/models/payment-class.d.ts +1 -1
  36. package/dist/models/payment-entity.d.ts +1 -1
  37. package/dist/models/payment-request-class.d.ts +30 -0
  38. package/dist/models/run-job-grpc-request-dto.d.ts +63 -0
  39. package/dist/models/run-job-grpc-request-dto.js +23 -0
  40. package/dist/models/run-job-request-dto.d.ts +63 -0
  41. package/dist/models/run-job-request-dto.js +23 -0
  42. package/dist/models/run-job-response-class.d.ts +24 -0
  43. package/dist/models/run-job-response-class.js +15 -0
  44. package/dist/models/shared-transaction-class.d.ts +6 -0
  45. package/dist/models/transaction-entity.d.ts +6 -0
  46. package/dist/models/update-bank-order-request-dto.d.ts +2 -2
  47. package/models/create-bank-order-request-dto.ts +2 -2
  48. package/models/create-exceeding-credit-request-dto.ts +54 -0
  49. package/models/create-exceeding-credit-response-class.ts +31 -0
  50. package/models/create-payment-request-request-dto.ts +12 -0
  51. package/models/credit-allocation-class.ts +6 -0
  52. package/models/credit-allocation-entity.ts +6 -0
  53. package/models/index.ts +5 -0
  54. package/models/list-billing-addresses-response-class.ts +9 -9
  55. package/models/list-exceeding-credits-response-class.ts +6 -18
  56. package/models/list-payment-receipts-response-class.ts +9 -9
  57. package/models/list-payment-requests-response-class.ts +6 -18
  58. package/models/list-payout-methods-response-class.ts +9 -9
  59. package/models/list-refunds-response-class.ts +6 -18
  60. package/models/payment-class-without-expand-properties.ts +1 -1
  61. package/models/payment-class.ts +1 -1
  62. package/models/payment-entity.ts +1 -1
  63. package/models/payment-request-class.ts +30 -0
  64. package/models/run-job-grpc-request-dto.ts +73 -0
  65. package/models/run-job-request-dto.ts +73 -0
  66. package/models/run-job-response-class.ts +30 -0
  67. package/models/shared-transaction-class.ts +6 -0
  68. package/models/transaction-entity.ts +6 -0
  69. package/models/update-bank-order-request-dto.ts +2 -2
  70. package/package.json +1 -1
@@ -11,6 +11,7 @@ api/credit-allocation-api.ts
11
11
  api/exceeding-credits-api.ts
12
12
  api/health-check-api.ts
13
13
  api/ibanvalidator-api.ts
14
+ api/jobs-api.ts
14
15
  api/payment-methods-api.ts
15
16
  api/payment-receipts-api.ts
16
17
  api/payment-reminders-api.ts
@@ -60,6 +61,8 @@ models/create-billing-address-request-dto.ts
60
61
  models/create-billing-address-response-class.ts
61
62
  models/create-credit-allocation-request-dto.ts
62
63
  models/create-credit-allocation-response-class.ts
64
+ models/create-exceeding-credit-request-dto.ts
65
+ models/create-exceeding-credit-response-class.ts
63
66
  models/create-payment-method-response-class.ts
64
67
  models/create-payment-order-dto.ts
65
68
  models/create-payment-order-request-dto.ts
@@ -152,6 +155,9 @@ models/policy-payment-method-class.ts
152
155
  models/primary-bank-account-response-class.ts
153
156
  models/refund-class.ts
154
157
  models/refund-item-class.ts
158
+ models/run-job-grpc-request-dto.ts
159
+ models/run-job-request-dto.ts
160
+ models/run-job-response-class.ts
155
161
  models/sepa-direct-dto.ts
156
162
  models/set-primary-bank-account-request-dto-rest.ts
157
163
  models/shared-transaction-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/payment-sdk@1.22.1-beta.36 --save
20
+ npm install @emilgroup/payment-sdk@1.22.1-beta.38 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/payment-sdk@1.22.1-beta.36
24
+ yarn add @emilgroup/payment-sdk@1.22.1-beta.38
25
25
  ```
26
26
 
27
27
  And then you can import `PaymentsApi`.
@@ -186,11 +186,11 @@ export const BankOrdersApiAxiosParamCreator = function (configuration?: Configur
186
186
  * @param {string} [authorization] Bearer Token
187
187
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
188
188
  * @param {string} [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.
189
- * @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, orderNumber, status, type, tenantBankAccountCode</i>
189
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes</i>
190
190
  * @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: code, description, orderNumber, tenantBankAccountCode</i>
191
191
  * @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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
192
192
  * @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: tenantBankAccount, xmlFile<i>
193
- * @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, orderNumber, status, type, tenantBankAccountCode</i>
193
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes</i>
194
194
  * @param {*} [options] Override http request option.
195
195
  * @throws {RequiredError}
196
196
  */
@@ -360,11 +360,11 @@ export const BankOrdersApiFp = function(configuration?: Configuration) {
360
360
  * @param {string} [authorization] Bearer Token
361
361
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
362
362
  * @param {string} [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.
363
- * @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, orderNumber, status, type, tenantBankAccountCode</i>
363
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes</i>
364
364
  * @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: code, description, orderNumber, tenantBankAccountCode</i>
365
365
  * @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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
366
366
  * @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: tenantBankAccount, xmlFile<i>
367
- * @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, orderNumber, status, type, tenantBankAccountCode</i>
367
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes</i>
368
368
  * @param {*} [options] Override http request option.
369
369
  * @throws {RequiredError}
370
370
  */
@@ -435,11 +435,11 @@ export const BankOrdersApiFactory = function (configuration?: Configuration, bas
435
435
  * @param {string} [authorization] Bearer Token
436
436
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
437
437
  * @param {string} [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.
438
- * @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, orderNumber, status, type, tenantBankAccountCode</i>
438
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes</i>
439
439
  * @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: code, description, orderNumber, tenantBankAccountCode</i>
440
440
  * @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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
441
441
  * @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: tenantBankAccount, xmlFile<i>
442
- * @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, orderNumber, status, type, tenantBankAccountCode</i>
442
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes</i>
443
443
  * @param {*} [options] Override http request option.
444
444
  * @throws {RequiredError}
445
445
  */
@@ -559,7 +559,7 @@ export interface BankOrdersApiListBankOrdersRequest {
559
559
  readonly pageToken?: string
560
560
 
561
561
  /**
562
- * 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, orderNumber, status, type, tenantBankAccountCode</i>
562
+ * 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, orderNumber, status, type, tenantBankAccountCode, entityCodes</i>
563
563
  * @type {string}
564
564
  * @memberof BankOrdersApiListBankOrders
565
565
  */
@@ -587,7 +587,7 @@ export interface BankOrdersApiListBankOrdersRequest {
587
587
  readonly expand?: string
588
588
 
589
589
  /**
590
- * 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, orderNumber, status, type, tenantBankAccountCode</i>
590
+ * 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, orderNumber, status, type, tenantBankAccountCode, entityCodes</i>
591
591
  * @type {string}
592
592
  * @memberof BankOrdersApiListBankOrders
593
593
  */
@@ -21,6 +21,10 @@ 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 { CreateExceedingCreditRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateExceedingCreditResponseClass } from '../models';
27
+ // @ts-ignore
24
28
  import { GetExceedingCreditResponseClass } from '../models';
25
29
  // @ts-ignore
26
30
  import { ListExceedingCreditsResponseClass } from '../models';
@@ -30,6 +34,53 @@ import { ListExceedingCreditsResponseClass } from '../models';
30
34
  */
31
35
  export const ExceedingCreditsApiAxiosParamCreator = function (configuration?: Configuration) {
32
36
  return {
37
+ /**
38
+ * Create an exceeding credit for a bank transaction that exceeds the invoiced amount. **Required Permissions** \"payment-management.payments.create\"
39
+ * @summary Create the exceeding credit
40
+ * @param {CreateExceedingCreditRequestDto} createExceedingCreditRequestDto
41
+ * @param {string} [authorization] Bearer Token
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ createExceedingCredit: async (createExceedingCreditRequestDto: CreateExceedingCreditRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
+ // verify required parameter 'createExceedingCreditRequestDto' is not null or undefined
47
+ assertParamExists('createExceedingCredit', 'createExceedingCreditRequestDto', createExceedingCreditRequestDto)
48
+ const localVarPath = `/paymentservice/v1/exceeding-credits`;
49
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
50
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
51
+ let baseOptions;
52
+ let baseAccessToken;
53
+ if (configuration) {
54
+ baseOptions = configuration.baseOptions;
55
+ baseAccessToken = configuration.accessToken;
56
+ }
57
+
58
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
59
+ const localVarHeaderParameter = {} as any;
60
+ const localVarQueryParameter = {} as any;
61
+
62
+ // authentication bearer required
63
+ // http bearer authentication required
64
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
65
+
66
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
67
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
68
+ }
69
+
70
+
71
+
72
+ localVarHeaderParameter['Content-Type'] = 'application/json';
73
+
74
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
75
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
76
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77
+ localVarRequestOptions.data = serializeDataIfNeeded(createExceedingCreditRequestDto, localVarRequestOptions, configuration)
78
+
79
+ return {
80
+ url: toPathString(localVarUrlObj),
81
+ options: localVarRequestOptions,
82
+ };
83
+ },
33
84
  /**
34
85
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
35
86
  * @summary Retrieve the exceeding credit
@@ -161,6 +212,18 @@ export const ExceedingCreditsApiAxiosParamCreator = function (configuration?: Co
161
212
  export const ExceedingCreditsApiFp = function(configuration?: Configuration) {
162
213
  const localVarAxiosParamCreator = ExceedingCreditsApiAxiosParamCreator(configuration)
163
214
  return {
215
+ /**
216
+ * Create an exceeding credit for a bank transaction that exceeds the invoiced amount. **Required Permissions** \"payment-management.payments.create\"
217
+ * @summary Create the exceeding credit
218
+ * @param {CreateExceedingCreditRequestDto} createExceedingCreditRequestDto
219
+ * @param {string} [authorization] Bearer Token
220
+ * @param {*} [options] Override http request option.
221
+ * @throws {RequiredError}
222
+ */
223
+ async createExceedingCredit(createExceedingCreditRequestDto: CreateExceedingCreditRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateExceedingCreditResponseClass>> {
224
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createExceedingCredit(createExceedingCreditRequestDto, authorization, options);
225
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
226
+ },
164
227
  /**
165
228
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
166
229
  * @summary Retrieve the exceeding credit
@@ -201,6 +264,17 @@ export const ExceedingCreditsApiFp = function(configuration?: Configuration) {
201
264
  export const ExceedingCreditsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
202
265
  const localVarFp = ExceedingCreditsApiFp(configuration)
203
266
  return {
267
+ /**
268
+ * Create an exceeding credit for a bank transaction that exceeds the invoiced amount. **Required Permissions** \"payment-management.payments.create\"
269
+ * @summary Create the exceeding credit
270
+ * @param {CreateExceedingCreditRequestDto} createExceedingCreditRequestDto
271
+ * @param {string} [authorization] Bearer Token
272
+ * @param {*} [options] Override http request option.
273
+ * @throws {RequiredError}
274
+ */
275
+ createExceedingCredit(createExceedingCreditRequestDto: CreateExceedingCreditRequestDto, authorization?: string, options?: any): AxiosPromise<CreateExceedingCreditResponseClass> {
276
+ return localVarFp.createExceedingCredit(createExceedingCreditRequestDto, authorization, options).then((request) => request(axios, basePath));
277
+ },
204
278
  /**
205
279
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
206
280
  * @summary Retrieve the exceeding credit
@@ -232,6 +306,27 @@ export const ExceedingCreditsApiFactory = function (configuration?: Configuratio
232
306
  };
233
307
  };
234
308
 
309
+ /**
310
+ * Request parameters for createExceedingCredit operation in ExceedingCreditsApi.
311
+ * @export
312
+ * @interface ExceedingCreditsApiCreateExceedingCreditRequest
313
+ */
314
+ export interface ExceedingCreditsApiCreateExceedingCreditRequest {
315
+ /**
316
+ *
317
+ * @type {CreateExceedingCreditRequestDto}
318
+ * @memberof ExceedingCreditsApiCreateExceedingCredit
319
+ */
320
+ readonly createExceedingCreditRequestDto: CreateExceedingCreditRequestDto
321
+
322
+ /**
323
+ * Bearer Token
324
+ * @type {string}
325
+ * @memberof ExceedingCreditsApiCreateExceedingCredit
326
+ */
327
+ readonly authorization?: string
328
+ }
329
+
235
330
  /**
236
331
  * Request parameters for getExceedingCredit operation in ExceedingCreditsApi.
237
332
  * @export
@@ -323,6 +418,18 @@ export interface ExceedingCreditsApiListExceedingCreditsRequest {
323
418
  * @extends {BaseAPI}
324
419
  */
325
420
  export class ExceedingCreditsApi extends BaseAPI {
421
+ /**
422
+ * Create an exceeding credit for a bank transaction that exceeds the invoiced amount. **Required Permissions** \"payment-management.payments.create\"
423
+ * @summary Create the exceeding credit
424
+ * @param {ExceedingCreditsApiCreateExceedingCreditRequest} requestParameters Request parameters.
425
+ * @param {*} [options] Override http request option.
426
+ * @throws {RequiredError}
427
+ * @memberof ExceedingCreditsApi
428
+ */
429
+ public createExceedingCredit(requestParameters: ExceedingCreditsApiCreateExceedingCreditRequest, options?: AxiosRequestConfig) {
430
+ return ExceedingCreditsApiFp(this.configuration).createExceedingCredit(requestParameters.createExceedingCreditRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
431
+ }
432
+
326
433
  /**
327
434
  * Retrieves the details of the exceeding credit that was previously created. Supply the unique exceeding credit code that was returned when you created it and Emil Api will return the corresponding exceeding credit information. **Required Permissions** \"payment-management.payments.view\"
328
435
  * @summary Retrieve the exceeding credit
@@ -0,0 +1,165 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil Payment Service
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { RunJobRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { RunJobResponseClass } from '../models';
27
+ /**
28
+ * JobsApi - axios parameter creator
29
+ * @export
30
+ */
31
+ export const JobsApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
35
+ * @summary Create the job run
36
+ * @param {RunJobRequestDto} runJobRequestDto
37
+ * @param {string} [authorization] Bearer Token
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ runJob: async (runJobRequestDto: RunJobRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
42
+ // verify required parameter 'runJobRequestDto' is not null or undefined
43
+ assertParamExists('runJob', 'runJobRequestDto', runJobRequestDto)
44
+ const localVarPath = `/paymentservice/v1/jobs/run`;
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ let baseAccessToken;
49
+ if (configuration) {
50
+ baseOptions = configuration.baseOptions;
51
+ baseAccessToken = configuration.accessToken;
52
+ }
53
+
54
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
55
+ const localVarHeaderParameter = {} as any;
56
+ const localVarQueryParameter = {} as any;
57
+
58
+ // authentication bearer required
59
+ // http bearer authentication required
60
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
61
+
62
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
63
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
64
+ }
65
+
66
+
67
+
68
+ localVarHeaderParameter['Content-Type'] = 'application/json';
69
+
70
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
71
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
72
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
73
+ localVarRequestOptions.data = serializeDataIfNeeded(runJobRequestDto, localVarRequestOptions, configuration)
74
+
75
+ return {
76
+ url: toPathString(localVarUrlObj),
77
+ options: localVarRequestOptions,
78
+ };
79
+ },
80
+ }
81
+ };
82
+
83
+ /**
84
+ * JobsApi - functional programming interface
85
+ * @export
86
+ */
87
+ export const JobsApiFp = function(configuration?: Configuration) {
88
+ const localVarAxiosParamCreator = JobsApiAxiosParamCreator(configuration)
89
+ return {
90
+ /**
91
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
92
+ * @summary Create the job run
93
+ * @param {RunJobRequestDto} runJobRequestDto
94
+ * @param {string} [authorization] Bearer Token
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ async runJob(runJobRequestDto: RunJobRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunJobResponseClass>> {
99
+ const localVarAxiosArgs = await localVarAxiosParamCreator.runJob(runJobRequestDto, authorization, options);
100
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
101
+ },
102
+ }
103
+ };
104
+
105
+ /**
106
+ * JobsApi - factory interface
107
+ * @export
108
+ */
109
+ export const JobsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
110
+ const localVarFp = JobsApiFp(configuration)
111
+ return {
112
+ /**
113
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
114
+ * @summary Create the job run
115
+ * @param {RunJobRequestDto} runJobRequestDto
116
+ * @param {string} [authorization] Bearer Token
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ runJob(runJobRequestDto: RunJobRequestDto, authorization?: string, options?: any): AxiosPromise<RunJobResponseClass> {
121
+ return localVarFp.runJob(runJobRequestDto, authorization, options).then((request) => request(axios, basePath));
122
+ },
123
+ };
124
+ };
125
+
126
+ /**
127
+ * Request parameters for runJob operation in JobsApi.
128
+ * @export
129
+ * @interface JobsApiRunJobRequest
130
+ */
131
+ export interface JobsApiRunJobRequest {
132
+ /**
133
+ *
134
+ * @type {RunJobRequestDto}
135
+ * @memberof JobsApiRunJob
136
+ */
137
+ readonly runJobRequestDto: RunJobRequestDto
138
+
139
+ /**
140
+ * Bearer Token
141
+ * @type {string}
142
+ * @memberof JobsApiRunJob
143
+ */
144
+ readonly authorization?: string
145
+ }
146
+
147
+ /**
148
+ * JobsApi - object-oriented interface
149
+ * @export
150
+ * @class JobsApi
151
+ * @extends {BaseAPI}
152
+ */
153
+ export class JobsApi extends BaseAPI {
154
+ /**
155
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
156
+ * @summary Create the job run
157
+ * @param {JobsApiRunJobRequest} requestParameters Request parameters.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ * @memberof JobsApi
161
+ */
162
+ public runJob(requestParameters: JobsApiRunJobRequest, options?: AxiosRequestConfig) {
163
+ return JobsApiFp(this.configuration).runJob(requestParameters.runJobRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
164
+ }
165
+ }
@@ -188,11 +188,11 @@ export const PaymentRequestsApiAxiosParamCreator = function (configuration?: Con
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
189
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
190
  * @param {string} [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.
191
- * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
192
- * @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: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber&lt;/i&gt;
191
+ * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode, partnerCode, bankOrderCode, bankOrderNumber&lt;/i&gt;
192
+ * @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: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode, bankOrderNumber&lt;/i&gt;
193
193
  * @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status&lt;/i&gt;
194
194
  * @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: paymentReceipts&lt;i&gt;
195
- * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
195
+ * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode, partnerCode, bankOrderCode, bankOrderNumber&lt;/i&gt;
196
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
198
198
  */
@@ -362,11 +362,11 @@ export const PaymentRequestsApiFp = function(configuration?: Configuration) {
362
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
363
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
364
  * @param {string} [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.
365
- * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
366
- * @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: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber&lt;/i&gt;
365
+ * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode, partnerCode, bankOrderCode, bankOrderNumber&lt;/i&gt;
366
+ * @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: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode, bankOrderNumber&lt;/i&gt;
367
367
  * @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status&lt;/i&gt;
368
368
  * @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: paymentReceipts&lt;i&gt;
369
- * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
369
+ * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode, partnerCode, bankOrderCode, bankOrderNumber&lt;/i&gt;
370
370
  * @param {*} [options] Override http request option.
371
371
  * @throws {RequiredError}
372
372
  */
@@ -437,11 +437,11 @@ export const PaymentRequestsApiFactory = function (configuration?: Configuration
437
437
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
438
438
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
439
439
  * @param {string} [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.
440
- * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
441
- * @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: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber&lt;/i&gt;
440
+ * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode, partnerCode, bankOrderCode, bankOrderNumber&lt;/i&gt;
441
+ * @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: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode, bankOrderNumber&lt;/i&gt;
442
442
  * @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status&lt;/i&gt;
443
443
  * @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: paymentReceipts&lt;i&gt;
444
- * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
444
+ * @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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode, partnerCode, bankOrderCode, bankOrderNumber&lt;/i&gt;
445
445
  * @param {*} [options] Override http request option.
446
446
  * @throws {RequiredError}
447
447
  */
@@ -561,14 +561,14 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
561
561
  readonly pageToken?: string
562
562
 
563
563
  /**
564
- * 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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
564
+ * 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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode, partnerCode, bankOrderCode, bankOrderNumber&lt;/i&gt;
565
565
  * @type {string}
566
566
  * @memberof PaymentRequestsApiListPaymentRequests
567
567
  */
568
568
  readonly filter?: string
569
569
 
570
570
  /**
571
- * 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: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber&lt;/i&gt;
571
+ * 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: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode, bankOrderNumber&lt;/i&gt;
572
572
  * @type {string}
573
573
  * @memberof PaymentRequestsApiListPaymentRequests
574
574
  */
@@ -589,7 +589,7 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
589
589
  readonly expand?: string
590
590
 
591
591
  /**
592
- * 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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt&lt;/i&gt;
592
+ * 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, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode, partnerCode, bankOrderCode, bankOrderNumber&lt;/i&gt;
593
593
  * @type {string}
594
594
  * @memberof PaymentRequestsApiListPaymentRequests
595
595
  */
package/api.ts CHANGED
@@ -28,6 +28,7 @@ import { CreditAllocationApi } from './api';
28
28
  import { ExceedingCreditsApi } from './api';
29
29
  import { HealthCheckApi } from './api';
30
30
  import { IBANValidatorApi } from './api';
31
+ import { JobsApi } from './api';
31
32
  import { PaymentMethodsApi } from './api';
32
33
  import { PaymentReceiptsApi } from './api';
33
34
  import { PaymentRemindersApi } from './api';
@@ -49,6 +50,7 @@ export * from './api/credit-allocation-api';
49
50
  export * from './api/exceeding-credits-api';
50
51
  export * from './api/health-check-api';
51
52
  export * from './api/ibanvalidator-api';
53
+ export * from './api/jobs-api';
52
54
  export * from './api/payment-methods-api';
53
55
  export * from './api/payment-receipts-api';
54
56
  export * from './api/payment-reminders-api';
@@ -57,11 +57,11 @@ export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configurat
57
57
  * @param {string} [authorization] Bearer Token
58
58
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
59
59
  * @param {string} [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.
60
- * @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, orderNumber, status, type, tenantBankAccountCode&lt;/i&gt;
60
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes&lt;/i&gt;
61
61
  * @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: code, description, orderNumber, tenantBankAccountCode&lt;/i&gt;
62
62
  * @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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt&lt;/i&gt;
63
63
  * @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: tenantBankAccount, xmlFile&lt;i&gt;
64
- * @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, orderNumber, status, type, tenantBankAccountCode&lt;/i&gt;
64
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes&lt;/i&gt;
65
65
  * @param {*} [options] Override http request option.
66
66
  * @throws {RequiredError}
67
67
  */
@@ -116,11 +116,11 @@ export declare const BankOrdersApiFp: (configuration?: Configuration) => {
116
116
  * @param {string} [authorization] Bearer Token
117
117
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
118
118
  * @param {string} [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 {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, orderNumber, status, type, tenantBankAccountCode&lt;/i&gt;
119
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes&lt;/i&gt;
120
120
  * @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: code, description, orderNumber, tenantBankAccountCode&lt;/i&gt;
121
121
  * @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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt&lt;/i&gt;
122
122
  * @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: tenantBankAccount, xmlFile&lt;i&gt;
123
- * @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, orderNumber, status, type, tenantBankAccountCode&lt;/i&gt;
123
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes&lt;/i&gt;
124
124
  * @param {*} [options] Override http request option.
125
125
  * @throws {RequiredError}
126
126
  */
@@ -175,11 +175,11 @@ export declare const BankOrdersApiFactory: (configuration?: Configuration, baseP
175
175
  * @param {string} [authorization] Bearer Token
176
176
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
177
177
  * @param {string} [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.
178
- * @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, orderNumber, status, type, tenantBankAccountCode&lt;/i&gt;
178
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes&lt;/i&gt;
179
179
  * @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: code, description, orderNumber, tenantBankAccountCode&lt;/i&gt;
180
180
  * @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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt&lt;/i&gt;
181
181
  * @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: tenantBankAccount, xmlFile&lt;i&gt;
182
- * @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, orderNumber, status, type, tenantBankAccountCode&lt;/i&gt;
182
+ * @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, orderNumber, status, type, tenantBankAccountCode, entityCodes&lt;/i&gt;
183
183
  * @param {*} [options] Override http request option.
184
184
  * @throws {RequiredError}
185
185
  */
@@ -283,7 +283,7 @@ export interface BankOrdersApiListBankOrdersRequest {
283
283
  */
284
284
  readonly pageToken?: string;
285
285
  /**
286
- * 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, orderNumber, status, type, tenantBankAccountCode&lt;/i&gt;
286
+ * 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, orderNumber, status, type, tenantBankAccountCode, entityCodes&lt;/i&gt;
287
287
  * @type {string}
288
288
  * @memberof BankOrdersApiListBankOrders
289
289
  */
@@ -307,7 +307,7 @@ export interface BankOrdersApiListBankOrdersRequest {
307
307
  */
308
308
  readonly expand?: string;
309
309
  /**
310
- * 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, orderNumber, status, type, tenantBankAccountCode&lt;/i&gt;
310
+ * 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, orderNumber, status, type, tenantBankAccountCode, entityCodes&lt;/i&gt;
311
311
  * @type {string}
312
312
  * @memberof BankOrdersApiListBankOrders
313
313
  */