@emilgroup/tenant-sdk-node 1.16.1-beta.0 → 1.18.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 (76) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +2 -2
  3. package/api/dashboard-api.ts +663 -0
  4. package/api/dashboard-group-api.ts +663 -0
  5. package/api/invite-users-api.ts +31 -31
  6. package/api/users-api.ts +31 -31
  7. package/api.ts +4 -0
  8. package/base.ts +3 -3
  9. package/dist/api/dashboard-api.d.ts +365 -0
  10. package/dist/api/dashboard-api.js +620 -0
  11. package/dist/api/dashboard-group-api.d.ts +365 -0
  12. package/dist/api/dashboard-group-api.js +620 -0
  13. package/dist/api/invite-users-api.d.ts +31 -31
  14. package/dist/api/invite-users-api.js +16 -16
  15. package/dist/api/users-api.d.ts +31 -31
  16. package/dist/api/users-api.js +16 -16
  17. package/dist/api.d.ts +2 -0
  18. package/dist/api.js +2 -0
  19. package/dist/base.d.ts +2 -2
  20. package/dist/base.js +1 -2
  21. package/dist/models/create-dashboard-group-request-dto.d.ts +30 -0
  22. package/dist/models/create-dashboard-group-request-dto.js +15 -0
  23. package/dist/models/create-dashboard-group-response-class.d.ts +25 -0
  24. package/dist/models/create-dashboard-group-response-class.js +15 -0
  25. package/dist/models/create-dashboard-request-dto.d.ts +48 -0
  26. package/dist/models/create-dashboard-request-dto.js +15 -0
  27. package/dist/models/create-dashboard-response-class.d.ts +25 -0
  28. package/dist/models/create-dashboard-response-class.js +15 -0
  29. package/dist/models/dashboard-class.d.ts +84 -0
  30. package/dist/models/dashboard-class.js +15 -0
  31. package/dist/models/dashboard-group-class.d.ts +66 -0
  32. package/dist/models/dashboard-group-class.js +15 -0
  33. package/dist/models/get-dashboard-group-response-class.d.ts +25 -0
  34. package/dist/models/get-dashboard-group-response-class.js +15 -0
  35. package/dist/models/get-dashboard-response-class.d.ts +25 -0
  36. package/dist/models/get-dashboard-response-class.js +15 -0
  37. package/dist/models/index.d.ts +14 -0
  38. package/dist/models/index.js +14 -0
  39. package/dist/models/invite-class.d.ts +6 -0
  40. package/dist/models/invite-org-request-dto.d.ts +3 -3
  41. package/dist/models/invite-user-request-dto.d.ts +3 -3
  42. package/dist/models/invite-users-request-dto.d.ts +3 -3
  43. package/dist/models/list-dashboard-groups-response-class.d.ts +31 -0
  44. package/dist/models/list-dashboard-groups-response-class.js +15 -0
  45. package/dist/models/list-dashboards-response-class.d.ts +31 -0
  46. package/dist/models/list-dashboards-response-class.js +15 -0
  47. package/dist/models/update-dashboard-group-request-dto.d.ts +30 -0
  48. package/dist/models/update-dashboard-group-request-dto.js +15 -0
  49. package/dist/models/update-dashboard-group-response-class.d.ts +25 -0
  50. package/dist/models/update-dashboard-group-response-class.js +15 -0
  51. package/dist/models/update-dashboard-request-dto.d.ts +48 -0
  52. package/dist/models/update-dashboard-request-dto.js +15 -0
  53. package/dist/models/update-dashboard-response-class.d.ts +25 -0
  54. package/dist/models/update-dashboard-response-class.js +15 -0
  55. package/dist/models/user-class.d.ts +6 -0
  56. package/models/create-dashboard-group-request-dto.ts +36 -0
  57. package/models/create-dashboard-group-response-class.ts +31 -0
  58. package/models/create-dashboard-request-dto.ts +54 -0
  59. package/models/create-dashboard-response-class.ts +31 -0
  60. package/models/dashboard-class.ts +90 -0
  61. package/models/dashboard-group-class.ts +72 -0
  62. package/models/get-dashboard-group-response-class.ts +31 -0
  63. package/models/get-dashboard-response-class.ts +31 -0
  64. package/models/index.ts +14 -0
  65. package/models/invite-class.ts +6 -0
  66. package/models/invite-org-request-dto.ts +3 -3
  67. package/models/invite-user-request-dto.ts +3 -3
  68. package/models/invite-users-request-dto.ts +3 -3
  69. package/models/list-dashboard-groups-response-class.ts +37 -0
  70. package/models/list-dashboards-response-class.ts +37 -0
  71. package/models/update-dashboard-group-request-dto.ts +36 -0
  72. package/models/update-dashboard-group-response-class.ts +31 -0
  73. package/models/update-dashboard-request-dto.ts +54 -0
  74. package/models/update-dashboard-response-class.ts +31 -0
  75. package/models/user-class.ts +6 -0
  76. package/package.json +1 -1
