@emilgroup/tenant-sdk-node 1.15.0 → 1.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/.openapi-generator/FILES +0 -1
  2. package/README.md +18 -2
  3. package/api/custom-schema-api.ts +36 -22
  4. package/api/data-report-api.ts +50 -36
  5. package/api/invite-users-api.ts +32 -18
  6. package/api/list-organization-invitations-api.ts +32 -18
  7. package/api/organizations-api.ts +28 -14
  8. package/api/roles-api.ts +22 -22
  9. package/api/settings-api.ts +4 -4
  10. package/api/users-api.ts +32 -18
  11. package/configuration.ts +1 -1
  12. package/dist/api/custom-schema-api.d.ts +28 -19
  13. package/dist/api/custom-schema-api.js +26 -20
  14. package/dist/api/data-report-api.d.ts +38 -29
  15. package/dist/api/data-report-api.js +35 -29
  16. package/dist/api/invite-users-api.d.ts +24 -15
  17. package/dist/api/invite-users-api.js +22 -16
  18. package/dist/api/list-organization-invitations-api.d.ts +24 -15
  19. package/dist/api/list-organization-invitations-api.js +22 -16
  20. package/dist/api/organizations-api.d.ts +20 -11
  21. package/dist/api/organizations-api.js +18 -12
  22. package/dist/api/roles-api.d.ts +22 -22
  23. package/dist/api/roles-api.js +13 -13
  24. package/dist/api/settings-api.d.ts +4 -4
  25. package/dist/api/settings-api.js +4 -4
  26. package/dist/api/users-api.d.ts +24 -15
  27. package/dist/api/users-api.js +22 -16
  28. package/dist/configuration.js +0 -7
  29. package/dist/models/batch-delete-request-dto.d.ts +2 -2
  30. package/dist/models/create-data-report-request-dto.d.ts +1 -1
  31. package/dist/models/create-role-request-dto.d.ts +2 -2
  32. package/dist/models/custom-field-dto.d.ts +37 -4
  33. package/dist/models/custom-field-dto.js +5 -2
  34. package/dist/models/data-report-class.d.ts +1 -1
  35. package/dist/models/disable-users-request-dto.d.ts +2 -2
  36. package/dist/models/enable-users-request-dto.d.ts +2 -2
  37. package/dist/models/index.d.ts +0 -1
  38. package/dist/models/index.js +0 -1
  39. package/dist/models/inline-response200.d.ts +6 -6
  40. package/dist/models/inline-response503.d.ts +6 -6
  41. package/dist/models/invite-class.d.ts +7 -0
  42. package/dist/models/invite-org-request-dto.d.ts +1 -1
  43. package/dist/models/invite-users-request-dto.d.ts +6 -0
  44. package/dist/models/organization-class.d.ts +6 -0
  45. package/dist/models/run-data-report-response-class.d.ts +2 -2
  46. package/dist/models/update-data-report-request-dto.d.ts +1 -1
  47. package/dist/models/update-role-request-dto.d.ts +2 -2
  48. package/dist/models/user-class.d.ts +7 -6
  49. package/models/batch-delete-request-dto.ts +2 -2
  50. package/models/create-data-report-request-dto.ts +1 -1
  51. package/models/create-role-request-dto.ts +2 -2
  52. package/models/custom-field-dto.ts +38 -5
  53. package/models/data-report-class.ts +1 -1
  54. package/models/disable-users-request-dto.ts +2 -2
  55. package/models/enable-users-request-dto.ts +2 -2
  56. package/models/index.ts +0 -1
  57. package/models/inline-response200.ts +6 -6
  58. package/models/inline-response503.ts +6 -6
  59. package/models/invite-class.ts +7 -0
  60. package/models/invite-org-request-dto.ts +1 -1
  61. package/models/invite-users-request-dto.ts +6 -0
  62. package/models/organization-class.ts +6 -0
  63. package/models/run-data-report-response-class.ts +2 -2
  64. package/models/update-data-report-request-dto.ts +1 -1
  65. package/models/update-role-request-dto.ts +2 -2
  66. package/models/user-class.ts +7 -6
  67. package/package.json +1 -1
  68. package/dist/models/set-user-setting-response-class.d.ts +0 -36
  69. package/dist/models/set-user-setting-response-class.js +0 -15
  70. package/models/set-user-setting-response-class.ts +0 -42
