@emilgroup/account-sdk-node 1.19.0 → 1.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/README.md +2 -2
  2. package/api/accounts-api.ts +24 -10
  3. package/api/default-api.ts +8 -4
  4. package/dist/api/accounts-api.d.ts +393 -0
  5. package/dist/api/accounts-api.js +646 -0
  6. package/dist/api/default-api.d.ts +70 -0
  7. package/dist/api/default-api.js +204 -0
  8. package/dist/api.d.ts +13 -0
  9. package/dist/api.js +31 -0
  10. package/dist/base.d.ts +78 -0
  11. package/dist/base.js +394 -0
  12. package/dist/common.d.ts +92 -0
  13. package/dist/common.js +277 -0
  14. package/dist/configuration.d.ts +90 -0
  15. package/dist/configuration.js +44 -0
  16. package/dist/index.d.ts +15 -0
  17. package/dist/index.js +36 -0
  18. package/dist/models/account-class.d.ts +164 -0
  19. package/dist/models/account-class.js +22 -0
  20. package/dist/models/create-account-request-dto.d.ts +132 -0
  21. package/dist/models/create-account-request-dto.js +31 -0
  22. package/dist/models/create-account-response-class.d.ts +25 -0
  23. package/dist/models/create-account-response-class.js +15 -0
  24. package/dist/models/get-account-response-class.d.ts +25 -0
  25. package/dist/models/get-account-response-class.js +15 -0
  26. package/dist/models/index.d.ts +10 -0
  27. package/dist/models/index.js +26 -0
  28. package/dist/models/inline-response200.d.ts +54 -0
  29. package/dist/models/inline-response200.js +15 -0
  30. package/dist/models/inline-response503.d.ts +54 -0
  31. package/dist/models/inline-response503.js +15 -0
  32. package/dist/models/list-accounts-response-class.d.ts +31 -0
  33. package/dist/models/list-accounts-response-class.js +15 -0
  34. package/dist/models/policy-class.d.ts +30 -0
  35. package/dist/models/policy-class.js +15 -0
  36. package/dist/models/update-account-request-dto.d.ts +132 -0
  37. package/dist/models/update-account-request-dto.js +31 -0
  38. package/dist/models/update-account-response-class.d.ts +25 -0
  39. package/dist/models/update-account-response-class.js +15 -0
  40. package/models/inline-response200.ts +6 -6
  41. package/models/inline-response503.ts +6 -6
  42. package/package.json +1 -1
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/account-sdk-node@1.19.0 --save
20
+ npm install @emilgroup/account-sdk-node@1.25.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/account-sdk-node@1.19.0
24
+ yarn add @emilgroup/account-sdk-node@1.25.0
25
25
  ```
26
26
 
27
27
  And then you can import `AccountsApi`.
@@ -188,16 +188,17 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
188
188
  * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
189
189
  * @summary List accounts
190
190
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
191
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
191
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
192
192
  * @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.
193
193
  * @param {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
194
194
  * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
195
195
  * @param {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'} [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.
196
196
  * @param {'policies'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
197
+ * @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.
197
198
  * @param {*} [options] Override http request option.
198
199
  * @throws {RequiredError}
199
200
  */
200
- listAccounts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
+ listAccounts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
202
  const localVarPath = `/accountservice/v1/accounts`;
202
203
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
203
204
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -240,6 +241,10 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
240
241
  localVarQueryParameter['expand'] = expand;
241
242
  }
242
243
 
244
+ if (filters !== undefined) {
245
+ localVarQueryParameter['filters'] = filters;
246
+ }
247
+
243
248
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
244
249
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
245
250
  }
@@ -357,17 +362,18 @@ export const AccountsApiFp = function(configuration?: Configuration) {
357
362
  * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
358
363
  * @summary List accounts
359
364
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
360
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
365
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
361
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.
362
367
  * @param {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
363
368
  * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
364
369
  * @param {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'} [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.
365
370
  * @param {'policies'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
371
+ * @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.
366
372
  * @param {*} [options] Override http request option.
367
373
  * @throws {RequiredError}
368
374
  */
369
- async listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponseClass>> {
370
- const localVarAxiosArgs = await localVarAxiosParamCreator.listAccounts(authorization, pageSize, pageToken, filter, search, order, expand, options);
375
+ async listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponseClass>> {
376
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
371
377
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
372
378
  },
373
379
  /**
@@ -431,17 +437,18 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
431
437
  * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
432
438
  * @summary List accounts
433
439
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
434
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
440
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
435
441
  * @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.
436
442
  * @param {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
437
443
  * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
438
444
  * @param {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'} [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.
439
445
  * @param {'policies'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
446
+ * @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.
440
447
  * @param {*} [options] Override http request option.
441
448
  * @throws {RequiredError}
442
449
  */
443
- listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', options?: any): AxiosPromise<ListAccountsResponseClass> {
444
- return localVarFp.listAccounts(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
450
+ listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', filters?: any, options?: any): AxiosPromise<ListAccountsResponseClass> {
451
+ return localVarFp.listAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
445
452
  },
446
453
  /**
447
454
  * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -542,7 +549,7 @@ export interface AccountsApiListAccountsRequest {
542
549
  readonly authorization?: string
543
550
 
544
551
  /**
545
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
552
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
546
553
  * @type {any}
547
554
  * @memberof AccountsApiListAccounts
548
555
  */
@@ -582,6 +589,13 @@ export interface AccountsApiListAccountsRequest {
582
589
  * @memberof AccountsApiListAccounts
583
590
  */
584
591
  readonly expand?: 'policies'
592
+
593
+ /**
594
+ * 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.
595
+ * @type {any}
596
+ * @memberof AccountsApiListAccounts
597
+ */
598
+ readonly filters?: any
585
599
  }
586
600
 
587
601
  /**
@@ -664,7 +678,7 @@ export class AccountsApi extends BaseAPI {
664
678
  * @memberof AccountsApi
665
679
  */
666
680
  public listAccounts(requestParameters: AccountsApiListAccountsRequest = {}, options?: AxiosRequestConfig) {
667
- return AccountsApiFp(this.configuration).listAccounts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
681
+ return AccountsApiFp(this.configuration).listAccounts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
668
682
  }
669
683
 
670
684
  /**
@@ -35,7 +35,8 @@ const FormData = require('form-data');
35
35
  export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- *
38
+ * Returns the health status of the account service. This endpoint is used to monitor the operational status of the account service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
39
+ * @summary Health Check
39
40
  * @param {*} [options] Override http request option.
40
41
  * @throws {RequiredError}
41
42
  */
@@ -76,7 +77,8 @@ export const DefaultApiFp = function(configuration?: Configuration) {
76
77
  const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
77
78
  return {
78
79
  /**
79
- *
80
+ * Returns the health status of the account service. This endpoint is used to monitor the operational status of the account service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
81
+ * @summary Health Check
80
82
  * @param {*} [options] Override http request option.
81
83
  * @throws {RequiredError}
82
84
  */
@@ -95,7 +97,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
95
97
  const localVarFp = DefaultApiFp(configuration)
96
98
  return {
97
99
  /**
98
- *
100
+ * Returns the health status of the account service. This endpoint is used to monitor the operational status of the account service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
101
+ * @summary Health Check
99
102
  * @param {*} [options] Override http request option.
100
103
  * @throws {RequiredError}
101
104
  */
@@ -113,7 +116,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
113
116
  */
114
117
  export class DefaultApi extends BaseAPI {
115
118
  /**
116
- *
119
+ * Returns the health status of the account service. This endpoint is used to monitor the operational status of the account service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
120
+ * @summary Health Check
117
121
  * @param {*} [options] Override http request option.
118
122
  * @throws {RequiredError}
119
123
  * @memberof DefaultApi
@@ -0,0 +1,393 @@
1
+ /**
2
+ * EMIL AccountService
3
+ * The EMIL AccountService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateAccountRequestDto } from '../models';
16
+ import { CreateAccountResponseClass } from '../models';
17
+ import { GetAccountResponseClass } from '../models';
18
+ import { ListAccountsResponseClass } from '../models';
19
+ import { UpdateAccountRequestDto } from '../models';
20
+ import { UpdateAccountResponseClass } from '../models';
21
+ /**
22
+ * AccountsApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ * This will create an account in the database. Account creation is usually part of a complex workflow that starts with lead creation. Creating directly an account without prior knowledge might result in an unusable account. Look into lead creation for more information.
28
+ * @summary Create the account
29
+ * @param {CreateAccountRequestDto} createAccountRequestDto
30
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ */
34
+ createAccount: (createAccountRequestDto: CreateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
37
+ * @summary Delete the account
38
+ * @param {string} code Unique identifier for the object.
39
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ deleteAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
+ /**
45
+ * Retrieves the details of the account that was previously created. Supply the unique account code that was returned when you created it and Emil Api will return the corresponding account information.
46
+ * @summary Retrieve the account
47
+ * @param {string} code Unique identifier for the object.
48
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
49
+ * @param {'policies'} [expand]
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ */
53
+ getAccount: (code: string, authorization?: string, expand?: 'policies', options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
+ /**
55
+ * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
56
+ * @summary List accounts
57
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
58
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
59
+ * @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.
60
+ * @param {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
61
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
62
+ * @param {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'} [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.
63
+ * @param {'policies'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
64
+ * @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.
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ */
68
+ listAccounts: (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ /**
70
+ * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
71
+ * @summary Update the account
72
+ * @param {string} code Unique identifier for the object.
73
+ * @param {UpdateAccountRequestDto} updateAccountRequestDto
74
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ updateAccount: (code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ };
80
+ /**
81
+ * AccountsApi - functional programming interface
82
+ * @export
83
+ */
84
+ export declare const AccountsApiFp: (configuration?: Configuration) => {
85
+ /**
86
+ * This will create an account in the database. Account creation is usually part of a complex workflow that starts with lead creation. Creating directly an account without prior knowledge might result in an unusable account. Look into lead creation for more information.
87
+ * @summary Create the account
88
+ * @param {CreateAccountRequestDto} createAccountRequestDto
89
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ */
93
+ createAccount(createAccountRequestDto: CreateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountResponseClass>>;
94
+ /**
95
+ * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
96
+ * @summary Delete the account
97
+ * @param {string} code Unique identifier for the object.
98
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ deleteAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
103
+ /**
104
+ * Retrieves the details of the account that was previously created. Supply the unique account code that was returned when you created it and Emil Api will return the corresponding account information.
105
+ * @summary Retrieve the account
106
+ * @param {string} code Unique identifier for the object.
107
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
108
+ * @param {'policies'} [expand]
109
+ * @param {*} [options] Override http request option.
110
+ * @throws {RequiredError}
111
+ */
112
+ getAccount(code: string, authorization?: string, expand?: 'policies', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponseClass>>;
113
+ /**
114
+ * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
115
+ * @summary List accounts
116
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
117
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
118
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
119
+ * @param {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
120
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
121
+ * @param {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
122
+ * @param {'policies'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
123
+ * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
124
+ * @param {*} [options] Override http request option.
125
+ * @throws {RequiredError}
126
+ */
127
+ listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponseClass>>;
128
+ /**
129
+ * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
130
+ * @summary Update the account
131
+ * @param {string} code Unique identifier for the object.
132
+ * @param {UpdateAccountRequestDto} updateAccountRequestDto
133
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
134
+ * @param {*} [options] Override http request option.
135
+ * @throws {RequiredError}
136
+ */
137
+ updateAccount(code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAccountResponseClass>>;
138
+ };
139
+ /**
140
+ * AccountsApi - factory interface
141
+ * @export
142
+ */
143
+ export declare const AccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
144
+ /**
145
+ * This will create an account in the database. Account creation is usually part of a complex workflow that starts with lead creation. Creating directly an account without prior knowledge might result in an unusable account. Look into lead creation for more information.
146
+ * @summary Create the account
147
+ * @param {CreateAccountRequestDto} createAccountRequestDto
148
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
149
+ * @param {*} [options] Override http request option.
150
+ * @throws {RequiredError}
151
+ */
152
+ createAccount(createAccountRequestDto: CreateAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateAccountResponseClass>;
153
+ /**
154
+ * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
155
+ * @summary Delete the account
156
+ * @param {string} code Unique identifier for the object.
157
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ deleteAccount(code: string, authorization?: string, options?: any): AxiosPromise<void>;
162
+ /**
163
+ * Retrieves the details of the account that was previously created. Supply the unique account code that was returned when you created it and Emil Api will return the corresponding account information.
164
+ * @summary Retrieve the account
165
+ * @param {string} code Unique identifier for the object.
166
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
167
+ * @param {'policies'} [expand]
168
+ * @param {*} [options] Override http request option.
169
+ * @throws {RequiredError}
170
+ */
171
+ getAccount(code: string, authorization?: string, expand?: 'policies', options?: any): AxiosPromise<GetAccountResponseClass>;
172
+ /**
173
+ * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
174
+ * @summary List accounts
175
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
176
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
177
+ * @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.
178
+ * @param {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
179
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
180
+ * @param {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'} [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.
181
+ * @param {'policies'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
182
+ * @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.
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName', search?: any, order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber', expand?: 'policies', filters?: any, options?: any): AxiosPromise<ListAccountsResponseClass>;
187
+ /**
188
+ * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
189
+ * @summary Update the account
190
+ * @param {string} code Unique identifier for the object.
191
+ * @param {UpdateAccountRequestDto} updateAccountRequestDto
192
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ */
196
+ updateAccount(code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateAccountResponseClass>;
197
+ };
198
+ /**
199
+ * Request parameters for createAccount operation in AccountsApi.
200
+ * @export
201
+ * @interface AccountsApiCreateAccountRequest
202
+ */
203
+ export interface AccountsApiCreateAccountRequest {
204
+ /**
205
+ *
206
+ * @type {CreateAccountRequestDto}
207
+ * @memberof AccountsApiCreateAccount
208
+ */
209
+ readonly createAccountRequestDto: CreateAccountRequestDto;
210
+ /**
211
+ * Bearer Token: provided by the login endpoint under the name accessToken.
212
+ * @type {string}
213
+ * @memberof AccountsApiCreateAccount
214
+ */
215
+ readonly authorization?: string;
216
+ }
217
+ /**
218
+ * Request parameters for deleteAccount operation in AccountsApi.
219
+ * @export
220
+ * @interface AccountsApiDeleteAccountRequest
221
+ */
222
+ export interface AccountsApiDeleteAccountRequest {
223
+ /**
224
+ * Unique identifier for the object.
225
+ * @type {string}
226
+ * @memberof AccountsApiDeleteAccount
227
+ */
228
+ readonly code: string;
229
+ /**
230
+ * Bearer Token: provided by the login endpoint under the name accessToken.
231
+ * @type {string}
232
+ * @memberof AccountsApiDeleteAccount
233
+ */
234
+ readonly authorization?: string;
235
+ }
236
+ /**
237
+ * Request parameters for getAccount operation in AccountsApi.
238
+ * @export
239
+ * @interface AccountsApiGetAccountRequest
240
+ */
241
+ export interface AccountsApiGetAccountRequest {
242
+ /**
243
+ * Unique identifier for the object.
244
+ * @type {string}
245
+ * @memberof AccountsApiGetAccount
246
+ */
247
+ readonly code: string;
248
+ /**
249
+ * Bearer Token: provided by the login endpoint under the name accessToken.
250
+ * @type {string}
251
+ * @memberof AccountsApiGetAccount
252
+ */
253
+ readonly authorization?: string;
254
+ /**
255
+ *
256
+ * @type {'policies'}
257
+ * @memberof AccountsApiGetAccount
258
+ */
259
+ readonly expand?: 'policies';
260
+ }
261
+ /**
262
+ * Request parameters for listAccounts operation in AccountsApi.
263
+ * @export
264
+ * @interface AccountsApiListAccountsRequest
265
+ */
266
+ export interface AccountsApiListAccountsRequest {
267
+ /**
268
+ * Bearer Token: provided by the login endpoint under the name accessToken.
269
+ * @type {string}
270
+ * @memberof AccountsApiListAccounts
271
+ */
272
+ readonly authorization?: string;
273
+ /**
274
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
275
+ * @type {any}
276
+ * @memberof AccountsApiListAccounts
277
+ */
278
+ readonly pageSize?: any;
279
+ /**
280
+ * 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.
281
+ * @type {any}
282
+ * @memberof AccountsApiListAccounts
283
+ */
284
+ readonly pageToken?: any;
285
+ /**
286
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
287
+ * @type {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'}
288
+ * @memberof AccountsApiListAccounts
289
+ */
290
+ readonly filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName';
291
+ /**
292
+ * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
293
+ * @type {any}
294
+ * @memberof AccountsApiListAccounts
295
+ */
296
+ readonly search?: any;
297
+ /**
298
+ * 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.
299
+ * @type {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'}
300
+ * @memberof AccountsApiListAccounts
301
+ */
302
+ readonly order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber';
303
+ /**
304
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
305
+ * @type {'policies'}
306
+ * @memberof AccountsApiListAccounts
307
+ */
308
+ readonly expand?: 'policies';
309
+ /**
310
+ * 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.
311
+ * @type {any}
312
+ * @memberof AccountsApiListAccounts
313
+ */
314
+ readonly filters?: any;
315
+ }
316
+ /**
317
+ * Request parameters for updateAccount operation in AccountsApi.
318
+ * @export
319
+ * @interface AccountsApiUpdateAccountRequest
320
+ */
321
+ export interface AccountsApiUpdateAccountRequest {
322
+ /**
323
+ * Unique identifier for the object.
324
+ * @type {string}
325
+ * @memberof AccountsApiUpdateAccount
326
+ */
327
+ readonly code: string;
328
+ /**
329
+ *
330
+ * @type {UpdateAccountRequestDto}
331
+ * @memberof AccountsApiUpdateAccount
332
+ */
333
+ readonly updateAccountRequestDto: UpdateAccountRequestDto;
334
+ /**
335
+ * Bearer Token: provided by the login endpoint under the name accessToken.
336
+ * @type {string}
337
+ * @memberof AccountsApiUpdateAccount
338
+ */
339
+ readonly authorization?: string;
340
+ }
341
+ /**
342
+ * AccountsApi - object-oriented interface
343
+ * @export
344
+ * @class AccountsApi
345
+ * @extends {BaseAPI}
346
+ */
347
+ export declare class AccountsApi extends BaseAPI {
348
+ /**
349
+ * This will create an account in the database. Account creation is usually part of a complex workflow that starts with lead creation. Creating directly an account without prior knowledge might result in an unusable account. Look into lead creation for more information.
350
+ * @summary Create the account
351
+ * @param {AccountsApiCreateAccountRequest} requestParameters Request parameters.
352
+ * @param {*} [options] Override http request option.
353
+ * @throws {RequiredError}
354
+ * @memberof AccountsApi
355
+ */
356
+ createAccount(requestParameters: AccountsApiCreateAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountResponseClass, any>>;
357
+ /**
358
+ * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
359
+ * @summary Delete the account
360
+ * @param {AccountsApiDeleteAccountRequest} requestParameters Request parameters.
361
+ * @param {*} [options] Override http request option.
362
+ * @throws {RequiredError}
363
+ * @memberof AccountsApi
364
+ */
365
+ deleteAccount(requestParameters: AccountsApiDeleteAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
366
+ /**
367
+ * Retrieves the details of the account that was previously created. Supply the unique account code that was returned when you created it and Emil Api will return the corresponding account information.
368
+ * @summary Retrieve the account
369
+ * @param {AccountsApiGetAccountRequest} requestParameters Request parameters.
370
+ * @param {*} [options] Override http request option.
371
+ * @throws {RequiredError}
372
+ * @memberof AccountsApi
373
+ */
374
+ getAccount(requestParameters: AccountsApiGetAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountResponseClass, any>>;
375
+ /**
376
+ * Returns a list of accounts you have previously created. The accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
377
+ * @summary List accounts
378
+ * @param {AccountsApiListAccountsRequest} requestParameters Request parameters.
379
+ * @param {*} [options] Override http request option.
380
+ * @throws {RequiredError}
381
+ * @memberof AccountsApi
382
+ */
383
+ listAccounts(requestParameters?: AccountsApiListAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAccountsResponseClass, any>>;
384
+ /**
385
+ * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
386
+ * @summary Update the account
387
+ * @param {AccountsApiUpdateAccountRequest} requestParameters Request parameters.
388
+ * @param {*} [options] Override http request option.
389
+ * @throws {RequiredError}
390
+ * @memberof AccountsApi
391
+ */
392
+ updateAccount(requestParameters: AccountsApiUpdateAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAccountResponseClass, any>>;
393
+ }