@@ -233,20 +233,20 @@ export const InviteUsersApiAxiosParamCreator = function (configuration?: Configu
233
233
  };
234
234
  },
235
235
  /**
236
- * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
236
+ * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
237
237
  * @summary List invited users
238
238
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
239
239
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
240
240
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
241
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
241
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern</i>
242
242
  * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
243
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
244
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
245
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
243
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: email, expiresOn</i>
244
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: roles, organizations<i>
245
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern</i>
246
246
  * @param {*} [options] Override http request option.
247
247
  * @throws {RequiredError}
248
248
  */
249
- listInvites: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
249
+ listInvites: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
250
250
  const localVarPath = `/tenantservice/v1/users/invites`;
251
251
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
252
252
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -367,20 +367,20 @@ export const InviteUsersApiFp = function(configuration?: Configuration) {
367
367
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
368
368
  },
369
369
  /**
370
- * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
370
+ * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
371
371
  * @summary List invited users
372
372
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
373
373
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
374
374
  * @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.
375
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
375
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern&lt;/i&gt;
376
376
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
377
- * @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.
378
- * @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.
379
- * @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.
377
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: email, expiresOn&lt;/i&gt;
378
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: roles, organizations&lt;i&gt;
379
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern&lt;/i&gt;
380
380
  * @param {*} [options] Override http request option.
381
381
  * @throws {RequiredError}
382
382
  */