@@ -19,19 +19,19 @@ import { ListRolesResponseClass } from '../models';
19
19
  */
20
20
  export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- * 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.
22
+ * 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.
23
23
  * @summary List roles
24
24
  * @param {string} [authorization] Bearer Token
25
25
  * @param {number} [pageSize] Page size
26
26
  * @param {string} [pageToken] Page token
27
- * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
27
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
28
28
  * @param {string} [search] Search query
29
- * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
30
- * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
29
+ * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
30
+ * @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
31
31
  * @param {*} [options] Override http request option.
32
32
  * @throws {RequiredError}
33
33
  */
34
- listRoles: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ listRoles: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
35
  };
36
36
  /**
37
37
  * RolesApi - functional programming interface
@@ -39,19 +39,19 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
39
39
  */
40
40
  export declare const RolesApiFp: (configuration?: Configuration) => {
41
41
  /**
42
- * 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.
42
+ * 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.
43
43
  * @summary List roles
44
44
  * @param {string} [authorization] Bearer Token
45
45
  * @param {number} [pageSize] Page size
46
46
  * @param {string} [pageToken] Page token
47
- * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
47
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
48
48
  * @param {string} [search] Search query
49
- * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
50
- * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
49
+ * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
50
+ * @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
51
51
  * @param {*} [options] Override http request option.
52
52
  * @throws {RequiredError}
53
53
  */
54
- listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesResponseClass>>;
54
+ listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesResponseClass>>;
55
55
  };
56
56
  /**
57
57
  * RolesApi - factory interface
@@ -59,19 +59,19 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
59
59
  */
60
60
  export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
61
61
  /**
62
- * 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.
62
+ * 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.
63
63
  * @summary List roles
64
64
  * @param {string} [authorization] Bearer Token
65
65
  * @param {number} [pageSize] Page size
66
66
  * @param {string} [pageToken] Page token
67
- * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
67
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
68
68
  * @param {string} [search] Search query
69
- * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
70
- * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
69
+ * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
70
+ * @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
71
71
  * @param {*} [options] Override http request option.
72
72
  * @throws {RequiredError}
73
73
  */
74
- listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: any): AxiosPromise<ListRolesResponseClass>;
74
+ listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListRolesResponseClass>;
75
75
  };
76
76
  /**
77
77
  * Request parameters for listRoles operation in RolesApi.
@@ -99,10 +99,10 @@ export interface RolesApiListRolesRequest {
99
99
  readonly pageToken?: string;
100
100
  /**
101
101
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
102
- * @type {'id' | 'code' | 'label'}
102
+ * @type {string}
103
103
  * @memberof RolesApiListRoles
104
104
  */
105
- readonly filter?: 'id' | 'code' | 'label';
105
+ readonly filter?: string;
106
106
  /**
107
107
  * Search query
108
108
  * @type {string}
@@ -111,16 +111,16 @@ export interface RolesApiListRolesRequest {
111
111
  readonly search?: string;
112
112
  /**
113
113
  * Order allowing you to specify the desired order of entities retrieved from the server.
114
- * @type {'label'}
114
+ * @type {string}
115
115
  * @memberof RolesApiListRoles
116
116
  */
117
- readonly order?: 'label';
117
+ readonly order?: string;
118
118
  /**
119
119
  * You can expand roles in this endpoint. By default, permissions will be an empty array.
120
- * @type {'permissions'}
120
+ * @type {string}
121
121
  * @memberof RolesApiListRoles
122
122
  */
