@emilgroup/tenant-sdk-node 1.28.0 → 1.28.1-beta.1

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 (68) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +2 -2
  3. package/api/custom-schema-api.ts +16 -16
  4. package/api/dashboard-api.ts +338 -39
  5. package/api/dashboard-group-api.ts +20 -20
  6. package/api/data-report-api.ts +16 -16
  7. package/api/data-report-executor-api.ts +4 -4
  8. package/api/delete-organization-invitations-api.ts +4 -4
  9. package/api/invite-organizations-api.ts +4 -4
  10. package/api/invite-users-api.ts +16 -16
  11. package/api/list-organization-invitations-api.ts +4 -4
  12. package/api/organizations-api.ts +12 -12
  13. package/api/re-invite-an-organization-api.ts +4 -4
  14. package/api/roles-api.ts +4 -4
  15. package/api/settings-api.ts +4 -4
  16. package/api/users-api.ts +28 -28
  17. package/base.ts +1 -1
  18. package/common.ts +2 -2
  19. package/configuration.ts +9 -0
  20. package/dist/api/custom-schema-api.d.ts +16 -16
  21. package/dist/api/custom-schema-api.js +16 -16
  22. package/dist/api/dashboard-api.d.ts +189 -34
  23. package/dist/api/dashboard-api.js +300 -34
  24. package/dist/api/dashboard-group-api.d.ts +20 -20
  25. package/dist/api/dashboard-group-api.js +20 -20
  26. package/dist/api/data-report-api.d.ts +16 -16
  27. package/dist/api/data-report-api.js +16 -16
  28. package/dist/api/data-report-executor-api.d.ts +4 -4
  29. package/dist/api/data-report-executor-api.js +4 -4
  30. package/dist/api/delete-organization-invitations-api.d.ts +4 -4
  31. package/dist/api/delete-organization-invitations-api.js +4 -4
  32. package/dist/api/invite-organizations-api.d.ts +4 -4
  33. package/dist/api/invite-organizations-api.js +4 -4
  34. package/dist/api/invite-users-api.d.ts +16 -16
  35. package/dist/api/invite-users-api.js +16 -16
  36. package/dist/api/list-organization-invitations-api.d.ts +4 -4
  37. package/dist/api/list-organization-invitations-api.js +4 -4
  38. package/dist/api/organizations-api.d.ts +12 -12
  39. package/dist/api/organizations-api.js +12 -12
  40. package/dist/api/re-invite-an-organization-api.d.ts +4 -4
  41. package/dist/api/re-invite-an-organization-api.js +4 -4
  42. package/dist/api/roles-api.d.ts +4 -4
  43. package/dist/api/roles-api.js +4 -4
  44. package/dist/api/settings-api.d.ts +4 -4
  45. package/dist/api/settings-api.js +4 -4
  46. package/dist/api/users-api.d.ts +28 -28
  47. package/dist/api/users-api.js +28 -28
  48. package/dist/base.js +1 -1
  49. package/dist/common.js +2 -2
  50. package/dist/configuration.d.ts +6 -0
  51. package/dist/configuration.js +8 -0
  52. package/dist/models/create-tenant-db-config-request-dto.d.ts +30 -0
  53. package/dist/models/create-tenant-db-config-request-dto.js +15 -0
  54. package/dist/models/index.d.ts +3 -0
  55. package/dist/models/index.js +3 -0
  56. package/dist/models/invite-class.d.ts +12 -12
  57. package/dist/models/publish-dashboard-request-dto.d.ts +34 -0
  58. package/dist/models/publish-dashboard-request-dto.js +19 -0
  59. package/dist/models/revert-analysis-request-dto.d.ts +34 -0
  60. package/dist/models/revert-analysis-request-dto.js +19 -0
  61. package/dist/models/user-class.d.ts +8 -8
  62. package/models/create-tenant-db-config-request-dto.ts +36 -0
  63. package/models/index.ts +3 -0
  64. package/models/invite-class.ts +12 -12
  65. package/models/publish-dashboard-request-dto.ts +43 -0
  66. package/models/revert-analysis-request-dto.ts +43 -0
  67. package/models/user-class.ts +8 -8
  68. package/package.json +1 -1