383
- async listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvitesResponseClass>> {
383
+ async listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvitesResponseClass>> {
384
384
  const localVarAxiosArgs = await localVarAxiosParamCreator.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
385
385
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
386
386
  },
@@ -439,20 +439,20 @@ export const InviteUsersApiFactory = function (configuration?: Configuration, ba
439
439
  return localVarFp.inviteUsers(inviteUsersRequestDto, authorization, options).then((request) => request(axios, basePath));
440
440
  },
441
441
  /**
442
- * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
442
+ * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
443
443
  * @summary List invited users
444
444
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
445
445
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
446
446
  * @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.
447
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
447
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern&lt;/i&gt;
448
448
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
449
- * @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.
450
- * @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.
451
- * @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.
449
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: email, expiresOn&lt;/i&gt;
450
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: roles, organizations&lt;i&gt;
451
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern&lt;/i&gt;
452
452
  * @param {*} [options] Override http request option.
453
453
  * @throws {RequiredError}
454
454
  */
455
- listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListInvitesResponseClass> {
455
+ listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListInvitesResponseClass> {
456
456
  return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
457
457
  },
458
458
  };
@@ -570,11 +570,11 @@ export interface InviteUsersApiListInvitesRequest {
570
570
  readonly pageToken?: any
571
571
 
572
572
  /**
573
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
574
- * @type {any}
573
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern&lt;/i&gt;
574
+ * @type {string}
575
575
  * @memberof InviteUsersApiListInvites
576
576
  */
577
- readonly filter?: any
577
+ readonly filter?: string
578
578
 
579
579
  /**
580
580
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
@@ -584,25 +584,25 @@ export interface InviteUsersApiListInvitesRequest {
584
584
  readonly search?: any
585
585
 
586
586
  /**
587
- * 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.
588
- * @type {any}
587
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: email, expiresOn&lt;/i&gt;
588
+ * @type {string}
589
589
  * @memberof InviteUsersApiListInvites
590
590
  */
591
- readonly order?: any
591
+ readonly order?: string
592
592
 
593
593
  /**
594
- * 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.
595
- * @type {any}
594
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: roles, organizations&lt;i&gt;
595
+ * @type {string}
596
596
  * @memberof InviteUsersApiListInvites
597
597
  */
598
- readonly expand?: any
598
+ readonly expand?: string
599
599
 
600
600
  /**
601
- * 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.
602
- * @type {any}
601
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern&lt;/i&gt;
602
+ * @type {string}
603
603
  * @memberof InviteUsersApiListInvites
604
604
  */
605
- readonly filters?: any
605
+ readonly filters?: string
606
606
  }
607
607
 
608
608
  /**
@@ -661,7 +661,7 @@ export class InviteUsersApi extends BaseAPI {
661
661
  }
662
662
 
663
663
  /**
664
- * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
664
+ * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
665
665
  * @summary List invited users
666
666
  * @param {InviteUsersApiListInvitesRequest} requestParameters Request parameters.
667
667
  * @param {*} [options] Override http request option.
package/api/users-api.ts CHANGED
@@ -433,20 +433,20 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
433
433
  };
434
434
  },
435
435
  /**
436
- * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
436
+ * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
437
437
  * @summary List users
438
438
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
439
439
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
440
440
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
441
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
441
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, sub, status, organizationId, ern&lt;/i&gt;
442
442
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
443
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
444
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
445
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
443
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: email&lt;/i&gt;
444
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: roles, subscriptions, organizations&lt;i&gt;
445
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, sub, status, organizationId, ern&lt;/i&gt;
446
446
  * @param {*} [options] Override http request option.
447
447
  * @throws {RequiredError}
448
448
  */
449
- listUsers: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
449
+ listUsers: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
450
450
  const localVarPath = `/tenantservice/v1/users`;
451
451
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
452
452
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -610,20 +610,20 @@ export const UsersApiFp = function(configuration?: Configuration) {
610
610
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
611
611
  },
612
612
  /**
613
- * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
613
+ * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
614
614
  * @summary List users
615
615
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
616
616
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
617
617
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
618
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
618
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, sub, status, organizationId, ern&lt;/i&gt;
619
619
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
620
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
621
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
622
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
620
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: email&lt;/i&gt;
621
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: roles, subscriptions, organizations&lt;i&gt;
622
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, sub, status, organizationId, ern&lt;/i&gt;
623
623
  * @param {*} [options] Override http request option.
624
624
  * @throws {RequiredError}
625
625
  */
626
- async listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponseClass>> {
626
+ async listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponseClass>> {
627
627
  const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
628
628
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
629
629
  },
@@ -721,20 +721,20 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
721
721
  return localVarFp.getUser(code, code2, authorization, expand, options).then((request) => request(axios, basePath));
722
722
  },
723
723
  /**
724
- * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
724
+ * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
725
725
  * @summary List users
726
726
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
727
727
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
728
728
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
729
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
729
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, sub, status, organizationId, ern&lt;/i&gt;
730
730
  * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
731
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
732
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
733
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
731
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: email&lt;/i&gt;
732
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: roles, subscriptions, organizations&lt;i&gt;
733
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, sub, status, organizationId, ern&lt;/i&gt;
734
734
  * @param {*} [options] Override http request option.
735
735
  * @throws {RequiredError}
736
736
  */
737
- listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListUsersResponseClass> {
737
+ listUsers(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListUsersResponseClass> {
738
738
  return localVarFp.listUsers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
739
739
  },
740
740
  };
@@ -957,11 +957,11 @@ export interface UsersApiListUsersRequest {
957
957
  readonly pageToken?: any
958
958
 
959
959
  /**
960
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
961
- * @type {any}
960
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, sub, status, organizationId, ern&lt;/i&gt;
961
+ * @type {string}
962
962
  * @memberof UsersApiListUsers
963
963
  */
964
- readonly filter?: any
964
+ readonly filter?: string
965
965
 
966
966
  /**
967
967
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
@@ -971,25 +971,25 @@ export interface UsersApiListUsersRequest {
971
971
  readonly search?: any
972
972
 
973
973
  /**
974
- * 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.
975
- * @type {any}
974
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: email&lt;/i&gt;
975
+ * @type {string}
976
976
  * @memberof UsersApiListUsers
977
977
  */
978
- readonly order?: any
978
+ readonly order?: string
979
979
 
980
980
  /**
981
- * 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.
982
- * @type {any}
981
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: roles, subscriptions, organizations&lt;i&gt;
982
+ * @type {string}
983
983
  * @memberof UsersApiListUsers
984
984
  */
985
- readonly expand?: any
985
+ readonly expand?: string
986
986
 
987
987
  /**
988
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
989
- * @type {any}
988
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, sub, status, organizationId, ern&lt;/i&gt;
989
+ * @type {string}
990
990
  * @memberof UsersApiListUsers
991
991
  */
992
- readonly filters?: any
992
+ readonly filters?: string
993
993
  }
994
994
 
995
995
  /**
@@ -1088,7 +1088,7 @@ export class UsersApi extends BaseAPI {
1088
1088
  }
1089
1089
 
1090
1090
  /**
1091
- * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
1091
+ * Returns a list of users you have previously created. The users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
1092
1092
  * @summary List users
1093
1093
  * @param {UsersApiListUsersRequest} requestParameters Request parameters.
1094
1094
  * @param {*} [options] Override http request option.
package/api.ts CHANGED
@@ -25,6 +25,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
25
25
  // @ts-ignore
26
26
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
27
27
  import { CustomSchemaApi } from './api';
28
+ import { DashboardApi } from './api';
29
+ import { DashboardGroupApi } from './api';
28
30
  import { DataReportApi } from './api';
29
31
  import { DataReportExecutorApi } from './api';
30
32
  import { DefaultApi } from './api';
@@ -40,6 +42,8 @@ import { UsersApi } from './api';
40
42
 
41
43
 
42
44
  export * from './api/custom-schema-api';
45
+ export * from './api/dashboard-api';
46
+ export * from './api/dashboard-group-api';
43
47
  export * from './api/data-report-api';
44
48
  export * from './api/data-report-executor-api';
45
49
  export * from './api/default-api';
package/base.ts CHANGED
@@ -41,7 +41,7 @@ export const COLLECTION_FORMATS = {
41
41
 
42
42
  export interface LoginClass {
43
43
  accessToken: string;
44
- permissions: Array<string>;
44
+ permissions: string;
45
45
  }
46
46
 
47
47
  export enum Environment {
@@ -79,7 +79,7 @@ export class BaseAPI {
79
79
  protected configuration: Configuration;
80
80
  private username?: string;
81
81
  private password?: string;
82
- private permissions: Array<string> = [];
82
+ private permissions?: string;
83
83
 
84
84
  constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
85
85
  if (configuration) {
@@ -151,7 +151,7 @@ export class BaseAPI {
151
151
  }
152
152
 
153
153
  getPermissions(): Array<string> {
154
- return this.permissions;
154
+ return this.permissions.split(',');
155
155
  }
156
156
 
157
157
  async authorize(username: string, password: string): Promise<void> {