@emilgroup/tenant-sdk-node 1.9.0 → 1.15.1-beta.2
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 +1 -2
- package/README.md +2 -2
- package/api/custom-schema-api.ts +36 -22
- package/api/data-report-api.ts +50 -36
- package/api/delete-organization-invitations-api.ts +165 -0
- package/api/invite-users-api.ts +32 -18
- package/api/list-organization-invitations-api.ts +32 -18
- package/api/organizations-api.ts +28 -14
- package/api/roles-api.ts +22 -22
- package/api/settings-api.ts +4 -4
- package/api/users-api.ts +32 -18
- package/api.ts +2 -0
- package/dist/api/custom-schema-api.d.ts +28 -19
- package/dist/api/custom-schema-api.js +26 -20
- package/dist/api/data-report-api.d.ts +38 -29
- package/dist/api/data-report-api.js +35 -29
- package/dist/api/delete-organization-invitations-api.d.ts +96 -0
- package/dist/api/delete-organization-invitations-api.js +227 -0
- package/dist/api/invite-users-api.d.ts +24 -15
- package/dist/api/invite-users-api.js +22 -16
- package/dist/api/list-organization-invitations-api.d.ts +24 -15
- package/dist/api/list-organization-invitations-api.js +22 -16
- package/dist/api/organizations-api.d.ts +20 -11
- package/dist/api/organizations-api.js +18 -12
- package/dist/api/roles-api.d.ts +22 -22
- package/dist/api/roles-api.js +13 -13
- package/dist/api/settings-api.d.ts +4 -4
- package/dist/api/settings-api.js +4 -4
- package/dist/api/users-api.d.ts +24 -15
- package/dist/api/users-api.js +22 -16
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/batch-delete-request-dto.d.ts +2 -2
- package/dist/models/create-data-report-request-dto.d.ts +1 -1
- package/dist/models/create-role-request-dto.d.ts +2 -2
- package/dist/models/custom-field-dto.d.ts +43 -11
- package/dist/models/custom-field-dto.js +5 -2
- package/dist/models/data-report-class.d.ts +1 -1
- package/dist/models/disable-users-request-dto.d.ts +2 -2
- package/dist/models/enable-users-request-dto.d.ts +2 -2
- package/dist/models/index.d.ts +0 -2
- package/dist/models/index.js +0 -2
- package/dist/models/inline-response200.d.ts +6 -6
- package/dist/models/inline-response503.d.ts +6 -6
- package/dist/models/invite-class.d.ts +7 -0
- package/dist/models/invite-org-request-dto.d.ts +1 -1
- package/dist/models/invite-users-request-dto.d.ts +6 -0
- package/dist/models/run-data-report-response-class.d.ts +2 -2
- package/dist/models/update-data-report-request-dto.d.ts +1 -1
- package/dist/models/update-role-request-dto.d.ts +2 -2
- package/dist/models/user-class.d.ts +7 -6
- package/models/batch-delete-request-dto.ts +2 -2
- package/models/create-data-report-request-dto.ts +1 -1
- package/models/create-role-request-dto.ts +2 -2
- package/models/custom-field-dto.ts +44 -12
- package/models/data-report-class.ts +1 -1
- package/models/disable-users-request-dto.ts +2 -2
- package/models/enable-users-request-dto.ts +2 -2
- package/models/index.ts +0 -2
- package/models/inline-response200.ts +6 -6
- package/models/inline-response503.ts +6 -6
- package/models/invite-class.ts +7 -0
- package/models/invite-org-request-dto.ts +1 -1
- package/models/invite-users-request-dto.ts +6 -0
- package/models/run-data-report-response-class.ts +2 -2
- package/models/update-data-report-request-dto.ts +1 -1
- package/models/update-role-request-dto.ts +2 -2
- package/models/user-class.ts +7 -6
- package/package.json +2 -2
- package/dist/models/custom-field-option-dto.d.ts +0 -30
- package/dist/models/custom-field-option-dto.js +0 -15
- package/dist/models/set-user-setting-response-class.d.ts +0 -36
- package/dist/models/set-user-setting-response-class.js +0 -15
- package/models/custom-field-option-dto.ts +0 -36
- package/models/set-user-setting-response-class.ts +0 -42
package/api/roles-api.ts
CHANGED
|
@@ -33,19 +33,19 @@ const FormData = require('form-data');
|
|
|
33
33
|
export const RolesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* Returns a list of roles you have previously created.
|
|
36
|
+
* Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
37
37
|
* @summary List roles
|
|
38
38
|
* @param {string} [authorization] Bearer Token
|
|
39
39
|
* @param {number} [pageSize] Page size
|
|
40
40
|
* @param {string} [pageToken] Page token
|
|
41
|
-
* @param {
|
|
41
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
42
42
|
* @param {string} [search] Search query
|
|
43
|
-
* @param {
|
|
44
|
-
* @param {
|
|
43
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
44
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
45
45
|
* @param {*} [options] Override http request option.
|
|
46
46
|
* @throws {RequiredError}
|
|
47
47
|
*/
|
|
48
|
-
listRoles: async (authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
48
|
+
listRoles: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
49
49
|
const localVarPath = `/tenantservice/v1/roles`;
|
|
50
50
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51
51
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -114,19 +114,19 @@ export const RolesApiFp = function(configuration?: Configuration) {
|
|
|
114
114
|
const localVarAxiosParamCreator = RolesApiAxiosParamCreator(configuration)
|
|
115
115
|
return {
|
|
116
116
|
/**
|
|
117
|
-
* Returns a list of roles you have previously created.
|
|
117
|
+
* Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
118
118
|
* @summary List roles
|
|
119
119
|
* @param {string} [authorization] Bearer Token
|
|
120
120
|
* @param {number} [pageSize] Page size
|
|
121
121
|
* @param {string} [pageToken] Page token
|
|
122
|
-
* @param {
|
|
122
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
123
123
|
* @param {string} [search] Search query
|
|
124
|
-
* @param {
|
|
125
|
-
* @param {
|
|
124
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
125
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
126
126
|
* @param {*} [options] Override http request option.
|
|
127
127
|
* @throws {RequiredError}
|
|
128
128
|
*/
|
|
129
|
-
async listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
129
|
+
async listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesResponseClass>> {
|
|
130
130
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
131
131
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
132
132
|
},
|
|
@@ -141,19 +141,19 @@ export const RolesApiFactory = function (configuration?: Configuration, basePath
|
|
|
141
141
|
const localVarFp = RolesApiFp(configuration)
|
|
142
142
|
return {
|
|
143
143
|
/**
|
|
144
|
-
* Returns a list of roles you have previously created.
|
|
144
|
+
* Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
145
145
|
* @summary List roles
|
|
146
146
|
* @param {string} [authorization] Bearer Token
|
|
147
147
|
* @param {number} [pageSize] Page size
|
|
148
148
|
* @param {string} [pageToken] Page token
|
|
149
|
-
* @param {
|
|
149
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
150
150
|
* @param {string} [search] Search query
|
|
151
|
-
* @param {
|
|
152
|
-
* @param {
|
|
151
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
152
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
153
153
|
* @param {*} [options] Override http request option.
|
|
154
154
|
* @throws {RequiredError}
|
|
155
155
|
*/
|
|
156
|
-
listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
156
|
+
listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListRolesResponseClass> {
|
|
157
157
|
return localVarFp.listRoles(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
158
158
|
},
|
|
159
159
|
};
|
|
@@ -188,10 +188,10 @@ export interface RolesApiListRolesRequest {
|
|
|
188
188
|
|
|
189
189
|
/**
|
|
190
190
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
191
|
-
* @type {
|
|
191
|
+
* @type {string}
|
|
192
192
|
* @memberof RolesApiListRoles
|
|
193
193
|
*/
|
|
194
|
-
readonly filter?:
|
|
194
|
+
readonly filter?: string
|
|
195
195
|
|
|
196
196
|
/**
|
|
197
197
|
* Search query
|
|
@@ -202,17 +202,17 @@ export interface RolesApiListRolesRequest {
|
|
|
202
202
|
|
|
203
203
|
/**
|
|
204
204
|
* Order allowing you to specify the desired order of entities retrieved from the server.
|
|
205
|
-
* @type {
|
|
205
|
+
* @type {string}
|
|
206
206
|
* @memberof RolesApiListRoles
|
|
207
207
|
*/
|
|
208
|
-
readonly order?:
|
|
208
|
+
readonly order?: string
|
|
209
209
|
|
|
210
210
|
/**
|
|
211
211
|
* You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
212
|
-
* @type {
|
|
212
|
+
* @type {string}
|
|
213
213
|
* @memberof RolesApiListRoles
|
|
214
214
|
*/
|
|
215
|
-
readonly expand?:
|
|
215
|
+
readonly expand?: string
|
|
216
216
|
}
|
|
217
217
|
|
|
218
218
|
/**
|
|
@@ -223,7 +223,7 @@ export interface RolesApiListRolesRequest {
|
|
|
223
223
|
*/
|
|
224
224
|
export class RolesApi extends BaseAPI {
|
|
225
225
|
/**
|
|
226
|
-
* Returns a list of roles you have previously created.
|
|
226
|
+
* Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
227
227
|
* @summary List roles
|
|
228
228
|
* @param {RolesApiListRolesRequest} requestParameters Request parameters.
|
|
229
229
|
* @param {*} [options] Override http request option.
|
package/api/settings-api.ts
CHANGED
|
@@ -33,7 +33,7 @@ const FormData = require('form-data');
|
|
|
33
33
|
export const SettingsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
36
|
+
* Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
|
|
37
37
|
* @summary Retrieve the settings
|
|
38
38
|
* @param {string} keys
|
|
39
39
|
* @param {string} [authorization] Bearer Token
|
|
@@ -91,7 +91,7 @@ export const SettingsApiFp = function(configuration?: Configuration) {
|
|
|
91
91
|
const localVarAxiosParamCreator = SettingsApiAxiosParamCreator(configuration)
|
|
92
92
|
return {
|
|
93
93
|
/**
|
|
94
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
94
|
+
* Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
|
|
95
95
|
* @summary Retrieve the settings
|
|
96
96
|
* @param {string} keys
|
|
97
97
|
* @param {string} [authorization] Bearer Token
|
|
@@ -113,7 +113,7 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
|
|
|
113
113
|
const localVarFp = SettingsApiFp(configuration)
|
|
114
114
|
return {
|
|
115
115
|
/**
|
|
116
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
116
|
+
* Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
|
|
117
117
|
* @summary Retrieve the settings
|
|
118
118
|
* @param {string} keys
|
|
119
119
|
* @param {string} [authorization] Bearer Token
|
|
@@ -155,7 +155,7 @@ export interface SettingsApiGetTenantSettingsRequest {
|
|
|
155
155
|
*/
|
|
156
156
|
export class SettingsApi extends BaseAPI {
|
|
157
157
|
/**
|
|
158
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
158
|
+
* Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
|
|
159
159
|
* @summary Retrieve the settings
|
|
160
160
|
* @param {SettingsApiGetTenantSettingsRequest} requestParameters Request parameters.
|
|
161
161
|
* @param {*} [options] Override http request option.
|
package/api/users-api.ts
CHANGED
|
@@ -433,19 +433,20 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
433
433
|
};
|
|
434
434
|
},
|
|
435
435
|
/**
|
|
436
|
-
* Returns a list of users you have previously created.
|
|
436
|
+
* Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
437
437
|
* @summary List users
|
|
438
438
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
439
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
439
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
440
440
|
* @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.
|
|
441
441
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
442
|
-
* @param {any} [search]
|
|
442
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
443
443
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
444
444
|
* @param {any} [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.
|
|
445
|
+
* @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.
|
|
445
446
|
* @param {*} [options] Override http request option.
|
|
446
447
|
* @throws {RequiredError}
|
|
447
448
|
*/
|
|
448
|
-
listUsers: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
449
|
+
listUsers: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
449
450
|
const localVarPath = `/tenantservice/v1/users`;
|
|
450
451
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
451
452
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -488,6 +489,10 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
488
489
|
localVarQueryParameter['expand'] = expand;
|
|
489
490
|
}
|
|
490
491
|
|
|
492
|
+
if (filters !== undefined) {
|
|
493
|
+
localVarQueryParameter['filters'] = filters;
|
|
494
|
+
}
|
|
495
|
+
|
|
491
496
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
492
497
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
493
498
|
}
|
|
@@ -605,20 +610,21 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
605
610
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
606
611
|
},
|
|
607
612
|
/**
|
|
608
|
-
* Returns a list of users you have previously created.
|
|
613
|
+
* Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
609
614
|
* @summary List users
|
|
610
615
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
611
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
616
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
612
617
|
* @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.
|
|
613
618
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
614
|
-
* @param {any} [search]
|
|
619
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
615
620
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
616
621
|
* @param {any} [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.
|
|
622
|
+
* @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.
|
|
617
623
|
* @param {*} [options] Override http request option.
|
|
618
624
|
* @throws {RequiredError}
|
|
619
625
|
*/
|
|
620
|
-
async listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponseClass>> {
|
|
621
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
626
|
+
async listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponseClass>> {
|
|
627
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
622
628
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
623
629
|
},
|
|
624
630
|
}
|
|
@@ -715,20 +721,21 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
715
721
|
return localVarFp.getUser(code, code2, authorization, expand, options).then((request) => request(axios, basePath));
|
|
716
722
|
},
|
|
717
723
|
/**
|
|
718
|
-
* Returns a list of users you have previously created.
|
|
724
|
+
* Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
719
725
|
* @summary List users
|
|
720
726
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
721
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
727
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
722
728
|
* @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.
|
|
723
729
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
724
|
-
* @param {any} [search]
|
|
730
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
725
731
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
726
732
|
* @param {any} [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.
|
|
733
|
+
* @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.
|
|
727
734
|
* @param {*} [options] Override http request option.
|
|
728
735
|
* @throws {RequiredError}
|
|
729
736
|
*/
|
|
730
|
-
listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListUsersResponseClass> {
|
|
731
|
-
return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
737
|
+
listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListUsersResponseClass> {
|
|
738
|
+
return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
732
739
|
},
|
|
733
740
|
};
|
|
734
741
|
};
|
|
@@ -936,7 +943,7 @@ export interface UsersApiListUsersRequest {
|
|
|
936
943
|
readonly authorization?: string
|
|
937
944
|
|
|
938
945
|
/**
|
|
939
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
946
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
940
947
|
* @type {any}
|
|
941
948
|
* @memberof UsersApiListUsers
|
|
942
949
|
*/
|
|
@@ -957,7 +964,7 @@ export interface UsersApiListUsersRequest {
|
|
|
957
964
|
readonly filter?: any
|
|
958
965
|
|
|
959
966
|
/**
|
|
960
|
-
*
|
|
967
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
961
968
|
* @type {any}
|
|
962
969
|
* @memberof UsersApiListUsers
|
|
963
970
|
*/
|
|
@@ -976,6 +983,13 @@ export interface UsersApiListUsersRequest {
|
|
|
976
983
|
* @memberof UsersApiListUsers
|
|
977
984
|
*/
|
|
978
985
|
readonly expand?: any
|
|
986
|
+
|
|
987
|
+
/**
|
|
988
|
+
* 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.
|
|
989
|
+
* @type {any}
|
|
990
|
+
* @memberof UsersApiListUsers
|
|
991
|
+
*/
|
|
992
|
+
readonly filters?: any
|
|
979
993
|
}
|
|
980
994
|
|
|
981
995
|
/**
|
|
@@ -1074,7 +1088,7 @@ export class UsersApi extends BaseAPI {
|
|
|
1074
1088
|
}
|
|
1075
1089
|
|
|
1076
1090
|
/**
|
|
1077
|
-
* Returns a list of users you have previously created.
|
|
1091
|
+
* Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
1078
1092
|
* @summary List users
|
|
1079
1093
|
* @param {UsersApiListUsersRequest} requestParameters Request parameters.
|
|
1080
1094
|
* @param {*} [options] Override http request option.
|
|
@@ -1082,6 +1096,6 @@ export class UsersApi extends BaseAPI {
|
|
|
1082
1096
|
* @memberof UsersApi
|
|
1083
1097
|
*/
|
|
1084
1098
|
public listUsers(requestParameters: UsersApiListUsersRequest = {}, options?: AxiosRequestConfig) {
|
|
1085
|
-
return UsersApiFp(this.configuration).listUsers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
1099
|
+
return UsersApiFp(this.configuration).listUsers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1086
1100
|
}
|
|
1087
1101
|
}
|
package/api.ts
CHANGED
|
@@ -28,6 +28,7 @@ import { CustomSchemaApi } from './api';
|
|
|
28
28
|
import { DataReportApi } from './api';
|
|
29
29
|
import { DataReportExecutorApi } from './api';
|
|
30
30
|
import { DefaultApi } from './api';
|
|
31
|
+
import { DeleteOrganizationInvitationsApi } from './api';
|
|
31
32
|
import { InviteOrganizationsApi } from './api';
|
|
32
33
|
import { InviteUsersApi } from './api';
|
|
33
34
|
import { ListOrganizationInvitationsApi } from './api';
|
|
@@ -42,6 +43,7 @@ export * from './api/custom-schema-api';
|
|
|
42
43
|
export * from './api/data-report-api';
|
|
43
44
|
export * from './api/data-report-executor-api';
|
|
44
45
|
export * from './api/default-api';
|
|
46
|
+
export * from './api/delete-organization-invitations-api';
|
|
45
47
|
export * from './api/invite-organizations-api';
|
|
46
48
|
export * from './api/invite-users-api';
|
|
47
49
|
export * from './api/list-organization-invitations-api';
|
|
@@ -33,7 +33,7 @@ export declare const CustomSchemaApiAxiosParamCreator: (configuration?: Configur
|
|
|
33
33
|
*/
|
|
34
34
|
createCustomSchema: (createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
36
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
37
37
|
* @summary Retrieve the custom-schema
|
|
38
38
|
* @param {string} code Unique identifier for the object.
|
|
39
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -43,19 +43,20 @@ export declare const CustomSchemaApiAxiosParamCreator: (configuration?: Configur
|
|
|
43
43
|
*/
|
|
44
44
|
getCustomSchema: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* Returns a list of custom-schemas you have previously created.
|
|
46
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
47
47
|
* @summary List custom-schemas
|
|
48
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
49
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
49
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
50
50
|
* @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.
|
|
51
51
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
52
|
-
* @param {any} [search]
|
|
52
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
53
53
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
54
54
|
* @param {any} [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.
|
|
55
|
+
* @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.
|
|
55
56
|
* @param {*} [options] Override http request option.
|
|
56
57
|
* @throws {RequiredError}
|
|
57
58
|
*/
|
|
58
|
-
listCustomSchemas: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
listCustomSchemas: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
60
|
/**
|
|
60
61
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
61
62
|
* @summary Update the custom-schema
|
|
@@ -82,7 +83,7 @@ export declare const CustomSchemaApiFp: (configuration?: Configuration) => {
|
|
|
82
83
|
*/
|
|
83
84
|
createCustomSchema(createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomSchemaResponseClass>>;
|
|
84
85
|
/**
|
|
85
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
86
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
86
87
|
* @summary Retrieve the custom-schema
|
|
87
88
|
* @param {string} code Unique identifier for the object.
|
|
88
89
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -92,19 +93,20 @@ export declare const CustomSchemaApiFp: (configuration?: Configuration) => {
|
|
|
92
93
|
*/
|
|
93
94
|
getCustomSchema(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomSchemaResponseClass>>;
|
|
94
95
|
/**
|
|
95
|
-
* Returns a list of custom-schemas you have previously created.
|
|
96
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
96
97
|
* @summary List custom-schemas
|
|
97
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
98
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
99
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
99
100
|
* @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.
|
|
100
101
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
101
|
-
* @param {any} [search]
|
|
102
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
102
103
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
103
104
|
* @param {any} [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.
|
|
105
|
+
* @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.
|
|
104
106
|
* @param {*} [options] Override http request option.
|
|
105
107
|
* @throws {RequiredError}
|
|
106
108
|
*/
|
|
107
|
-
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>>;
|
|
109
|
+
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>>;
|
|
108
110
|
/**
|
|
109
111
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
110
112
|
* @summary Update the custom-schema
|
|
@@ -131,7 +133,7 @@ export declare const CustomSchemaApiFactory: (configuration?: Configuration, bas
|
|
|
131
133
|
*/
|
|
132
134
|
createCustomSchema(createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCustomSchemaResponseClass>;
|
|
133
135
|
/**
|
|
134
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
136
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
135
137
|
* @summary Retrieve the custom-schema
|
|
136
138
|
* @param {string} code Unique identifier for the object.
|
|
137
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -141,19 +143,20 @@ export declare const CustomSchemaApiFactory: (configuration?: Configuration, bas
|
|
|
141
143
|
*/
|
|
142
144
|
getCustomSchema(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCustomSchemaResponseClass>;
|
|
143
145
|
/**
|
|
144
|
-
* Returns a list of custom-schemas you have previously created.
|
|
146
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
145
147
|
* @summary List custom-schemas
|
|
146
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
149
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
148
150
|
* @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.
|
|
149
151
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
150
|
-
* @param {any} [search]
|
|
152
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
151
153
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
152
154
|
* @param {any} [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.
|
|
155
|
+
* @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.
|
|
153
156
|
* @param {*} [options] Override http request option.
|
|
154
157
|
* @throws {RequiredError}
|
|
155
158
|
*/
|
|
156
|
-
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass>;
|
|
159
|
+
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass>;
|
|
157
160
|
/**
|
|
158
161
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
159
162
|
* @summary Update the custom-schema
|
|
@@ -222,7 +225,7 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
222
225
|
*/
|
|
223
226
|
readonly authorization?: string;
|
|
224
227
|
/**
|
|
225
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
228
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
226
229
|
* @type {any}
|
|
227
230
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
228
231
|
*/
|
|
@@ -240,7 +243,7 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
240
243
|
*/
|
|
241
244
|
readonly filter?: any;
|
|
242
245
|
/**
|
|
243
|
-
*
|
|
246
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
244
247
|
* @type {any}
|
|
245
248
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
246
249
|
*/
|
|
@@ -257,6 +260,12 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
257
260
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
258
261
|
*/
|
|
259
262
|
readonly expand?: any;
|
|
263
|
+
/**
|
|
264
|
+
* 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.
|
|
265
|
+
* @type {any}
|
|
266
|
+
* @memberof CustomSchemaApiListCustomSchemas
|
|
267
|
+
*/
|
|
268
|
+
readonly filters?: any;
|
|
260
269
|
}
|
|
261
270
|
/**
|
|
262
271
|
* Request parameters for updateCustomSchema operation in CustomSchemaApi.
|
|
@@ -300,7 +309,7 @@ export declare class CustomSchemaApi extends BaseAPI {
|
|
|
300
309
|
*/
|
|
301
310
|
createCustomSchema(requestParameters: CustomSchemaApiCreateCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomSchemaResponseClass, any>>;
|
|
302
311
|
/**
|
|
303
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
312
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
304
313
|
* @summary Retrieve the custom-schema
|
|
305
314
|
* @param {CustomSchemaApiGetCustomSchemaRequest} requestParameters Request parameters.
|
|
306
315
|
* @param {*} [options] Override http request option.
|
|
@@ -309,7 +318,7 @@ export declare class CustomSchemaApi extends BaseAPI {
|
|
|
309
318
|
*/
|
|
310
319
|
getCustomSchema(requestParameters: CustomSchemaApiGetCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomSchemaResponseClass, any>>;
|
|
311
320
|
/**
|
|
312
|
-
* Returns a list of custom-schemas you have previously created.
|
|
321
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
313
322
|
* @summary List custom-schemas
|
|
314
323
|
* @param {CustomSchemaApiListCustomSchemasRequest} requestParameters Request parameters.
|
|
315
324
|
* @param {*} [options] Override http request option.
|