123
- readonly expand?: 'permissions';
123
+ readonly expand?: string;
124
124
  }
125
125
  /**
126
126
  * RolesApi - object-oriented interface
@@ -130,7 +130,7 @@ export interface RolesApiListRolesRequest {
130
130
  */
131
131
  export declare class RolesApi extends BaseAPI {
132
132
  /**
133
- * 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.
133
+ * 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.
134
134
  * @summary List roles
135
135
  * @param {RolesApiListRolesRequest} requestParameters Request parameters.
136
136
  * @param {*} [options] Override http request option.
@@ -97,15 +97,15 @@ var RolesApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * 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.
100
+ * 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.
101
101
  * @summary List roles
102
102
  * @param {string} [authorization] Bearer Token
103
103
  * @param {number} [pageSize] Page size
104
104
  * @param {string} [pageToken] Page token
105
- * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
105
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
106
106
  * @param {string} [search] Search query
107
- * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
108
- * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
107
+ * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
108
+ * @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
109
109
  * @param {*} [options] Override http request option.
110
110
  * @throws {RequiredError}
111
111
  */
@@ -175,15 +175,15 @@ var RolesApiFp = function (configuration) {
175
175
  var localVarAxiosParamCreator = (0, exports.RolesApiAxiosParamCreator)(configuration);
176
176
  return {
177
177
  /**
178
- * 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.
178
+ * 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.
179
179
  * @summary List roles
180
180
  * @param {string} [authorization] Bearer Token
181
181
  * @param {number} [pageSize] Page size
182
182
  * @param {string} [pageToken] Page token
183
- * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
183
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
184
184
  * @param {string} [search] Search query
185
- * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
186
- * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
185
+ * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
186
+ * @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
187
187
  * @param {*} [options] Override http request option.
188
188
  * @throws {RequiredError}
189
189
  */
@@ -211,15 +211,15 @@ var RolesApiFactory = function (configuration, basePath, axios) {
211
211
  var localVarFp = (0, exports.RolesApiFp)(configuration);
212
212
  return {
213
213
  /**
214
- * 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.
214
+ * 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.
215
215
  * @summary List roles
216
216
  * @param {string} [authorization] Bearer Token
217
217
  * @param {number} [pageSize] Page size
218
218
  * @param {string} [pageToken] Page token
219
- * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
219
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
220
220
  * @param {string} [search] Search query
221
- * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
222
- * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
221
+ * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
222
+ * @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
223
223
  * @param {*} [options] Override http request option.
224
224
  * @throws {RequiredError}
225
225
  */
@@ -241,7 +241,7 @@ var RolesApi = /** @class */ (function (_super) {
241
241
  return _super !== null && _super.apply(this, arguments) || this;
242
242
  }
243
243
  /**
244
- * 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.
244
+ * 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.
245
245
  * @summary List roles
246
246
  * @param {RolesApiListRolesRequest} requestParameters Request parameters.
247
247
  * @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 that was returned when you created it and Emil Api will return the corresponding settings information.
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 that was returned when you created it and Emil Api will return the corresponding settings information.
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 that was returned when you created it and Emil Api will return the corresponding settings information.
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 that was returned when you created it and Emil Api will return the corresponding settings information.
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.
@@ -97,7 +97,7 @@ var SettingsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * 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.
100
+ * 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.
101
101
  * @summary Retrieve the settings
102
102
  * @param {string} keys
103
103
  * @param {string} [authorization] Bearer Token
@@ -157,7 +157,7 @@ var SettingsApiFp = function (configuration) {
157
157
  var localVarAxiosParamCreator = (0, exports.SettingsApiAxiosParamCreator)(configuration);
158
158
  return {
159
159
  /**
160
- * 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.
160
+ * 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.
161
161
  * @summary Retrieve the settings
162
162
  * @param {string} keys
163
163
  * @param {string} [authorization] Bearer Token
@@ -188,7 +188,7 @@ var SettingsApiFactory = function (configuration, basePath, axios) {
188
188
  var localVarFp = (0, exports.SettingsApiFp)(configuration);
189
189
  return {
190
190
  /**
191
- * 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.
191
+ * 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.
192
192
  * @summary Retrieve the settings
193
193
  * @param {string} keys
194
194
  * @param {string} [authorization] Bearer Token
@@ -213,7 +213,7 @@ var SettingsApi = /** @class */ (function (_super) {
213
213
  return _super !== null && _super.apply(this, arguments) || this;
214
214
  }
215
215
  /**
216
- * 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.
216
+ * 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.
217
217
  * @summary Retrieve the settings
218
218
  * @param {SettingsApiGetTenantSettingsRequest} requestParameters Request parameters.
219
219
  * @param {*} [options] Override http request option.
@@ -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. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
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 100. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;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] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
107
+ * @param {any} [search] To search the list by any field, pass search&#x3D;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. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
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 100. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;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] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
195
+ * @param {any} [search] To search the list by any field, pass search&#x3D;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. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
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 100. Default: 10.
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&#x3D;1, your subsequent call can include pageToken&#x3D;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] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
283
+ * @param {any} [search] To search the list by any field, pass search&#x3D;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 100. Default: 10.
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
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
493
+ * To search the list by any field, pass search&#x3D;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. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
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.
@@ -491,19 +491,20 @@ var UsersApiAxiosParamCreator = function (configuration) {
491
491
  });
492
492
  },
493
493
  /**
494
- * 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.
494
+ * 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.
495
495
  * @summary List users
496
496
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
497
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
497
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
498
498
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
499
499
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
500
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
500
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
501
501
  * @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.
502
502
  * @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.
503
+ * @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.
503
504
  * @param {*} [options] Override http request option.
504
505
  * @throws {RequiredError}
505
506
  */
506
- listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
507
+ listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
507
508
  if (options === void 0) { options = {}; }
508
509
  return __awaiter(_this, void 0, void 0, function () {
509
510
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -544,6 +545,9 @@ var UsersApiAxiosParamCreator = function (configuration) {
544
545
  if (expand !== undefined) {
545
546
  localVarQueryParameter['expand'] = expand;
546
547
  }
548
+ if (filters !== undefined) {
549
+ localVarQueryParameter['filters'] = filters;
550
+ }
547
551
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
548
552
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
549
553
  }
@@ -732,24 +736,25 @@ var UsersApiFp = function (configuration) {
732
736
  });
733
737
  },
734
738
  /**
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.
739
+ * 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.
736
740
  * @summary List users
737
741
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
738
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
742
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
739
743
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
740
744
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
741
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
745
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
742
746
  * @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.
743
747
  * @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.
748
+ * @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.
744
749
  * @param {*} [options] Override http request option.
745
750
  * @throws {RequiredError}
746
751
  */
747
- listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
752
+ listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
748
753
  return __awaiter(this, void 0, void 0, function () {
749
754
  var localVarAxiosArgs;
750
755
  return __generator(this, function (_a) {
751
756
  switch (_a.label) {
752
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, options)];
757
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
753
758
  case 1:
754
759
  localVarAxiosArgs = _a.sent();
755
760
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -851,20 +856,21 @@ var UsersApiFactory = function (configuration, basePath, axios) {
851
856
  return localVarFp.getUser(code, code2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
852
857
  },
853
858
  /**
854
- * 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.
859
+ * 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.
855
860
  * @summary List users
856
861
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
857
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
862
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
858
863
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
859
864
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
860
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
865
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
861
866
  * @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.
862
867
  * @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.
868
+ * @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.
863
869
  * @param {*} [options] Override http request option.
864
870
  * @throws {RequiredError}
865
871
  */
866
- listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
867
- return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
872
+ listUsers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
873
+ return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
868
874
  },
869
875
  };
870
876
  };
@@ -969,7 +975,7 @@ var UsersApi = /** @class */ (function (_super) {
969
975
  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); });
970
976
  };
971
977
  /**
972
- * 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.
978
+ * 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.
973
979
  * @summary List users
974
980
  * @param {UsersApiListUsersRequest} requestParameters Request parameters.
975
981
  * @param {*} [options] Override http request option.
@@ -979,7 +985,7 @@ var UsersApi = /** @class */ (function (_super) {
979
985
  UsersApi.prototype.listUsers = function (requestParameters, options) {
980
986
  var _this = this;
981
987
  if (requestParameters === void 0) { requestParameters = {}; }
982
- 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); });
988
+ 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); });
983
989
  };
984
990
  return UsersApi;
985
991
  }(base_1.BaseAPI));
