@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
@@ -79,7 +79,6 @@ models/role-class.ts
79
79
  models/run-data-report-request-dto.ts
80
80
  models/run-data-report-response-class.ts
81
81
  models/set-setting-request-dto.ts
82
- models/set-user-setting-response-class.ts
83
82
  models/subscription-class.ts
84
83
  models/tenant-admin-user-dto.ts
85
84
  models/tenant-settings-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/tenant-sdk-node@1.15.0 --save
20
+ npm install @emilgroup/tenant-sdk-node@1.16.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/tenant-sdk-node@1.15.0
24
+ yarn add @emilgroup/tenant-sdk-node@1.16.0
25
25
  ```
26
26
 
27
27
  And then you can import `UsersApi`.
@@ -47,6 +47,22 @@ export EMIL_USERNAME=XXXXX@XXXX.XXX
47
47
  export EMIL_PASSWORD=XXXXXXXXXXXXXX
48
48
  ```
49
49
 
50
+ ## Base path
51
+
52
+ To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.
53
+
54
+ ```ts
55
+ import { UsersApi, Environment } from '@emilgroup/tenant-sdk-node'
56
+
57
+ const usersApi = new UsersApi();
58
+
59
+ // Allows you to simply choose environment. It will usually be Environment.Production.
60
+ usersApi.selectEnvironment(Environment.Production);
61
+
62
+ // For advanced users, use the custom baseUrl of the website you need to connect to.
63
+ usersApi.selectBasePath('https://my-custom-domain.com');
64
+ ```
65
+
50
66
  ## Example
51
67
 
52
68
  Here is a basic functionning example:
@@ -90,7 +90,7 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
90
90
  };
91
91
  },
92
92
  /**
93
- * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
93
+ * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
94
94
  * @summary Retrieve the custom-schema
95
95
  * @param {string} code Unique identifier for the object.
96
96
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -140,19 +140,20 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
140
140
  };
141
141
  },
142
142
  /**
143
- * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
143
+ * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
144
144
  * @summary List custom-schemas
145
145
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
146
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
146
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
147
147
  * @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.
148
148
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
149
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
149
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
150
150
  * @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.
151
151
  * @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.
152
+ * @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.
152
153
  * @param {*} [options] Override http request option.
153
154
  * @throws {RequiredError}
154
155
  */
155
- listCustomSchemas: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
156
+ listCustomSchemas: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
156
157
  const localVarPath = `/tenantservice/v1/custom-schemas`;
157
158
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
158
159
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -195,6 +196,10 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
195
196
  localVarQueryParameter['expand'] = expand;
196
197
  }
197
198
 
199
+ if (filters !== undefined) {
200
+ localVarQueryParameter['filters'] = filters;
201
+ }
202
+
198
203
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
199
204
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
200
205
  }
@@ -284,7 +289,7 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
284
289
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
285
290
  },
286
291
  /**
287
- * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
292
+ * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
288
293
  * @summary Retrieve the custom-schema
289
294
  * @param {string} code Unique identifier for the object.
290
295
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -297,20 +302,21 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
297
302
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
298
303
  },
299
304
  /**
300
- * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
305
+ * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
301
306
  * @summary List custom-schemas
302
307
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
303
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
308
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
304
309
  * @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.
305
310
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
306
- * @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.
311
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
307
312
  * @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.
308
313
  * @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.
314
+ * @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.
309
315
  * @param {*} [options] Override http request option.
310
316
  * @throws {RequiredError}
311
317
  */
312
- async listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>> {
313
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, options);
318
+ async listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>> {
319
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
314
320
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
315
321
  },
316
322
  /**
@@ -348,7 +354,7 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
348
354
  return localVarFp.createCustomSchema(createCustomSchemaRequestDto, authorization, options).then((request) => request(axios, basePath));
349
355
  },
350
356
  /**
351
- * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
357
+ * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
352
358
  * @summary Retrieve the custom-schema
353
359
  * @param {string} code Unique identifier for the object.
354
360
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -360,20 +366,21 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
360
366
  return localVarFp.getCustomSchema(code, authorization, expand, options).then((request) => request(axios, basePath));
361
367
  },
362
368
  /**
363
- * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
369
+ * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
364
370
  * @summary List custom-schemas
365
371
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
366
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
372
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
367
373
  * @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.
368
374
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
369
- * @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.
375
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
370
376
  * @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.
371
377
  * @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.
378
+ * @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.
372
379
  * @param {*} [options] Override http request option.
373
380
  * @throws {RequiredError}
374
381
  */
