@emilgroup/tenant-sdk-node 1.15.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 +0 -1
- package/README.md +2 -2
- package/api/custom-schema-api.ts +36 -22
- package/api/data-report-api.ts +50 -36
- 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/configuration.ts +1 -1
- 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/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/configuration.js +0 -7
- 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 +37 -4
- 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 -1
- package/dist/models/index.js +0 -1
- 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 +38 -5
- 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 -1
- 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 +1 -1
- 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/set-user-setting-response-class.ts +0 -42
|
@@ -33,19 +33,20 @@ const FormData = require('form-data');
|
|
|
33
33
|
export const ListOrganizationInvitationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* Returns a list of organization invitations you have previously created.
|
|
36
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
37
37
|
* @summary List organization invitations
|
|
38
38
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
39
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
39
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
40
40
|
* @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.
|
|
41
41
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
42
|
-
* @param {any} [search]
|
|
42
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
43
43
|
* @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.
|
|
44
44
|
* @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.
|
|
45
|
+
* @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.
|
|
45
46
|
* @param {*} [options] Override http request option.
|
|
46
47
|
* @throws {RequiredError}
|
|
47
48
|
*/
|
|
48
|
-
listOrgInvitations: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
49
|
+
listOrgInvitations: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
49
50
|
const localVarPath = `/tenantservice/v1/invitations/organizations`;
|
|
50
51
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51
52
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -88,6 +89,10 @@ export const ListOrganizationInvitationsApiAxiosParamCreator = function (configu
|
|
|
88
89
|
localVarQueryParameter['expand'] = expand;
|
|
89
90
|
}
|
|
90
91
|
|
|
92
|
+
if (filters !== undefined) {
|
|
93
|
+
localVarQueryParameter['filters'] = filters;
|
|
94
|
+
}
|
|
95
|
+
|
|
91
96
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
92
97
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
93
98
|
}
|
|
@@ -114,20 +119,21 @@ export const ListOrganizationInvitationsApiFp = function(configuration?: Configu
|
|
|
114
119
|
const localVarAxiosParamCreator = ListOrganizationInvitationsApiAxiosParamCreator(configuration)
|
|
115
120
|
return {
|
|
116
121
|
/**
|
|
117
|
-
* Returns a list of organization invitations you have previously created.
|
|
122
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
118
123
|
* @summary List organization invitations
|
|
119
124
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
120
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
125
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
121
126
|
* @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.
|
|
122
127
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
123
|
-
* @param {any} [search]
|
|
128
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
124
129
|
* @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.
|
|
125
130
|
* @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.
|
|
131
|
+
* @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.
|
|
126
132
|
* @param {*} [options] Override http request option.
|
|
127
133
|
* @throws {RequiredError}
|
|
128
134
|
*/
|
|
129
|
-
async listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrgInvitationsResponseClass>> {
|
|
130
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
135
|
+
async listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrgInvitationsResponseClass>> {
|
|
136
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
131
137
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
132
138
|
},
|
|
133
139
|
}
|
|
@@ -141,20 +147,21 @@ export const ListOrganizationInvitationsApiFactory = function (configuration?: C
|
|
|
141
147
|
const localVarFp = ListOrganizationInvitationsApiFp(configuration)
|
|
142
148
|
return {
|
|
143
149
|
/**
|
|
144
|
-
* Returns a list of organization invitations you have previously created.
|
|
150
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
145
151
|
* @summary List organization invitations
|
|
146
152
|
* @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
|
|
153
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
148
154
|
* @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
155
|
* @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]
|
|
156
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
151
157
|
* @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
158
|
* @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.
|
|
159
|
+
* @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
160
|
* @param {*} [options] Override http request option.
|
|
154
161
|
* @throws {RequiredError}
|
|
155
162
|
*/
|
|
156
|
-
listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListOrgInvitationsResponseClass> {
|
|
157
|
-
return localVarFp.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
163
|
+
listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListOrgInvitationsResponseClass> {
|
|
164
|
+
return localVarFp.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
158
165
|
},
|
|
159
166
|
};
|
|
160
167
|
};
|
|
@@ -173,7 +180,7 @@ export interface ListOrganizationInvitationsApiListOrgInvitationsRequest {
|
|
|
173
180
|
readonly authorization?: string
|
|
174
181
|
|
|
175
182
|
/**
|
|
176
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
183
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
184
|
* @type {any}
|
|
178
185
|
* @memberof ListOrganizationInvitationsApiListOrgInvitations
|
|
179
186
|
*/
|
|
@@ -194,7 +201,7 @@ export interface ListOrganizationInvitationsApiListOrgInvitationsRequest {
|
|
|
194
201
|
readonly filter?: any
|
|
195
202
|
|
|
196
203
|
/**
|
|
197
|
-
*
|
|
204
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
198
205
|
* @type {any}
|
|
199
206
|
* @memberof ListOrganizationInvitationsApiListOrgInvitations
|
|
200
207
|
*/
|
|
@@ -213,6 +220,13 @@ export interface ListOrganizationInvitationsApiListOrgInvitationsRequest {
|
|
|
213
220
|
* @memberof ListOrganizationInvitationsApiListOrgInvitations
|
|
214
221
|
*/
|
|
215
222
|
readonly expand?: any
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* 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.
|
|
226
|
+
* @type {any}
|
|
227
|
+
* @memberof ListOrganizationInvitationsApiListOrgInvitations
|
|
228
|
+
*/
|
|
229
|
+
readonly filters?: any
|
|
216
230
|
}
|
|
217
231
|
|
|
218
232
|
/**
|
|
@@ -223,7 +237,7 @@ export interface ListOrganizationInvitationsApiListOrgInvitationsRequest {
|
|
|
223
237
|
*/
|
|
224
238
|
export class ListOrganizationInvitationsApi extends BaseAPI {
|
|
225
239
|
/**
|
|
226
|
-
* Returns a list of organization invitations you have previously created.
|
|
240
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
227
241
|
* @summary List organization invitations
|
|
228
242
|
* @param {ListOrganizationInvitationsApiListOrgInvitationsRequest} requestParameters Request parameters.
|
|
229
243
|
* @param {*} [options] Override http request option.
|
|
@@ -231,6 +245,6 @@ export class ListOrganizationInvitationsApi extends BaseAPI {
|
|
|
231
245
|
* @memberof ListOrganizationInvitationsApi
|
|
232
246
|
*/
|
|
233
247
|
public listOrgInvitations(requestParameters: ListOrganizationInvitationsApiListOrgInvitationsRequest = {}, options?: AxiosRequestConfig) {
|
|
234
|
-
return ListOrganizationInvitationsApiFp(this.configuration).listOrgInvitations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
248
|
+
return ListOrganizationInvitationsApiFp(this.configuration).listOrgInvitations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
235
249
|
}
|
|
236
250
|
}
|
package/api/organizations-api.ts
CHANGED
|
@@ -87,16 +87,17 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
87
87
|
* This will fetch list of organizations
|
|
88
88
|
* @summary List organizations
|
|
89
89
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
90
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
90
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
91
91
|
* @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.
|
|
92
92
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
93
|
-
* @param {any} [search]
|
|
93
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
94
94
|
* @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.
|
|
95
95
|
* @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.
|
|
96
|
+
* @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.
|
|
96
97
|
* @param {*} [options] Override http request option.
|
|
97
98
|
* @throws {RequiredError}
|
|
98
99
|
*/
|
|
99
|
-
listOrganizations: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
100
|
+
listOrganizations: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
100
101
|
const localVarPath = `/tenantservice/v1/organizations`;
|
|
101
102
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
102
103
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -139,6 +140,10 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
139
140
|
localVarQueryParameter['expand'] = expand;
|
|
140
141
|
}
|
|
141
142
|
|
|
143
|
+
if (filters !== undefined) {
|
|
144
|
+
localVarQueryParameter['filters'] = filters;
|
|
145
|
+
}
|
|
146
|
+
|
|
142
147
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
143
148
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
144
149
|
}
|
|
@@ -231,17 +236,18 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
231
236
|
* This will fetch list of organizations
|
|
232
237
|
* @summary List organizations
|
|
233
238
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
234
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
239
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
235
240
|
* @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.
|
|
236
241
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
237
|
-
* @param {any} [search]
|
|
242
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
238
243
|
* @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.
|
|
239
244
|
* @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.
|
|
245
|
+
* @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.
|
|
240
246
|
* @param {*} [options] Override http request option.
|
|
241
247
|
* @throws {RequiredError}
|
|
242
248
|
*/
|
|
243
|
-
async listOrganizations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrganizationsResponseClass>> {
|
|
244
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
249
|
+
async listOrganizations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrganizationsResponseClass>> {
|
|
250
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
245
251
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
246
252
|
},
|
|
247
253
|
/**
|
|
@@ -282,17 +288,18 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
282
288
|
* This will fetch list of organizations
|
|
283
289
|
* @summary List organizations
|
|
284
290
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
285
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
291
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
286
292
|
* @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.
|
|
287
293
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
288
|
-
* @param {any} [search]
|
|
294
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
289
295
|
* @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.
|
|
290
296
|
* @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.
|
|
297
|
+
* @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.
|
|
291
298
|
* @param {*} [options] Override http request option.
|
|
292
299
|
* @throws {RequiredError}
|
|
293
300
|
*/
|
|
294
|
-
listOrganizations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListOrganizationsResponseClass> {
|
|
295
|
-
return localVarFp.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
301
|
+
listOrganizations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListOrganizationsResponseClass> {
|
|
302
|
+
return localVarFp.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
296
303
|
},
|
|
297
304
|
/**
|
|
298
305
|
* Update organization data
|
|
@@ -344,7 +351,7 @@ export interface OrganizationsApiListOrganizationsRequest {
|
|
|
344
351
|
readonly authorization?: string
|
|
345
352
|
|
|
346
353
|
/**
|
|
347
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
354
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
348
355
|
* @type {any}
|
|
349
356
|
* @memberof OrganizationsApiListOrganizations
|
|
350
357
|
*/
|
|
@@ -365,7 +372,7 @@ export interface OrganizationsApiListOrganizationsRequest {
|
|
|
365
372
|
readonly filter?: any
|
|
366
373
|
|
|
367
374
|
/**
|
|
368
|
-
*
|
|
375
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
369
376
|
* @type {any}
|
|
370
377
|
* @memberof OrganizationsApiListOrganizations
|
|
371
378
|
*/
|
|
@@ -384,6 +391,13 @@ export interface OrganizationsApiListOrganizationsRequest {
|
|
|
384
391
|
* @memberof OrganizationsApiListOrganizations
|
|
385
392
|
*/
|
|
386
393
|
readonly expand?: any
|
|
394
|
+
|
|
395
|
+
/**
|
|
396
|
+
* 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.
|
|
397
|
+
* @type {any}
|
|
398
|
+
* @memberof OrganizationsApiListOrganizations
|
|
399
|
+
*/
|
|
400
|
+
readonly filters?: any
|
|
387
401
|
}
|
|
388
402
|
|
|
389
403
|
/**
|
|
@@ -442,7 +456,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
442
456
|
* @memberof OrganizationsApi
|
|
443
457
|
*/
|
|
444
458
|
public listOrganizations(requestParameters: OrganizationsApiListOrganizationsRequest = {}, options?: AxiosRequestConfig) {
|
|
445
|
-
return OrganizationsApiFp(this.configuration).listOrganizations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
459
|
+
return OrganizationsApiFp(this.configuration).listOrganizations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
446
460
|
}
|
|
447
461
|
|
|
448
462
|
/**
|
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/configuration.ts
CHANGED
|
@@ -50,7 +50,7 @@ export class Configuration {
|
|
|
50
50
|
* @param scopes oauth2 scope
|
|
51
51
|
* @memberof Configuration
|
|
52
52
|
*/
|
|
53
|
-
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>)
|
|
53
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
54
54
|
/**
|
|
55
55
|
* override base path
|
|
56
56
|
*
|