@@ -17,13 +17,6 @@ exports.Configuration = void 0;
17
17
  var Configuration = /** @class */ (function () {
18
18
  function Configuration(param) {
19
19
  if (param === void 0) { param = {}; }
20
- /**
21
- * parameter for oauth2 security
22
- * @param name security name
23
- * @param scopes oauth2 scope
24
- * @memberof Configuration
25
- */
26
- this.accessToken = '';
27
20
  this.apiKey = param.apiKey;
28
21
  this.username = param.username;
29
22
  this.password = param.password;
@@ -17,8 +17,8 @@
17
17
  export interface BatchDeleteRequestDto {
18
18
  /**
19
19
  * Invited users ids.
20
- * @type {Array<string>}
20
+ * @type {Array<number>}
21
21
  * @memberof BatchDeleteRequestDto
22
22
  */
23
- 'ids': Array<string>;
23
+ 'ids': Array<number>;
24
24
  }
@@ -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 instead of a less human-readable identifier like an id.
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<string>}
32
+ * @type {Array<number>}
33
33
  * @memberof CreateRoleRequestDto
34
34
  */
35
- 'permissionIds': Array<string>;
35
+ 'permissionIds': Array<number>;
36
36
  }
@@ -27,6 +27,12 @@ export interface CustomFieldDto {
27
27
  * @memberof CustomFieldDto
28
28
  */
29
29
  'label'?: string;
30
+ /**
31
+ * The type of the custom field. Supported types are: string, number, boolean, array, object, date, dateTime, phoneNumber, email, url
32
+ * @type {string}
33
+ * @memberof CustomFieldDto
34
+ */
35
+ 'type': CustomFieldDtoTypeEnum;
30
36
  /**
31
37
  * Indicates whether the customField is required
32
38
  * @type {boolean}
@@ -62,21 +68,48 @@ export interface CustomFieldDto {
62
68
  * @type {object}
63
69
  * @memberof CustomFieldDto
64
70
  */
65
- 'options': object;
71
+ 'options'?: object;
66
72
  /**
67
- *
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.
68
98
  * @type {string}
69
99
  * @memberof CustomFieldDto
70
100
  */
71
- 'type': CustomFieldDtoTypeEnum;
101
+ 'regexExpression'?: string;
72
102
  }
73
103
  export declare const CustomFieldDtoTypeEnum: {
74
104
  readonly String: "string";
75
105
  readonly Number: "number";
76
106
  readonly Boolean: "boolean";
77
107
  readonly Date: "date";
78
- readonly DateTime: "date-time";
108
+ readonly DateTime: "dateTime";
79
109
  readonly Email: "email";
80
110
  readonly Object: "object";
111
+ readonly Phone: "phone";
112
+ readonly Url: "url";
113
+ readonly Array: "array";
81
114
  };
82
115
  export type CustomFieldDtoTypeEnum = typeof CustomFieldDtoTypeEnum[keyof typeof CustomFieldDtoTypeEnum];