@emilgroup/account-sdk-node 1.18.0 → 1.19.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 (40) hide show
  1. package/README.md +2 -2
  2. package/models/create-account-request-dto.ts +1 -1
  3. package/models/update-account-request-dto.ts +1 -1
  4. package/package.json +2 -2
  5. package/dist/api/accounts-api.d.ts +0 -384
  6. package/dist/api/accounts-api.js +0 -640
  7. package/dist/api/default-api.d.ts +0 -66
  8. package/dist/api/default-api.js +0 -200
  9. package/dist/api.d.ts +0 -13
  10. package/dist/api.js +0 -31
  11. package/dist/base.d.ts +0 -78
  12. package/dist/base.js +0 -394
  13. package/dist/common.d.ts +0 -92
  14. package/dist/common.js +0 -277
  15. package/dist/configuration.d.ts +0 -90
  16. package/dist/configuration.js +0 -44
  17. package/dist/index.d.ts +0 -15
  18. package/dist/index.js +0 -36
  19. package/dist/models/account-class.d.ts +0 -164
  20. package/dist/models/account-class.js +0 -22
  21. package/dist/models/create-account-request-dto.d.ts +0 -132
  22. package/dist/models/create-account-request-dto.js +0 -31
  23. package/dist/models/create-account-response-class.d.ts +0 -25
  24. package/dist/models/create-account-response-class.js +0 -15
  25. package/dist/models/get-account-response-class.d.ts +0 -25
  26. package/dist/models/get-account-response-class.js +0 -15
  27. package/dist/models/index.d.ts +0 -10
  28. package/dist/models/index.js +0 -26
  29. package/dist/models/inline-response200.d.ts +0 -54
  30. package/dist/models/inline-response200.js +0 -15
  31. package/dist/models/inline-response503.d.ts +0 -54
  32. package/dist/models/inline-response503.js +0 -15
  33. package/dist/models/list-accounts-response-class.d.ts +0 -31
  34. package/dist/models/list-accounts-response-class.js +0 -15
  35. package/dist/models/policy-class.d.ts +0 -30
  36. package/dist/models/policy-class.js +0 -15
  37. package/dist/models/update-account-request-dto.d.ts +0 -132
  38. package/dist/models/update-account-request-dto.js +0 -31
  39. package/dist/models/update-account-response-class.d.ts +0 -25
  40. package/dist/models/update-account-response-class.js +0 -15
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.18.0 --save
20
+ npm install @emilgroup/account-sdk-node@1.19.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/account-sdk-node@1.18.0
24
+ yarn add @emilgroup/account-sdk-node@1.19.0
25
25
  ```
26
26
 
27
27
  And then you can import `AccountsApi`.
@@ -91,7 +91,7 @@ export interface CreateAccountRequestDto {
91
91
  * @type {string}
92
92
  * @memberof CreateAccountRequestDto
93
93
  */
94
- 'phone': string;
94
+ 'phone'?: string;
95
95
  /**
96
96
  * Optional field to enter extra information.
97
97
  * @type {object}
@@ -91,7 +91,7 @@ export interface UpdateAccountRequestDto {
91
91
  * @type {string}
92
92
  * @memberof UpdateAccountRequestDto
93
93
  */
94
- 'phone': string;
94
+ 'phone'?: string;
95
95
  /**
96
96
  * Optional field to enter extra information.
97
97
  * @type {object}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/account-sdk-node",
3
- "version": "1.18.0",
3
+ "version": "1.19.0",
4
4
  "description": "OpenAPI client for @emilgroup/account-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -23,7 +23,7 @@
23
23
  "url": "^0.11.0"
24
24
  },
25
25
  "devDependencies": {
26
- "@types/node": "^12.11.5",
26
+ "@types/node": "^12.11.5",
27
27
  "typescript": "^4.0"
28
28
  }
29
29
  }
@@ -1,384 +0,0 @@
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 100. 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 {*} [options] Override http request option.
65
- * @throws {RequiredError}
66
- */
67
- 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<RequestArgs>;
68
- /**
69
- * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
70
- * @summary Update the account
71
- * @param {string} code Unique identifier for the object.
72
- * @param {UpdateAccountRequestDto} updateAccountRequestDto
73
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
74
- * @param {*} [options] Override http request option.
75
- * @throws {RequiredError}
76
- */
77
- updateAccount: (code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
78
- };
79
- /**
80
- * AccountsApi - functional programming interface
81
- * @export
82
- */
83
- export declare const AccountsApiFp: (configuration?: Configuration) => {
84
- /**
85
- * 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.
86
- * @summary Create the account
87
- * @param {CreateAccountRequestDto} createAccountRequestDto
88
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
- * @param {*} [options] Override http request option.
90
- * @throws {RequiredError}
91
- */
92
- createAccount(createAccountRequestDto: CreateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountResponseClass>>;
93
- /**
94
- * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
95
- * @summary Delete the account
96
- * @param {string} code Unique identifier for the object.
97
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
98
- * @param {*} [options] Override http request option.
99
- * @throws {RequiredError}
100
- */
101
- deleteAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
102
- /**
103
- * 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.
104
- * @summary Retrieve the account
105
- * @param {string} code Unique identifier for the object.
106
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
107
- * @param {'policies'} [expand]
108
- * @param {*} [options] Override http request option.
109
- * @throws {RequiredError}
110
- */
111
- getAccount(code: string, authorization?: string, expand?: 'policies', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponseClass>>;
112
- /**
113
- * 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.
114
- * @summary List accounts
115
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
116
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
117
- * @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.
118
- * @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.
119
- * @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.
120
- * @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.
121
- * @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.
122
- * @param {*} [options] Override http request option.
123
- * @throws {RequiredError}
124
- */
125
- 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>>;
126
- /**
127
- * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
128
- * @summary Update the account
129
- * @param {string} code Unique identifier for the object.
130
- * @param {UpdateAccountRequestDto} updateAccountRequestDto
131
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
132
- * @param {*} [options] Override http request option.
133
- * @throws {RequiredError}
134
- */
135
- updateAccount(code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAccountResponseClass>>;
136
- };
137
- /**
138
- * AccountsApi - factory interface
139
- * @export
140
- */
141
- export declare const AccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
142
- /**
143
- * 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.
144
- * @summary Create the account
145
- * @param {CreateAccountRequestDto} createAccountRequestDto
146
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
147
- * @param {*} [options] Override http request option.
148
- * @throws {RequiredError}
149
- */
150
- createAccount(createAccountRequestDto: CreateAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateAccountResponseClass>;
151
- /**
152
- * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
153
- * @summary Delete the account
154
- * @param {string} code Unique identifier for the object.
155
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
156
- * @param {*} [options] Override http request option.
157
- * @throws {RequiredError}
158
- */
159
- deleteAccount(code: string, authorization?: string, options?: any): AxiosPromise<void>;
160
- /**
161
- * 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.
162
- * @summary Retrieve the account
163
- * @param {string} code Unique identifier for the object.
164
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
165
- * @param {'policies'} [expand]
166
- * @param {*} [options] Override http request option.
167
- * @throws {RequiredError}
168
- */
169
- getAccount(code: string, authorization?: string, expand?: 'policies', options?: any): AxiosPromise<GetAccountResponseClass>;
170
- /**
171
- * 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.
172
- * @summary List accounts
173
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
174
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
175
- * @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.
176
- * @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.
177
- * @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.
178
- * @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.
179
- * @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.
180
- * @param {*} [options] Override http request option.
181
- * @throws {RequiredError}
182
- */
183
- 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>;
184
- /**
185
- * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
186
- * @summary Update the account
187
- * @param {string} code Unique identifier for the object.
188
- * @param {UpdateAccountRequestDto} updateAccountRequestDto
189
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
190
- * @param {*} [options] Override http request option.
191
- * @throws {RequiredError}
192
- */
193
- updateAccount(code: string, updateAccountRequestDto: UpdateAccountRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateAccountResponseClass>;
194
- };
195
- /**
196
- * Request parameters for createAccount operation in AccountsApi.
197
- * @export
198
- * @interface AccountsApiCreateAccountRequest
199
- */
200
- export interface AccountsApiCreateAccountRequest {
201
- /**
202
- *
203
- * @type {CreateAccountRequestDto}
204
- * @memberof AccountsApiCreateAccount
205
- */
206
- readonly createAccountRequestDto: CreateAccountRequestDto;
207
- /**
208
- * Bearer Token: provided by the login endpoint under the name accessToken.
209
- * @type {string}
210
- * @memberof AccountsApiCreateAccount
211
- */
212
- readonly authorization?: string;
213
- }
214
- /**
215
- * Request parameters for deleteAccount operation in AccountsApi.
216
- * @export
217
- * @interface AccountsApiDeleteAccountRequest
218
- */
219
- export interface AccountsApiDeleteAccountRequest {
220
- /**
221
- * Unique identifier for the object.
222
- * @type {string}
223
- * @memberof AccountsApiDeleteAccount
224
- */
225
- readonly code: string;
226
- /**
227
- * Bearer Token: provided by the login endpoint under the name accessToken.
228
- * @type {string}
229
- * @memberof AccountsApiDeleteAccount
230
- */
231
- readonly authorization?: string;
232
- }
233
- /**
234
- * Request parameters for getAccount operation in AccountsApi.
235
- * @export
236
- * @interface AccountsApiGetAccountRequest
237
- */
238
- export interface AccountsApiGetAccountRequest {
239
- /**
240
- * Unique identifier for the object.
241
- * @type {string}
242
- * @memberof AccountsApiGetAccount
243
- */
244
- readonly code: string;
245
- /**
246
- * Bearer Token: provided by the login endpoint under the name accessToken.
247
- * @type {string}
248
- * @memberof AccountsApiGetAccount
249
- */
250
- readonly authorization?: string;
251
- /**
252
- *
253
- * @type {'policies'}
254
- * @memberof AccountsApiGetAccount
255
- */
256
- readonly expand?: 'policies';
257
- }
258
- /**
259
- * Request parameters for listAccounts operation in AccountsApi.
260
- * @export
261
- * @interface AccountsApiListAccountsRequest
262
- */
263
- export interface AccountsApiListAccountsRequest {
264
- /**
265
- * Bearer Token: provided by the login endpoint under the name accessToken.
266
- * @type {string}
267
- * @memberof AccountsApiListAccounts
268
- */
269
- readonly authorization?: string;
270
- /**
271
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
272
- * @type {any}
273
- * @memberof AccountsApiListAccounts
274
- */
275
- readonly pageSize?: any;
276
- /**
277
- * 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.
278
- * @type {any}
279
- * @memberof AccountsApiListAccounts
280
- */
281
- readonly pageToken?: any;
282
- /**
283
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
284
- * @type {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'}
285
- * @memberof AccountsApiListAccounts
286
- */
287
- readonly filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName';
288
- /**
289
- * 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.
290
- * @type {any}
291
- * @memberof AccountsApiListAccounts
292
- */
293
- readonly search?: any;
294
- /**
295
- * 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.
296
- * @type {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'}
297
- * @memberof AccountsApiListAccounts
298
- */
299
- readonly order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber';
300
- /**
301
- * 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.
302
- * @type {'policies'}
303
- * @memberof AccountsApiListAccounts
304
- */
305
- readonly expand?: 'policies';
306
- }
307
- /**
308
- * Request parameters for updateAccount operation in AccountsApi.
309
- * @export
310
- * @interface AccountsApiUpdateAccountRequest
311
- */
312
- export interface AccountsApiUpdateAccountRequest {
313
- /**
314
- * Unique identifier for the object.
315
- * @type {string}
316
- * @memberof AccountsApiUpdateAccount
317
- */
318
- readonly code: string;
319
- /**
320
- *
321
- * @type {UpdateAccountRequestDto}
322
- * @memberof AccountsApiUpdateAccount
323
- */
324
- readonly updateAccountRequestDto: UpdateAccountRequestDto;
325
- /**
326
- * Bearer Token: provided by the login endpoint under the name accessToken.
327
- * @type {string}
328
- * @memberof AccountsApiUpdateAccount
329
- */
330
- readonly authorization?: string;
331
- }
332
- /**
333
- * AccountsApi - object-oriented interface
334
- * @export
335
- * @class AccountsApi
336
- * @extends {BaseAPI}
337
- */
338
- export declare class AccountsApi extends BaseAPI {
339
- /**
340
- * 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.
341
- * @summary Create the account
342
- * @param {AccountsApiCreateAccountRequest} requestParameters Request parameters.
343
- * @param {*} [options] Override http request option.
344
- * @throws {RequiredError}
345
- * @memberof AccountsApi
346
- */
347
- createAccount(requestParameters: AccountsApiCreateAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountResponseClass, any>>;
348
- /**
349
- * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
350
- * @summary Delete the account
351
- * @param {AccountsApiDeleteAccountRequest} requestParameters Request parameters.
352
- * @param {*} [options] Override http request option.
353
- * @throws {RequiredError}
354
- * @memberof AccountsApi
355
- */
356
- deleteAccount(requestParameters: AccountsApiDeleteAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
357
- /**
358
- * 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.
359
- * @summary Retrieve the account
360
- * @param {AccountsApiGetAccountRequest} requestParameters Request parameters.
361
- * @param {*} [options] Override http request option.
362
- * @throws {RequiredError}
363
- * @memberof AccountsApi
364
- */
365
- getAccount(requestParameters: AccountsApiGetAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountResponseClass, any>>;
366
- /**
367
- * 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.
368
- * @summary List accounts
369
- * @param {AccountsApiListAccountsRequest} requestParameters Request parameters.
370
- * @param {*} [options] Override http request option.
371
- * @throws {RequiredError}
372
- * @memberof AccountsApi
373
- */
374
- listAccounts(requestParameters?: AccountsApiListAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAccountsResponseClass, any>>;
375
- /**
376
- * Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
377
- * @summary Update the account
378
- * @param {AccountsApiUpdateAccountRequest} requestParameters Request parameters.
379
- * @param {*} [options] Override http request option.
380
- * @throws {RequiredError}
381
- * @memberof AccountsApi
382
- */
383
- updateAccount(requestParameters: AccountsApiUpdateAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAccountResponseClass, any>>;
384
- }