@emilgroup/account-sdk-node 1.7.0 → 1.8.1
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.
- package/.openapi-generator/FILES +3 -2
- package/README.md +2 -2
- package/api/accounts-api.ts +29 -29
- package/api/default-api.ts +124 -0
- package/api.ts +2 -0
- package/dist/api/accounts-api.d.ts +30 -30
- package/dist/api/accounts-api.js +12 -12
- package/dist/api/default-api.d.ts +66 -0
- package/dist/api/default-api.js +200 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/account-class.d.ts +8 -8
- package/dist/models/create-account-request-dto.d.ts +24 -24
- package/dist/models/index.d.ts +2 -2
- package/dist/models/index.js +2 -2
- package/dist/models/inline-response200.d.ts +54 -0
- package/dist/models/inline-response503.d.ts +54 -0
- package/dist/models/update-account-request-dto.d.ts +32 -32
- package/models/account-class.ts +8 -8
- package/models/create-account-request-dto.ts +24 -24
- package/models/index.ts +2 -2
- package/models/inline-response200.ts +48 -0
- package/models/inline-response503.ts +48 -0
- package/models/update-account-request-dto.ts +32 -32
- package/package.json +1 -1
- package/dist/models/delete-request-dto.d.ts +0 -24
- package/dist/models/register-policy-request-dto.d.ts +0 -36
- package/models/delete-request-dto.ts +0 -30
- package/models/register-policy-request-dto.ts +0 -42
- /package/dist/models/{delete-request-dto.js → inline-response200.js} +0 -0
- /package/dist/models/{register-policy-request-dto.js → inline-response503.js} +0 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
6
|
api/accounts-api.ts
|
|
7
|
+
api/default-api.ts
|
|
7
8
|
base.ts
|
|
8
9
|
common.ts
|
|
9
10
|
configuration.ts
|
|
@@ -12,12 +13,12 @@ index.ts
|
|
|
12
13
|
models/account-class.ts
|
|
13
14
|
models/create-account-request-dto.ts
|
|
14
15
|
models/create-account-response-class.ts
|
|
15
|
-
models/delete-request-dto.ts
|
|
16
16
|
models/get-account-response-class.ts
|
|
17
17
|
models/index.ts
|
|
18
|
+
models/inline-response200.ts
|
|
19
|
+
models/inline-response503.ts
|
|
18
20
|
models/list-accounts-response-class.ts
|
|
19
21
|
models/policy-class.ts
|
|
20
|
-
models/register-policy-request-dto.ts
|
|
21
22
|
models/update-account-request-dto.ts
|
|
22
23
|
models/update-account-response-class.ts
|
|
23
24
|
package.json
|
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.
|
|
20
|
+
npm install @emilgroup/account-sdk-node@1.8.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/account-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/account-sdk-node@1.8.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `AccountsApi`.
|
package/api/accounts-api.ts
CHANGED
|
@@ -139,11 +139,11 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
139
139
|
* @summary Retrieve the account
|
|
140
140
|
* @param {string} code Unique identifier for the object.
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
-
* @param {
|
|
142
|
+
* @param {'policies'} [expand]
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
|
-
getAccount: async (code: string, authorization?: string, expand?:
|
|
146
|
+
getAccount: async (code: string, authorization?: string, expand?: 'policies', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
147
147
|
// verify required parameter 'code' is not null or undefined
|
|
148
148
|
assertParamExists('getAccount', 'code', code)
|
|
149
149
|
const localVarPath = `/accountservice/v1/accounts/{code}`
|
|
@@ -190,14 +190,14 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
190
190
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
191
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. 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
|
-
* @param {
|
|
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
|
-
* @param {
|
|
196
|
-
* @param {
|
|
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
|
+
* @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
197
|
* @param {*} [options] Override http request option.
|
|
198
198
|
* @throws {RequiredError}
|
|
199
199
|
*/
|
|
200
|
-
listAccounts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
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
201
|
const localVarPath = `/accountservice/v1/accounts`;
|
|
202
202
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
203
203
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -336,7 +336,7 @@ export const AccountsApiFp = function(configuration?: Configuration) {
|
|
|
336
336
|
* @param {*} [options] Override http request option.
|
|
337
337
|
* @throws {RequiredError}
|
|
338
338
|
*/
|
|
339
|
-
async deleteAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
339
|
+
async deleteAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
340
340
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccount(code, authorization, options);
|
|
341
341
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
342
342
|
},
|
|
@@ -345,11 +345,11 @@ export const AccountsApiFp = function(configuration?: Configuration) {
|
|
|
345
345
|
* @summary Retrieve the account
|
|
346
346
|
* @param {string} code Unique identifier for the object.
|
|
347
347
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
348
|
-
* @param {
|
|
348
|
+
* @param {'policies'} [expand]
|
|
349
349
|
* @param {*} [options] Override http request option.
|
|
350
350
|
* @throws {RequiredError}
|
|
351
351
|
*/
|
|
352
|
-
async getAccount(code: string, authorization?: string, expand?:
|
|
352
|
+
async getAccount(code: string, authorization?: string, expand?: 'policies', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponseClass>> {
|
|
353
353
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getAccount(code, authorization, expand, options);
|
|
354
354
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
355
355
|
},
|
|
@@ -359,14 +359,14 @@ export const AccountsApiFp = function(configuration?: Configuration) {
|
|
|
359
359
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
360
360
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
361
361
|
* @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.
|
|
362
|
-
* @param {
|
|
362
|
+
* @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
363
|
* @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.
|
|
364
|
-
* @param {
|
|
365
|
-
* @param {
|
|
364
|
+
* @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
|
+
* @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.
|
|
366
366
|
* @param {*} [options] Override http request option.
|
|
367
367
|
* @throws {RequiredError}
|
|
368
368
|
*/
|
|
369
|
-
async listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
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
370
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listAccounts(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
371
371
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
372
372
|
},
|
|
@@ -412,7 +412,7 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
|
|
|
412
412
|
* @param {*} [options] Override http request option.
|
|
413
413
|
* @throws {RequiredError}
|
|
414
414
|
*/
|
|
415
|
-
deleteAccount(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
415
|
+
deleteAccount(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
416
416
|
return localVarFp.deleteAccount(code, authorization, options).then((request) => request(axios, basePath));
|
|
417
417
|
},
|
|
418
418
|
/**
|
|
@@ -420,11 +420,11 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
|
|
|
420
420
|
* @summary Retrieve the account
|
|
421
421
|
* @param {string} code Unique identifier for the object.
|
|
422
422
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
423
|
-
* @param {
|
|
423
|
+
* @param {'policies'} [expand]
|
|
424
424
|
* @param {*} [options] Override http request option.
|
|
425
425
|
* @throws {RequiredError}
|
|
426
426
|
*/
|
|
427
|
-
getAccount(code: string, authorization?: string, expand?:
|
|
427
|
+
getAccount(code: string, authorization?: string, expand?: 'policies', options?: any): AxiosPromise<GetAccountResponseClass> {
|
|
428
428
|
return localVarFp.getAccount(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
429
429
|
},
|
|
430
430
|
/**
|
|
@@ -433,14 +433,14 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
|
|
|
433
433
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
434
434
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
435
435
|
* @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.
|
|
436
|
-
* @param {
|
|
436
|
+
* @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
437
|
* @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.
|
|
438
|
-
* @param {
|
|
439
|
-
* @param {
|
|
438
|
+
* @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
|
+
* @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.
|
|
440
440
|
* @param {*} [options] Override http request option.
|
|
441
441
|
* @throws {RequiredError}
|
|
442
442
|
*/
|
|
443
|
-
listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
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
444
|
return localVarFp.listAccounts(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
445
445
|
},
|
|
446
446
|
/**
|
|
@@ -521,11 +521,11 @@ export interface AccountsApiGetAccountRequest {
|
|
|
521
521
|
readonly authorization?: string
|
|
522
522
|
|
|
523
523
|
/**
|
|
524
|
-
*
|
|
525
|
-
* @type {
|
|
524
|
+
*
|
|
525
|
+
* @type {'policies'}
|
|
526
526
|
* @memberof AccountsApiGetAccount
|
|
527
527
|
*/
|
|
528
|
-
readonly expand?:
|
|
528
|
+
readonly expand?: 'policies'
|
|
529
529
|
}
|
|
530
530
|
|
|
531
531
|
/**
|
|
@@ -557,10 +557,10 @@ export interface AccountsApiListAccountsRequest {
|
|
|
557
557
|
|
|
558
558
|
/**
|
|
559
559
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
560
|
-
* @type {
|
|
560
|
+
* @type {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'}
|
|
561
561
|
* @memberof AccountsApiListAccounts
|
|
562
562
|
*/
|
|
563
|
-
readonly filter?:
|
|
563
|
+
readonly filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'
|
|
564
564
|
|
|
565
565
|
/**
|
|
566
566
|
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
@@ -571,17 +571,17 @@ export interface AccountsApiListAccountsRequest {
|
|
|
571
571
|
|
|
572
572
|
/**
|
|
573
573
|
* 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.
|
|
574
|
-
* @type {
|
|
574
|
+
* @type {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'}
|
|
575
575
|
* @memberof AccountsApiListAccounts
|
|
576
576
|
*/
|
|
577
|
-
readonly order?:
|
|
577
|
+
readonly order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'
|
|
578
578
|
|
|
579
579
|
/**
|
|
580
580
|
* 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.
|
|
581
|
-
* @type {
|
|
581
|
+
* @type {'policies'}
|
|
582
582
|
* @memberof AccountsApiListAccounts
|
|
583
583
|
*/
|
|
584
|
-
readonly expand?:
|
|
584
|
+
readonly expand?: 'policies'
|
|
585
585
|
}
|
|
586
586
|
|
|
587
587
|
/**
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL AccountService
|
|
5
|
+
* The EMIL AccountService API description
|
|
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 { InlineResponse200 } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { InlineResponse503 } from '../models';
|
|
27
|
+
// URLSearchParams not necessarily used
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import { URL, URLSearchParams } from 'url';
|
|
30
|
+
const FormData = require('form-data');
|
|
31
|
+
/**
|
|
32
|
+
* DefaultApi - axios parameter creator
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
|
+
return {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43
|
+
const localVarPath = `/accountservice/health`;
|
|
44
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46
|
+
let baseOptions;
|
|
47
|
+
let baseAccessToken;
|
|
48
|
+
if (configuration) {
|
|
49
|
+
baseOptions = configuration.baseOptions;
|
|
50
|
+
baseAccessToken = configuration.accessToken;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
54
|
+
const localVarHeaderParameter = {} as any;
|
|
55
|
+
const localVarQueryParameter = {} as any;
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
61
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
62
|
+
|
|
63
|
+
return {
|
|
64
|
+
url: toPathString(localVarUrlObj),
|
|
65
|
+
options: localVarRequestOptions,
|
|
66
|
+
};
|
|
67
|
+
},
|
|
68
|
+
}
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* DefaultApi - functional programming interface
|
|
73
|
+
* @export
|
|
74
|
+
*/
|
|
75
|
+
export const DefaultApiFp = function(configuration?: Configuration) {
|
|
76
|
+
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
|
|
77
|
+
return {
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
async check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
|
|
84
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.check(options);
|
|
85
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
86
|
+
},
|
|
87
|
+
}
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* DefaultApi - factory interface
|
|
92
|
+
* @export
|
|
93
|
+
*/
|
|
94
|
+
export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
95
|
+
const localVarFp = DefaultApiFp(configuration)
|
|
96
|
+
return {
|
|
97
|
+
/**
|
|
98
|
+
*
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
check(options?: any): AxiosPromise<InlineResponse200> {
|
|
103
|
+
return localVarFp.check(options).then((request) => request(axios, basePath));
|
|
104
|
+
},
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* DefaultApi - object-oriented interface
|
|
110
|
+
* @export
|
|
111
|
+
* @class DefaultApi
|
|
112
|
+
* @extends {BaseAPI}
|
|
113
|
+
*/
|
|
114
|
+
export class DefaultApi extends BaseAPI {
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
* @memberof DefaultApi
|
|
120
|
+
*/
|
|
121
|
+
public check(options?: AxiosRequestConfig) {
|
|
122
|
+
return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
123
|
+
}
|
|
124
|
+
}
|
package/api.ts
CHANGED
|
@@ -25,7 +25,9 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
27
27
|
import { AccountsApi } from './api';
|
|
28
|
+
import { DefaultApi } from './api';
|
|
28
29
|
|
|
29
30
|
|
|
30
31
|
export * from './api/accounts-api';
|
|
32
|
+
export * from './api/default-api';
|
|
31
33
|
|
|
@@ -46,25 +46,25 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
46
46
|
* @summary Retrieve the account
|
|
47
47
|
* @param {string} code Unique identifier for the object.
|
|
48
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
49
|
-
* @param {
|
|
49
|
+
* @param {'policies'} [expand]
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
52
52
|
*/
|
|
53
|
-
getAccount: (code: string, authorization?: string, expand?:
|
|
53
|
+
getAccount: (code: string, authorization?: string, expand?: 'policies', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
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
56
|
* @summary List accounts
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
59
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
60
|
-
* @param {
|
|
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
61
|
* @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.
|
|
62
|
-
* @param {
|
|
63
|
-
* @param {
|
|
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
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
67
|
-
listAccounts: (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
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
68
|
/**
|
|
69
69
|
* Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
70
70
|
* @summary Update the account
|
|
@@ -98,31 +98,31 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
101
|
-
deleteAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
101
|
+
deleteAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
102
102
|
/**
|
|
103
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
104
|
* @summary Retrieve the account
|
|
105
105
|
* @param {string} code Unique identifier for the object.
|
|
106
106
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
107
|
-
* @param {
|
|
107
|
+
* @param {'policies'} [expand]
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
109
109
|
* @throws {RequiredError}
|
|
110
110
|
*/
|
|
111
|
-
getAccount(code: string, authorization?: string, expand?:
|
|
111
|
+
getAccount(code: string, authorization?: string, expand?: 'policies', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponseClass>>;
|
|
112
112
|
/**
|
|
113
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
114
|
* @summary List accounts
|
|
115
115
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
116
116
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
117
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
118
|
-
* @param {
|
|
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
119
|
* @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.
|
|
120
|
-
* @param {
|
|
121
|
-
* @param {
|
|
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
122
|
* @param {*} [options] Override http request option.
|
|
123
123
|
* @throws {RequiredError}
|
|
124
124
|
*/
|
|
125
|
-
listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
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
126
|
/**
|
|
127
127
|
* Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
128
128
|
* @summary Update the account
|
|
@@ -156,31 +156,31 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
157
157
|
* @throws {RequiredError}
|
|
158
158
|
*/
|
|
159
|
-
deleteAccount(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
159
|
+
deleteAccount(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
160
160
|
/**
|
|
161
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
162
|
* @summary Retrieve the account
|
|
163
163
|
* @param {string} code Unique identifier for the object.
|
|
164
164
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
165
|
-
* @param {
|
|
165
|
+
* @param {'policies'} [expand]
|
|
166
166
|
* @param {*} [options] Override http request option.
|
|
167
167
|
* @throws {RequiredError}
|
|
168
168
|
*/
|
|
169
|
-
getAccount(code: string, authorization?: string, expand?:
|
|
169
|
+
getAccount(code: string, authorization?: string, expand?: 'policies', options?: any): AxiosPromise<GetAccountResponseClass>;
|
|
170
170
|
/**
|
|
171
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
172
|
* @summary List accounts
|
|
173
173
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
174
174
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
175
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
176
|
-
* @param {
|
|
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
177
|
* @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.
|
|
178
|
-
* @param {
|
|
179
|
-
* @param {
|
|
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
180
|
* @param {*} [options] Override http request option.
|
|
181
181
|
* @throws {RequiredError}
|
|
182
182
|
*/
|
|
183
|
-
listAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
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
184
|
/**
|
|
185
185
|
* Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
186
186
|
* @summary Update the account
|
|
@@ -249,11 +249,11 @@ export interface AccountsApiGetAccountRequest {
|
|
|
249
249
|
*/
|
|
250
250
|
readonly authorization?: string;
|
|
251
251
|
/**
|
|
252
|
-
*
|
|
253
|
-
* @type {
|
|
252
|
+
*
|
|
253
|
+
* @type {'policies'}
|
|
254
254
|
* @memberof AccountsApiGetAccount
|
|
255
255
|
*/
|
|
256
|
-
readonly expand?:
|
|
256
|
+
readonly expand?: 'policies';
|
|
257
257
|
}
|
|
258
258
|
/**
|
|
259
259
|
* Request parameters for listAccounts operation in AccountsApi.
|
|
@@ -281,10 +281,10 @@ export interface AccountsApiListAccountsRequest {
|
|
|
281
281
|
readonly pageToken?: any;
|
|
282
282
|
/**
|
|
283
283
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
284
|
-
* @type {
|
|
284
|
+
* @type {'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName'}
|
|
285
285
|
* @memberof AccountsApiListAccounts
|
|
286
286
|
*/
|
|
287
|
-
readonly filter?:
|
|
287
|
+
readonly filter?: 'firstName' | 'code' | 'email' | 'createdAt' | 'birthDate' | 'accountNumber' | 'title' | 'lastName' | 'gender' | 'street' | 'houseNumber' | 'zipCode' | 'city' | 'phone' | 'type' | 'companyName';
|
|
288
288
|
/**
|
|
289
289
|
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
290
290
|
* @type {any}
|
|
@@ -293,16 +293,16 @@ export interface AccountsApiListAccountsRequest {
|
|
|
293
293
|
readonly search?: any;
|
|
294
294
|
/**
|
|
295
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 {
|
|
296
|
+
* @type {'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber'}
|
|
297
297
|
* @memberof AccountsApiListAccounts
|
|
298
298
|
*/
|
|
299
|
-
readonly order?:
|
|
299
|
+
readonly order?: 'id' | 'firstName' | 'lastName' | 'email' | 'createdAt' | 'accountNumber';
|
|
300
300
|
/**
|
|
301
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 {
|
|
302
|
+
* @type {'policies'}
|
|
303
303
|
* @memberof AccountsApiListAccounts
|
|
304
304
|
*/
|
|
305
|
-
readonly expand?:
|
|
305
|
+
readonly expand?: 'policies';
|
|
306
306
|
}
|
|
307
307
|
/**
|
|
308
308
|
* Request parameters for updateAccount operation in AccountsApi.
|
|
@@ -353,7 +353,7 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
353
353
|
* @throws {RequiredError}
|
|
354
354
|
* @memberof AccountsApi
|
|
355
355
|
*/
|
|
356
|
-
deleteAccount(requestParameters: AccountsApiDeleteAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
356
|
+
deleteAccount(requestParameters: AccountsApiDeleteAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
357
357
|
/**
|
|
358
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
359
|
* @summary Retrieve the account
|
package/dist/api/accounts-api.js
CHANGED
|
@@ -198,7 +198,7 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
198
198
|
* @summary Retrieve the account
|
|
199
199
|
* @param {string} code Unique identifier for the object.
|
|
200
200
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
201
|
-
* @param {
|
|
201
|
+
* @param {'policies'} [expand]
|
|
202
202
|
* @param {*} [options] Override http request option.
|
|
203
203
|
* @throws {RequiredError}
|
|
204
204
|
*/
|
|
@@ -251,10 +251,10 @@ var AccountsApiAxiosParamCreator = function (configuration) {
|
|
|
251
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
252
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
253
253
|
* @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.
|
|
254
|
-
* @param {
|
|
254
|
+
* @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.
|
|
255
255
|
* @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.
|
|
256
|
-
* @param {
|
|
257
|
-
* @param {
|
|
256
|
+
* @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.
|
|
257
|
+
* @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.
|
|
258
258
|
* @param {*} [options] Override http request option.
|
|
259
259
|
* @throws {RequiredError}
|
|
260
260
|
*/
|
|
@@ -423,7 +423,7 @@ var AccountsApiFp = function (configuration) {
|
|
|
423
423
|
* @summary Retrieve the account
|
|
424
424
|
* @param {string} code Unique identifier for the object.
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
426
|
-
* @param {
|
|
426
|
+
* @param {'policies'} [expand]
|
|
427
427
|
* @param {*} [options] Override http request option.
|
|
428
428
|
* @throws {RequiredError}
|
|
429
429
|
*/
|
|
@@ -446,10 +446,10 @@ var AccountsApiFp = function (configuration) {
|
|
|
446
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
447
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
448
448
|
* @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.
|
|
449
|
-
* @param {
|
|
449
|
+
* @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.
|
|
450
450
|
* @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.
|
|
451
|
-
* @param {
|
|
452
|
-
* @param {
|
|
451
|
+
* @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.
|
|
452
|
+
* @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.
|
|
453
453
|
* @param {*} [options] Override http request option.
|
|
454
454
|
* @throws {RequiredError}
|
|
455
455
|
*/
|
|
@@ -525,7 +525,7 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
525
525
|
* @summary Retrieve the account
|
|
526
526
|
* @param {string} code Unique identifier for the object.
|
|
527
527
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
528
|
-
* @param {
|
|
528
|
+
* @param {'policies'} [expand]
|
|
529
529
|
* @param {*} [options] Override http request option.
|
|
530
530
|
* @throws {RequiredError}
|
|
531
531
|
*/
|
|
@@ -538,10 +538,10 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
538
538
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
539
539
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
540
540
|
* @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.
|
|
541
|
-
* @param {
|
|
541
|
+
* @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.
|
|
542
542
|
* @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.
|
|
543
|
-
* @param {
|
|
544
|
-
* @param {
|
|
543
|
+
* @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.
|
|
544
|
+
* @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.
|
|
545
545
|
* @param {*} [options] Override http request option.
|
|
546
546
|
* @throws {RequiredError}
|
|
547
547
|
*/
|