@emilgroup/tenant-sdk 1.9.0 → 1.15.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +161 -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/base.ts +1 -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 +223 -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/base.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 +1 -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/dist/api/roles-api.js
CHANGED
|
@@ -93,15 +93,15 @@ var RolesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Returns a list of roles you have previously created.
|
|
96
|
+
* 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.
|
|
97
97
|
* @summary List roles
|
|
98
98
|
* @param {string} [authorization] Bearer Token
|
|
99
99
|
* @param {number} [pageSize] Page size
|
|
100
100
|
* @param {string} [pageToken] Page token
|
|
101
|
-
* @param {
|
|
101
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
102
102
|
* @param {string} [search] Search query
|
|
103
|
-
* @param {
|
|
104
|
-
* @param {
|
|
103
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
104
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
106
106
|
* @throws {RequiredError}
|
|
107
107
|
*/
|
|
@@ -171,15 +171,15 @@ var RolesApiFp = function (configuration) {
|
|
|
171
171
|
var localVarAxiosParamCreator = (0, exports.RolesApiAxiosParamCreator)(configuration);
|
|
172
172
|
return {
|
|
173
173
|
/**
|
|
174
|
-
* Returns a list of roles you have previously created.
|
|
174
|
+
* 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.
|
|
175
175
|
* @summary List roles
|
|
176
176
|
* @param {string} [authorization] Bearer Token
|
|
177
177
|
* @param {number} [pageSize] Page size
|
|
178
178
|
* @param {string} [pageToken] Page token
|
|
179
|
-
* @param {
|
|
179
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
180
180
|
* @param {string} [search] Search query
|
|
181
|
-
* @param {
|
|
182
|
-
* @param {
|
|
181
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
182
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
@@ -207,15 +207,15 @@ var RolesApiFactory = function (configuration, basePath, axios) {
|
|
|
207
207
|
var localVarFp = (0, exports.RolesApiFp)(configuration);
|
|
208
208
|
return {
|
|
209
209
|
/**
|
|
210
|
-
* Returns a list of roles you have previously created.
|
|
210
|
+
* 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.
|
|
211
211
|
* @summary List roles
|
|
212
212
|
* @param {string} [authorization] Bearer Token
|
|
213
213
|
* @param {number} [pageSize] Page size
|
|
214
214
|
* @param {string} [pageToken] Page token
|
|
215
|
-
* @param {
|
|
215
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
216
216
|
* @param {string} [search] Search query
|
|
217
|
-
* @param {
|
|
218
|
-
* @param {
|
|
217
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
218
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
220
220
|
* @throws {RequiredError}
|
|
221
221
|
*/
|
|
@@ -237,7 +237,7 @@ var RolesApi = /** @class */ (function (_super) {
|
|
|
237
237
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
238
238
|
}
|
|
239
239
|
/**
|
|
240
|
-
* Returns a list of roles you have previously created.
|
|
240
|
+
* 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.
|
|
241
241
|
* @summary List roles
|
|
242
242
|
* @param {RolesApiListRolesRequest} requestParameters Request parameters.
|
|
243
243
|
* @param {*} [options] Override http request option.
|
|
@@ -19,7 +19,7 @@ import { GetSettingsResponseClass } from '../models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const SettingsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
22
|
+
* 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.
|
|
23
23
|
* @summary Retrieve the settings
|
|
24
24
|
* @param {string} keys
|
|
25
25
|
* @param {string} [authorization] Bearer Token
|
|
@@ -34,7 +34,7 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
34
34
|
*/
|
|
35
35
|
export declare const SettingsApiFp: (configuration?: Configuration) => {
|
|
36
36
|
/**
|
|
37
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
37
|
+
* 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.
|
|
38
38
|
* @summary Retrieve the settings
|
|
39
39
|
* @param {string} keys
|
|
40
40
|
* @param {string} [authorization] Bearer Token
|
|
@@ -49,7 +49,7 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
|
|
|
49
49
|
*/
|
|
50
50
|
export declare const SettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
51
51
|
/**
|
|
52
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
52
|
+
* 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.
|
|
53
53
|
* @summary Retrieve the settings
|
|
54
54
|
* @param {string} keys
|
|
55
55
|
* @param {string} [authorization] Bearer Token
|
|
@@ -85,7 +85,7 @@ export interface SettingsApiGetTenantSettingsRequest {
|
|
|
85
85
|
*/
|
|
86
86
|
export declare class SettingsApi extends BaseAPI {
|
|
87
87
|
/**
|
|
88
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
88
|
+
* 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.
|
|
89
89
|
* @summary Retrieve the settings
|
|
90
90
|
* @param {SettingsApiGetTenantSettingsRequest} requestParameters Request parameters.
|
|
91
91
|
* @param {*} [options] Override http request option.
|
package/dist/api/settings-api.js
CHANGED
|
@@ -93,7 +93,7 @@ var SettingsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
96
|
+
* 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.
|
|
97
97
|
* @summary Retrieve the settings
|
|
98
98
|
* @param {string} keys
|
|
99
99
|
* @param {string} [authorization] Bearer Token
|
|
@@ -153,7 +153,7 @@ var SettingsApiFp = function (configuration) {
|
|
|
153
153
|
var localVarAxiosParamCreator = (0, exports.SettingsApiAxiosParamCreator)(configuration);
|
|
154
154
|
return {
|
|
155
155
|
/**
|
|
156
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
156
|
+
* 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.
|
|
157
157
|
* @summary Retrieve the settings
|
|
158
158
|
* @param {string} keys
|
|
159
159
|
* @param {string} [authorization] Bearer Token
|
|
@@ -184,7 +184,7 @@ var SettingsApiFactory = function (configuration, basePath, axios) {
|
|
|
184
184
|
var localVarFp = (0, exports.SettingsApiFp)(configuration);
|
|
185
185
|
return {
|
|
186
186
|
/**
|
|
187
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
187
|
+
* 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.
|
|
188
188
|
* @summary Retrieve the settings
|
|
189
189
|
* @param {string} keys
|
|
190
190
|
* @param {string} [authorization] Bearer Token
|
|
@@ -209,7 +209,7 @@ var SettingsApi = /** @class */ (function (_super) {
|
|
|
209
209
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
210
210
|
}
|
|
211
211
|
/**
|
|
212
|
-
* Retrieves the details of the settings that was previously created. Supply the unique settings code
|
|
212
|
+
* 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.
|
|
213
213
|
* @summary Retrieve the settings
|
|
214
214
|
* @param {SettingsApiGetTenantSettingsRequest} requestParameters Request parameters.
|
|
215
215
|
* @param {*} [options] Override http request option.
|
package/dist/api/users-api.d.ts
CHANGED
|
@@ -98,19 +98,20 @@ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
98
98
|
*/
|
|
99
99
|
getUser: (code: string, code2: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
100
100
|
/**
|
|
101
|
-
* Returns a list of users you have previously created.
|
|
101
|
+
* 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.
|
|
102
102
|
* @summary List users
|
|
103
103
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
104
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
105
105
|
* @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.
|
|
106
106
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
107
|
-
* @param {any} [search]
|
|
107
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
108
108
|
* @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.
|
|
109
109
|
* @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.
|
|
110
|
+
* @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.
|
|
110
111
|
* @param {*} [options] Override http request option.
|
|
111
112
|
* @throws {RequiredError}
|
|
112
113
|
*/
|
|
113
|
-
listUsers: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
114
|
+
listUsers: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
114
115
|
};
|
|
115
116
|
/**
|
|
116
117
|
* UsersApi - functional programming interface
|
|
@@ -185,19 +186,20 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
|
|
|
185
186
|
*/
|
|
186
187
|
getUser(code: string, code2: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserResponseClass>>;
|
|
187
188
|
/**
|
|
188
|
-
* Returns a list of users you have previously created.
|
|
189
|
+
* 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.
|
|
189
190
|
* @summary List users
|
|
190
191
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
192
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
192
193
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
194
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
194
|
-
* @param {any} [search]
|
|
195
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
195
196
|
* @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.
|
|
196
197
|
* @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.
|
|
198
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
197
199
|
* @param {*} [options] Override http request option.
|
|
198
200
|
* @throws {RequiredError}
|
|
199
201
|
*/
|
|
200
|
-
listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponseClass>>;
|
|
202
|
+
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>>;
|
|
201
203
|
};
|
|
202
204
|
/**
|
|
203
205
|
* UsersApi - factory interface
|
|
@@ -272,19 +274,20 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
|
|
|
272
274
|
*/
|
|
273
275
|
getUser(code: string, code2: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetUserResponseClass>;
|
|
274
276
|
/**
|
|
275
|
-
* Returns a list of users you have previously created.
|
|
277
|
+
* 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.
|
|
276
278
|
* @summary List users
|
|
277
279
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
278
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
280
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
279
281
|
* @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.
|
|
280
282
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
281
|
-
* @param {any} [search]
|
|
283
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
282
284
|
* @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.
|
|
283
285
|
* @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.
|
|
286
|
+
* @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.
|
|
284
287
|
* @param {*} [options] Override http request option.
|
|
285
288
|
* @throws {RequiredError}
|
|
286
289
|
*/
|
|
287
|
-
listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListUsersResponseClass>;
|
|
290
|
+
listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListUsersResponseClass>;
|
|
288
291
|
};
|
|
289
292
|
/**
|
|
290
293
|
* Request parameters for assignUserRoles operation in UsersApi.
|
|
@@ -469,7 +472,7 @@ export interface UsersApiListUsersRequest {
|
|
|
469
472
|
*/
|
|
470
473
|
readonly authorization?: string;
|
|
471
474
|
/**
|
|
472
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
475
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
473
476
|
* @type {any}
|
|
474
477
|
* @memberof UsersApiListUsers
|
|
475
478
|
*/
|
|
@@ -487,7 +490,7 @@ export interface UsersApiListUsersRequest {
|
|
|
487
490
|
*/
|
|
488
491
|
readonly filter?: any;
|
|
489
492
|
/**
|
|
490
|
-
*
|
|
493
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
491
494
|
* @type {any}
|
|
492
495
|
* @memberof UsersApiListUsers
|
|
493
496
|
*/
|
|
@@ -504,6 +507,12 @@ export interface UsersApiListUsersRequest {
|
|
|
504
507
|
* @memberof UsersApiListUsers
|
|
505
508
|
*/
|
|
506
509
|
readonly expand?: any;
|
|
510
|
+
/**
|
|
511
|
+
* 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.
|
|
512
|
+
* @type {any}
|
|
513
|
+
* @memberof UsersApiListUsers
|
|
514
|
+
*/
|
|
515
|
+
readonly filters?: any;
|
|
507
516
|
}
|
|
508
517
|
/**
|
|
509
518
|
* UsersApi - object-oriented interface
|
|
@@ -577,7 +586,7 @@ export declare class UsersApi extends BaseAPI {
|
|
|
577
586
|
*/
|
|
578
587
|
getUser(requestParameters: UsersApiGetUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserResponseClass, any>>;
|
|
579
588
|
/**
|
|
580
|
-
* Returns a list of users you have previously created.
|
|
589
|
+
* 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.
|
|
581
590
|
* @summary List users
|
|
582
591
|
* @param {UsersApiListUsersRequest} requestParameters Request parameters.
|
|
583
592
|
* @param {*} [options] Override http request option.
|
package/dist/api/users-api.js
CHANGED
|
@@ -487,19 +487,20 @@ var UsersApiAxiosParamCreator = function (configuration) {
|
|
|
487
487
|
});
|
|
488
488
|
},
|
|
489
489
|
/**
|
|
490
|
-
* Returns a list of users you have previously created.
|
|
490
|
+
* 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.
|
|
491
491
|
* @summary List users
|
|
492
492
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
493
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
493
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
494
494
|
* @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.
|
|
495
495
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
496
|
-
* @param {any} [search]
|
|
496
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
497
497
|
* @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.
|
|
498
498
|
* @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.
|
|
499
|
+
* @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.
|
|
499
500
|
* @param {*} [options] Override http request option.
|
|
500
501
|
* @throws {RequiredError}
|
|
501
502
|
*/
|
|
502
|
-
listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
503
|
+
listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
503
504
|
if (options === void 0) { options = {}; }
|
|
504
505
|
return __awaiter(_this, void 0, void 0, function () {
|
|
505
506
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -540,6 +541,9 @@ var UsersApiAxiosParamCreator = function (configuration) {
|
|
|
540
541
|
if (expand !== undefined) {
|
|
541
542
|
localVarQueryParameter['expand'] = expand;
|
|
542
543
|
}
|
|
544
|
+
if (filters !== undefined) {
|
|
545
|
+
localVarQueryParameter['filters'] = filters;
|
|
546
|
+
}
|
|
543
547
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
544
548
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
545
549
|
}
|
|
@@ -728,24 +732,25 @@ var UsersApiFp = function (configuration) {
|
|
|
728
732
|
});
|
|
729
733
|
},
|
|
730
734
|
/**
|
|
731
|
-
* Returns a list of users you have previously created.
|
|
735
|
+
* 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.
|
|
732
736
|
* @summary List users
|
|
733
737
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
734
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
738
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
735
739
|
* @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.
|
|
736
740
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
737
|
-
* @param {any} [search]
|
|
741
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
738
742
|
* @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.
|
|
739
743
|
* @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.
|
|
744
|
+
* @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.
|
|
740
745
|
* @param {*} [options] Override http request option.
|
|
741
746
|
* @throws {RequiredError}
|
|
742
747
|
*/
|
|
743
|
-
listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
748
|
+
listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
744
749
|
return __awaiter(this, void 0, void 0, function () {
|
|
745
750
|
var localVarAxiosArgs;
|
|
746
751
|
return __generator(this, function (_a) {
|
|
747
752
|
switch (_a.label) {
|
|
748
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, options)];
|
|
753
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
749
754
|
case 1:
|
|
750
755
|
localVarAxiosArgs = _a.sent();
|
|
751
756
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -847,20 +852,21 @@ var UsersApiFactory = function (configuration, basePath, axios) {
|
|
|
847
852
|
return localVarFp.getUser(code, code2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
848
853
|
},
|
|
849
854
|
/**
|
|
850
|
-
* Returns a list of users you have previously created.
|
|
855
|
+
* 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.
|
|
851
856
|
* @summary List users
|
|
852
857
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
853
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
858
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
854
859
|
* @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.
|
|
855
860
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
856
|
-
* @param {any} [search]
|
|
861
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
857
862
|
* @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.
|
|
858
863
|
* @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.
|
|
864
|
+
* @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.
|
|
859
865
|
* @param {*} [options] Override http request option.
|
|
860
866
|
* @throws {RequiredError}
|
|
861
867
|
*/
|
|
862
|
-
listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
863
|
-
return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
868
|
+
listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
869
|
+
return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
864
870
|
},
|
|
865
871
|
};
|
|
866
872
|
};
|
|
@@ -965,7 +971,7 @@ var UsersApi = /** @class */ (function (_super) {
|
|
|
965
971
|
return (0, exports.UsersApiFp)(this.configuration).getUser(requestParameters.code, requestParameters.code2, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
966
972
|
};
|
|
967
973
|
/**
|
|
968
|
-
* Returns a list of users you have previously created.
|
|
974
|
+
* 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.
|
|
969
975
|
* @summary List users
|
|
970
976
|
* @param {UsersApiListUsersRequest} requestParameters Request parameters.
|
|
971
977
|
* @param {*} [options] Override http request option.
|
|
@@ -975,7 +981,7 @@ var UsersApi = /** @class */ (function (_super) {
|
|
|
975
981
|
UsersApi.prototype.listUsers = function (requestParameters, options) {
|
|
976
982
|
var _this = this;
|
|
977
983
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
978
|
-
return (0, exports.UsersApiFp)(this.configuration).listUsers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
984
|
+
return (0, exports.UsersApiFp)(this.configuration).listUsers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
979
985
|
};
|
|
980
986
|
return UsersApi;
|
|
981
987
|
}(base_1.BaseAPI));
|
package/dist/api.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ export * from './api/custom-schema-api';
|
|
|
13
13
|
export * from './api/data-report-api';
|
|
14
14
|
export * from './api/data-report-executor-api';
|
|
15
15
|
export * from './api/default-api';
|
|
16
|
+
export * from './api/delete-organization-invitations-api';
|
|
16
17
|
export * from './api/invite-organizations-api';
|
|
17
18
|
export * from './api/invite-users-api';
|
|
18
19
|
export * from './api/list-organization-invitations-api';
|
package/dist/api.js
CHANGED
|
@@ -31,6 +31,7 @@ __exportStar(require("./api/custom-schema-api"), exports);
|
|
|
31
31
|
__exportStar(require("./api/data-report-api"), exports);
|
|
32
32
|
__exportStar(require("./api/data-report-executor-api"), exports);
|
|
33
33
|
__exportStar(require("./api/default-api"), exports);
|
|
34
|
+
__exportStar(require("./api/delete-organization-invitations-api"), exports);
|
|
34
35
|
__exportStar(require("./api/invite-organizations-api"), exports);
|
|
35
36
|
__exportStar(require("./api/invite-users-api"), exports);
|
|
36
37
|
__exportStar(require("./api/list-organization-invitations-api"), exports);
|
package/dist/base.js
CHANGED
|
@@ -125,6 +125,7 @@ var BaseAPI = /** @class */ (function () {
|
|
|
125
125
|
if (configuration) {
|
|
126
126
|
this.configuration = configuration;
|
|
127
127
|
this.basePath = configuration.basePath || this.basePath;
|
|
128
|
+
this.configuration.accessToken = this.tokenData.accessToken ? "Bearer ".concat(this.tokenData.accessToken) : '';
|
|
128
129
|
}
|
|
129
130
|
else {
|
|
130
131
|
var _a = this.tokenData, accessToken = _a.accessToken, username = _a.username;
|
|
@@ -23,7 +23,7 @@ export interface CreateDataReportRequestDto {
|
|
|
23
23
|
*/
|
|
24
24
|
'code': string;
|
|
25
25
|
/**
|
|
26
|
-
* A slug is a human-readable, unique identifier, used to identify a resource
|
|
26
|
+
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof CreateDataReportRequestDto
|
|
29
29
|
*/
|
|
@@ -29,8 +29,8 @@ export interface CreateRoleRequestDto {
|
|
|
29
29
|
'description': string;
|
|
30
30
|
/**
|
|
31
31
|
* Permission ids for the role
|
|
32
|
-
* @type {Array<
|
|
32
|
+
* @type {Array<number>}
|
|
33
33
|
* @memberof CreateRoleRequestDto
|
|
34
34
|
*/
|
|
35
|
-
'permissionIds': Array<
|
|
35
|
+
'permissionIds': Array<number>;
|
|
36
36
|
}
|
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { CustomFieldOptionDto } from './custom-field-option-dto';
|
|
13
12
|
/**
|
|
14
13
|
*
|
|
15
14
|
* @export
|
|
@@ -29,55 +28,88 @@ export interface CustomFieldDto {
|
|
|
29
28
|
*/
|
|
30
29
|
'label'?: string;
|
|
31
30
|
/**
|
|
32
|
-
*
|
|
31
|
+
* The type of the custom field. Supported types are: string, number, boolean, array, object, date, dateTime, phoneNumber, email, url
|
|
33
32
|
* @type {string}
|
|
34
33
|
* @memberof CustomFieldDto
|
|
35
34
|
*/
|
|
36
35
|
'type': CustomFieldDtoTypeEnum;
|
|
37
36
|
/**
|
|
38
|
-
*
|
|
37
|
+
* Indicates whether the customField is required
|
|
39
38
|
* @type {boolean}
|
|
40
39
|
* @memberof CustomFieldDto
|
|
41
40
|
*/
|
|
42
41
|
'isRequired': boolean;
|
|
43
42
|
/**
|
|
44
|
-
*
|
|
43
|
+
* Minimum for number field
|
|
45
44
|
* @type {number}
|
|
46
45
|
* @memberof CustomFieldDto
|
|
47
46
|
*/
|
|
48
47
|
'minimum'?: number;
|
|
49
48
|
/**
|
|
50
|
-
*
|
|
49
|
+
* Maximum for number field
|
|
51
50
|
* @type {number}
|
|
52
51
|
* @memberof CustomFieldDto
|
|
53
52
|
*/
|
|
54
53
|
'maximum'?: number;
|
|
55
54
|
/**
|
|
56
|
-
*
|
|
55
|
+
* Minimum length for string field
|
|
57
56
|
* @type {number}
|
|
58
57
|
* @memberof CustomFieldDto
|
|
59
58
|
*/
|
|
60
59
|
'minLength'?: number;
|
|
61
60
|
/**
|
|
62
|
-
*
|
|
61
|
+
* Maximum length for string field
|
|
63
62
|
* @type {number}
|
|
64
63
|
* @memberof CustomFieldDto
|
|
65
64
|
*/
|
|
66
65
|
'maxLength'?: number;
|
|
67
66
|
/**
|
|
68
|
-
*
|
|
69
|
-
* @type {
|
|
67
|
+
* Possible options to select
|
|
68
|
+
* @type {object}
|
|
70
69
|
* @memberof CustomFieldDto
|
|
71
70
|
*/
|
|
72
|
-
'options'
|
|
71
|
+
'options'?: object;
|
|
72
|
+
/**
|
|
73
|
+
* The minimum number of items allowed for array fields.
|
|
74
|
+
* @type {number}
|
|
75
|
+
* @memberof CustomFieldDto
|
|
76
|
+
*/
|
|
77
|
+
'minItems'?: number;
|
|
78
|
+
/**
|
|
79
|
+
* The maximum number of items allowed for array fields.
|
|
80
|
+
* @type {number}
|
|
81
|
+
* @memberof CustomFieldDto
|
|
82
|
+
*/
|
|
83
|
+
'maxItems'?: number;
|
|
84
|
+
/**
|
|
85
|
+
* Defines the structure of items for array fields.
|
|
86
|
+
* @type {CustomFieldDto}
|
|
87
|
+
* @memberof CustomFieldDto
|
|
88
|
+
*/
|
|
89
|
+
'items'?: CustomFieldDto;
|
|
90
|
+
/**
|
|
91
|
+
* Defines the properties for object fields.
|
|
92
|
+
* @type {object}
|
|
93
|
+
* @memberof CustomFieldDto
|
|
94
|
+
*/
|
|
95
|
+
'properties'?: object;
|
|
96
|
+
/**
|
|
97
|
+
* Defines the regex expression for string field.
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof CustomFieldDto
|
|
100
|
+
*/
|
|
101
|
+
'regexExpression'?: string;
|
|
73
102
|
}
|
|
74
103
|
export declare const CustomFieldDtoTypeEnum: {
|
|
75
104
|
readonly String: "string";
|
|
76
105
|
readonly Number: "number";
|
|
77
106
|
readonly Boolean: "boolean";
|
|
78
107
|
readonly Date: "date";
|
|
79
|
-
readonly DateTime: "
|
|
108
|
+
readonly DateTime: "dateTime";
|
|
80
109
|
readonly Email: "email";
|
|
81
110
|
readonly Object: "object";
|
|
111
|
+
readonly Phone: "phone";
|
|
112
|
+
readonly Url: "url";
|
|
113
|
+
readonly Array: "array";
|
|
82
114
|
};
|
|
83
115
|
export type CustomFieldDtoTypeEnum = typeof CustomFieldDtoTypeEnum[keyof typeof CustomFieldDtoTypeEnum];
|
|
@@ -19,7 +19,10 @@ exports.CustomFieldDtoTypeEnum = {
|
|
|
19
19
|
Number: 'number',
|
|
20
20
|
Boolean: 'boolean',
|
|
21
21
|
Date: 'date',
|
|
22
|
-
DateTime: '
|
|
22
|
+
DateTime: 'dateTime',
|
|
23
23
|
Email: 'email',
|
|
24
|
-
Object: 'object'
|
|
24
|
+
Object: 'object',
|
|
25
|
+
Phone: 'phone',
|
|
26
|
+
Url: 'url',
|
|
27
|
+
Array: 'array'
|
|
25
28
|
};
|
|
@@ -29,7 +29,7 @@ export interface DataReportClass {
|
|
|
29
29
|
*/
|
|
30
30
|
'code': string;
|
|
31
31
|
/**
|
|
32
|
-
* A slug is a human-readable, unique identifier, used to identify a resource
|
|
32
|
+
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof DataReportClass
|
|
35
35
|
*/
|
package/dist/models/index.d.ts
CHANGED
|
@@ -10,7 +10,6 @@ export * from './create-permission-request-dto';
|
|
|
10
10
|
export * from './create-role-request-dto';
|
|
11
11
|
export * from './create-tenant-request-dto';
|
|
12
12
|
export * from './custom-field-dto';
|
|
13
|
-
export * from './custom-field-option-dto';
|
|
14
13
|
export * from './custom-schema-class';
|
|
15
14
|
export * from './dbconfig-dto';
|
|
16
15
|
export * from './data-report-class';
|
|
@@ -56,7 +55,6 @@ export * from './role-class';
|
|
|
56
55
|
export * from './run-data-report-request-dto';
|
|
57
56
|
export * from './run-data-report-response-class';
|
|
58
57
|
export * from './set-setting-request-dto';
|
|
59
|
-
export * from './set-user-setting-response-class';
|
|
60
58
|
export * from './subscription-class';
|
|
61
59
|
export * from './tenant-admin-user-dto';
|
|
62
60
|
export * from './tenant-settings-class';
|