375
- listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass> {
376
- return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
382
+ listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass> {
383
+ return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
377
384
  },
378
385
  /**
379
386
  * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -453,7 +460,7 @@ export interface CustomSchemaApiListCustomSchemasRequest {
453
460
  readonly authorization?: string
454
461
 
455
462
  /**
456
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
463
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
457
464
  * @type {any}
458
465
  * @memberof CustomSchemaApiListCustomSchemas
459
466
  */
@@ -474,7 +481,7 @@ export interface CustomSchemaApiListCustomSchemasRequest {
474
481
  readonly filter?: any
475
482
 
476
483
  /**
477
- * 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.
484
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
478
485
  * @type {any}
479
486
  * @memberof CustomSchemaApiListCustomSchemas
480
487
  */
@@ -493,6 +500,13 @@ export interface CustomSchemaApiListCustomSchemasRequest {
493
500
  * @memberof CustomSchemaApiListCustomSchemas
494
501
  */
495
502
  readonly expand?: any
503
+
504
+ /**
505
+ * 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.
506
+ * @type {any}
507
+ * @memberof CustomSchemaApiListCustomSchemas
508
+ */
509
+ readonly filters?: any
496
510
  }
497
511
 
498
512
  /**
@@ -543,7 +557,7 @@ export class CustomSchemaApi extends BaseAPI {
543
557
  }
544
558
 
545
559
  /**
546
- * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
560
+ * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
547
561
  * @summary Retrieve the custom-schema
548
562
  * @param {CustomSchemaApiGetCustomSchemaRequest} requestParameters Request parameters.
549
563
  * @param {*} [options] Override http request option.
@@ -555,7 +569,7 @@ export class CustomSchemaApi extends BaseAPI {
555
569
  }
556
570
 
557
571
  /**
558
- * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
572
+ * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
559
573
  * @summary List custom-schemas
560
574
  * @param {CustomSchemaApiListCustomSchemasRequest} requestParameters Request parameters.
561
575
  * @param {*} [options] Override http request option.
@@ -563,7 +577,7 @@ export class CustomSchemaApi extends BaseAPI {
563
577
  * @memberof CustomSchemaApi
564
578
  */
565
579
  public listCustomSchemas(requestParameters: CustomSchemaApiListCustomSchemasRequest = {}, options?: AxiosRequestConfig) {
566
- return CustomSchemaApiFp(this.configuration).listCustomSchemas(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
580
+ return CustomSchemaApiFp(this.configuration).listCustomSchemas(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
567
581
  }
568
582
 
569
583
  /**
@@ -50,9 +50,9 @@ export const DataReportApiAxiosParamCreator = function (configuration?: Configur
50
50
  * @param {*} [options] Override http request option.
51
51
  * @throws {RequiredError}
52
52
  */
53
- createCustomSchema: async (createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
53
+ createDataReport: async (createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
54
54
  // verify required parameter 'createDataReportRequestDto' is not null or undefined
55
- assertParamExists('createCustomSchema', 'createDataReportRequestDto', createDataReportRequestDto)
55
+ assertParamExists('createDataReport', 'createDataReportRequestDto', createDataReportRequestDto)
56
56
  const localVarPath = `/tenantservice/v1/data-reports`;
57
57
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
58
58
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -134,7 +134,7 @@ export const DataReportApiAxiosParamCreator = function (configuration?: Configur
134
134
  };
135
135
  },
136
136
  /**
137
- * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
137
+ * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
138
138
  * @summary Retrieve the data-report
139
139
  * @param {string} code Unique identifier for the object.
140
140
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -184,19 +184,20 @@ export const DataReportApiAxiosParamCreator = function (configuration?: Configur
184
184
  };
185
185
  },
186
186
  /**
187
- * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
187
+ * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
188
188
  * @summary List data-reports
189
189
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
190
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
190
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
191
191
  * @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.
192
192
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
193
- * @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.
193
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
194
194
  * @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.
195
195
  * @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.
196
+ * @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.
196
197
  * @param {*} [options] Override http request option.
197
198
  * @throws {RequiredError}
198
199
  */
199
- listDataReports: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
200
+ listDataReports: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
200
201
  const localVarPath = `/tenantservice/v1/data-reports`;
201
202
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
202
203
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -239,6 +240,10 @@ export const DataReportApiAxiosParamCreator = function (configuration?: Configur
239
240
  localVarQueryParameter['expand'] = expand;
240
241
  }
241
242
 
243
+ if (filters !== undefined) {
244
+ localVarQueryParameter['filters'] = filters;
245
+ }
246
+
242
247
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
243
248
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
244
249
  }
@@ -323,8 +328,8 @@ export const DataReportApiFp = function(configuration?: Configuration) {
323
328
  * @param {*} [options] Override http request option.
324
329
  * @throws {RequiredError}
325
330
  */
326
- async createCustomSchema(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDataReportResponseClass>> {
327
- const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomSchema(createDataReportRequestDto, authorization, options);
331
+ async createDataReport(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDataReportResponseClass>> {
332
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createDataReport(createDataReportRequestDto, authorization, options);
328
333
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
329
334
  },
330
335
  /**
@@ -339,7 +344,7 @@ export const DataReportApiFp = function(configuration?: Configuration) {
339
344
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
340
345
  },
341
346
  /**
342
- * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
347
+ * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
343
348
  * @summary Retrieve the data-report
344
349
  * @param {string} code Unique identifier for the object.
345
350
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -352,20 +357,21 @@ export const DataReportApiFp = function(configuration?: Configuration) {
352
357
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
353
358
  },
354
359
  /**
355
- * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
360
+ * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
356
361
  * @summary List data-reports
357
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
358
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
363
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
359
364
  * @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.
360
365
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
361
- * @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.
366
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
362
367
  * @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.
363
368
  * @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.
369
+ * @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.
364
370
  * @param {*} [options] Override http request option.
365
371
  * @throws {RequiredError}
366
372
  */
367
- async listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDataReportsResponseClass>> {
368
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, options);
373
+ async listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDataReportsResponseClass>> {
374
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
369
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
370
376
  },
371
377
  /**
@@ -399,8 +405,8 @@ export const DataReportApiFactory = function (configuration?: Configuration, bas
399
405
  * @param {*} [options] Override http request option.
400
406
  * @throws {RequiredError}
401
407
  */
402
- createCustomSchema(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDataReportResponseClass> {
403
- return localVarFp.createCustomSchema(createDataReportRequestDto, authorization, options).then((request) => request(axios, basePath));
408
+ createDataReport(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDataReportResponseClass> {
409
+ return localVarFp.createDataReport(createDataReportRequestDto, authorization, options).then((request) => request(axios, basePath));
404
410
  },
405
411
  /**
406
412
  *
@@ -413,7 +419,7 @@ export const DataReportApiFactory = function (configuration?: Configuration, bas
413
419
  return localVarFp.deleteAlert(id, authorization, options).then((request) => request(axios, basePath));
414
420
  },
415
421
  /**
416
- * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
422
+ * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
417
423
  * @summary Retrieve the data-report
418
424
  * @param {string} code Unique identifier for the object.
419
425
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -425,20 +431,21 @@ export const DataReportApiFactory = function (configuration?: Configuration, bas
425
431
  return localVarFp.getDataReport(code, authorization, expand, options).then((request) => request(axios, basePath));
426
432
  },
427
433
  /**
428
- * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
434
+ * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
429
435
  * @summary List data-reports
430
436
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
431
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
437
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
432
438
  * @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.
433
439
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
434
- * @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.
440
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
435
441
  * @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.
436
442
  * @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.
443
+ * @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.
437
444
  * @param {*} [options] Override http request option.
438
445
  * @throws {RequiredError}
439
446
  */
440
- listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDataReportsResponseClass> {
441
- return localVarFp.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
447
+ listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListDataReportsResponseClass> {
448
+ return localVarFp.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
442
449
  },
443
450
  /**
444
451
  * Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -456,22 +463,22 @@ export const DataReportApiFactory = function (configuration?: Configuration, bas
456
463
  };
457
464
 
458
465
  /**
459
- * Request parameters for createCustomSchema operation in DataReportApi.
466
+ * Request parameters for createDataReport operation in DataReportApi.
460
467
  * @export
461
- * @interface DataReportApiCreateCustomSchemaRequest
468
+ * @interface DataReportApiCreateDataReportRequest
462
469
  */
463
- export interface DataReportApiCreateCustomSchemaRequest {
470
+ export interface DataReportApiCreateDataReportRequest {
464
471
  /**
465
472
  *
466
473
  * @type {CreateDataReportRequestDto}
467
- * @memberof DataReportApiCreateCustomSchema
474
+ * @memberof DataReportApiCreateDataReport
468
475
  */
469
476
  readonly createDataReportRequestDto: CreateDataReportRequestDto
470
477
 
471
478
  /**
472
479
  * Bearer Token: provided by the login endpoint under the name accessToken.
473
480
  * @type {string}
474
- * @memberof DataReportApiCreateCustomSchema
481
+ * @memberof DataReportApiCreateDataReport
475
482
  */
476
483
  readonly authorization?: string
477
484
  }
@@ -539,7 +546,7 @@ export interface DataReportApiListDataReportsRequest {
539
546
  readonly authorization?: string
540
547
 
541
548
  /**
542
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
549
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
543
550
  * @type {any}
544
551
  * @memberof DataReportApiListDataReports
545
552
  */
@@ -560,7 +567,7 @@ export interface DataReportApiListDataReportsRequest {
560
567
  readonly filter?: any
561
568
 
562
569
  /**
563
- * 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.
570
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
564
571
  * @type {any}
565
572
  * @memberof DataReportApiListDataReports
566
573
  */
@@ -579,6 +586,13 @@ export interface DataReportApiListDataReportsRequest {
579
586
  * @memberof DataReportApiListDataReports
580
587
  */
581
588
  readonly expand?: any
589
+
590
+ /**
591
+ * 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.
592
+ * @type {any}
593
+ * @memberof DataReportApiListDataReports
594
+ */
595
+ readonly filters?: any
582
596
  }
583
597
 
584
598
  /**
@@ -619,13 +633,13 @@ export class DataReportApi extends BaseAPI {
619
633
  /**
620
634
  * This will create a data report for tenant in the database
621
635
  * @summary Create the data-report
622
- * @param {DataReportApiCreateCustomSchemaRequest} requestParameters Request parameters.
636
+ * @param {DataReportApiCreateDataReportRequest} requestParameters Request parameters.
623
637
  * @param {*} [options] Override http request option.
624
638
  * @throws {RequiredError}
625
639
  * @memberof DataReportApi
626
640
  */
627
- public createCustomSchema(requestParameters: DataReportApiCreateCustomSchemaRequest, options?: AxiosRequestConfig) {
628
- return DataReportApiFp(this.configuration).createCustomSchema(requestParameters.createDataReportRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
641
+ public createDataReport(requestParameters: DataReportApiCreateDataReportRequest, options?: AxiosRequestConfig) {
642
+ return DataReportApiFp(this.configuration).createDataReport(requestParameters.createDataReportRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
629
643
  }
630
644
 
631
645
  /**
@@ -640,7 +654,7 @@ export class DataReportApi extends BaseAPI {
640
654
  }
641
655
 
642
656
  /**
643
- * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
657
+ * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
644
658
  * @summary Retrieve the data-report
645
659
  * @param {DataReportApiGetDataReportRequest} requestParameters Request parameters.
646
660
  * @param {*} [options] Override http request option.
@@ -652,7 +666,7 @@ export class DataReportApi extends BaseAPI {
652
666
  }
653
667
 
654
668
  /**
655
- * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
669
+ * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
656
670
  * @summary List data-reports
657
671
  * @param {DataReportApiListDataReportsRequest} requestParameters Request parameters.
658
672
  * @param {*} [options] Override http request option.
@@ -660,7 +674,7 @@ export class DataReportApi extends BaseAPI {
660
674
  * @memberof DataReportApi
661
675
  */
662
676
  public listDataReports(requestParameters: DataReportApiListDataReportsRequest = {}, options?: AxiosRequestConfig) {
663
- return DataReportApiFp(this.configuration).listDataReports(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
677
+ return DataReportApiFp(this.configuration).listDataReports(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
664
678
  }
665
679
 
666
680
  /**