@@ -35,6 +35,7 @@ models/create-dashboard-request-dto.ts
35
35
  models/create-dashboard-response-class.ts
36
36
  models/create-data-report-request-dto.ts
37
37
  models/create-data-report-response-class.ts
38
+ models/create-tenant-db-config-request-dto.ts
38
39
  models/create-tenant-request-dto.ts
39
40
  models/custom-field-dto.ts
40
41
  models/custom-schema-class.ts
@@ -85,7 +86,9 @@ models/org-invitation-class.ts
85
86
  models/org-invitation-response-class.ts
86
87
  models/organization-class.ts
87
88
  models/permission-class.ts
89
+ models/publish-dashboard-request-dto.ts
88
90
  models/re-invite-org-request-dto.ts
91
+ models/revert-analysis-request-dto.ts
89
92
  models/role-class.ts
90
93
  models/run-data-report-request-dto.ts
91
94
  models/run-data-report-response-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.28.0 --save
20
+ npm install @emilgroup/tenant-sdk-node@1.28.1-beta.1 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/tenant-sdk-node@1.28.0
24
+ yarn add @emilgroup/tenant-sdk-node@1.28.1-beta.1
25
25
  ```
26
26
 
27
27
  And then you can import `UsersApi`.
@@ -43,7 +43,7 @@ const FormData = require('form-data');
43
43
  export const CustomSchemaApiAxiosParamCreator = function (configuration?: Configuration) {
44
44
  return {
45
45
  /**
46
- * This will create an custom schema for tenant in the database. Custom schema are extra fields that tenant added to his entity and we need to validate this fields using the created schema.
46
+ * This will create an custom schema for tenant in the database. Custom schema are extra fields that tenant added to his entity and we need to validate this fields using the created schema. **Required Permissions** \"tenant-management.custom-schemas.create\"
47
47
  * @summary Create the custom-schema
48
48
  * @param {CreateCustomSchemaRequestDto} createCustomSchemaRequestDto
49
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -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. **Required Permissions** \"tenant-management.custom-schemas.view\"
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,7 +140,7 @@ 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. **Required Permissions** \"tenant-management.custom-schemas.view\"
144
144
  * @summary List custom-schemas
145
145
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
146
146
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -216,7 +216,7 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
216
216
  };
217
217
  },
218
218
  /**
219
- * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
219
+ * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.custom-schemas.update\"
220
220
  * @summary Update the custom-schema
221
221
  * @param {string} code
222
222
  * @param {UpdateCustomSchemaRequestDto} updateCustomSchemaRequestDto
@@ -277,7 +277,7 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
277
277
  const localVarAxiosParamCreator = CustomSchemaApiAxiosParamCreator(configuration)
278
278
  return {
279
279
  /**
280
- * This will create an custom schema for tenant in the database. Custom schema are extra fields that tenant added to his entity and we need to validate this fields using the created schema.
280
+ * This will create an custom schema for tenant in the database. Custom schema are extra fields that tenant added to his entity and we need to validate this fields using the created schema. **Required Permissions** \"tenant-management.custom-schemas.create\"
281
281
  * @summary Create the custom-schema
282
282
  * @param {CreateCustomSchemaRequestDto} createCustomSchemaRequestDto
283
283
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -289,7 +289,7 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
289
289
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
290
290
  },
291
291
  /**
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.
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. **Required Permissions** \"tenant-management.custom-schemas.view\"
293
293
  * @summary Retrieve the custom-schema
294
294
  * @param {string} code Unique identifier for the object.
295
295
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -302,7 +302,7 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
302
302
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
303
303
  },
304
304
  /**
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.
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. **Required Permissions** \"tenant-management.custom-schemas.view\"
306
306
  * @summary List custom-schemas
307
307
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
308
308
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -320,7 +320,7 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
320
320
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
321
321
  },
322
322
  /**
323
- * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
323
+ * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.custom-schemas.update\"
324
324
  * @summary Update the custom-schema
325
325
  * @param {string} code
326
326
  * @param {UpdateCustomSchemaRequestDto} updateCustomSchemaRequestDto
@@ -343,7 +343,7 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
343
343
  const localVarFp = CustomSchemaApiFp(configuration)
344
344
  return {
345
345
  /**
346
- * This will create an custom schema for tenant in the database. Custom schema are extra fields that tenant added to his entity and we need to validate this fields using the created schema.
346
+ * This will create an custom schema for tenant in the database. Custom schema are extra fields that tenant added to his entity and we need to validate this fields using the created schema. **Required Permissions** \"tenant-management.custom-schemas.create\"
347
347
  * @summary Create the custom-schema
348
348
  * @param {CreateCustomSchemaRequestDto} createCustomSchemaRequestDto
349
349
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -354,7 +354,7 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
354
354
  return localVarFp.createCustomSchema(createCustomSchemaRequestDto, authorization, options).then((request) => request(axios, basePath));
355
355
  },
356
356
  /**
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.
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. **Required Permissions** \"tenant-management.custom-schemas.view\"
358
358
  * @summary Retrieve the custom-schema
359
359
  * @param {string} code Unique identifier for the object.
360
360
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -366,7 +366,7 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
366
366
  return localVarFp.getCustomSchema(code, authorization, expand, options).then((request) => request(axios, basePath));
367
367
  },
368
368
  /**
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.
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. **Required Permissions** \"tenant-management.custom-schemas.view\"
370
370
  * @summary List custom-schemas
371
371
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
372
372
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -383,7 +383,7 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
383
383
  return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
384
384
  },
385
385
  /**
386
- * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
386
+ * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.custom-schemas.update\"
387
387
  * @summary Update the custom-schema
388
388
  * @param {string} code
389
389
  * @param {UpdateCustomSchemaRequestDto} updateCustomSchemaRequestDto
@@ -545,7 +545,7 @@ export interface CustomSchemaApiUpdateCustomSchemaRequest {
545
545
  */
546
546
  export class CustomSchemaApi extends BaseAPI {
547
547
  /**
548
- * This will create an custom schema for tenant in the database. Custom schema are extra fields that tenant added to his entity and we need to validate this fields using the created schema.
548
+ * This will create an custom schema for tenant in the database. Custom schema are extra fields that tenant added to his entity and we need to validate this fields using the created schema. **Required Permissions** \"tenant-management.custom-schemas.create\"
549
549
  * @summary Create the custom-schema
550
550
  * @param {CustomSchemaApiCreateCustomSchemaRequest} requestParameters Request parameters.
551
551
  * @param {*} [options] Override http request option.
@@ -557,7 +557,7 @@ export class CustomSchemaApi extends BaseAPI {
557
557
  }
558
558
 
559
559
  /**
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.
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. **Required Permissions** \"tenant-management.custom-schemas.view\"
561
561
  * @summary Retrieve the custom-schema
562
562
  * @param {CustomSchemaApiGetCustomSchemaRequest} requestParameters Request parameters.
563
563
  * @param {*} [options] Override http request option.
@@ -569,7 +569,7 @@ export class CustomSchemaApi extends BaseAPI {
569
569
  }
570
570
 
571
571
  /**
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.
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. **Required Permissions** \"tenant-management.custom-schemas.view\"
573
573
  * @summary List custom-schemas
574
574
  * @param {CustomSchemaApiListCustomSchemasRequest} requestParameters Request parameters.
575
575
  * @param {*} [options] Override http request option.
@@ -581,7 +581,7 @@ export class CustomSchemaApi extends BaseAPI {
581
581
  }
582
582
 
583
583
  /**
584
- * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
584
+ * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.custom-schemas.update\"
585
585
  * @summary Update the custom-schema
586
586
  * @param {CustomSchemaApiUpdateCustomSchemaRequest} requestParameters Request parameters.
587
587
  * @param {*} [options] Override http request option.