@digital-ai/dot-components 4.16.2 → 4.17.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 (31) hide show
  1. package/index.esm.js +461 -200
  2. package/package.json +1 -1
  3. package/src/lib/components/analytics/dashboard-utils/DashboardUtils.d.ts +2 -0
  4. package/src/lib/components/analytics/metadata-api/MetadataApiProvider.d.ts +4 -3
  5. package/src/lib/components/analytics/metadata-api/openapi/index.d.ts +7 -0
  6. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardCopyBody.d.ts +4 -0
  7. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardCreateBody.d.ts +4 -4
  8. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardPatchBody.d.ts +4 -4
  9. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardPutBody.d.ts +4 -4
  10. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardView.d.ts +4 -4
  11. package/src/lib/components/analytics/metadata-api/openapi/models/Entity.d.ts +1 -0
  12. package/src/lib/components/analytics/metadata-api/openapi/models/Error.d.ts +1 -1
  13. package/src/lib/components/analytics/metadata-api/openapi/models/HealthCheckResponse.d.ts +4 -0
  14. package/src/lib/components/analytics/metadata-api/openapi/models/OriginInstance.d.ts +1 -0
  15. package/src/lib/components/analytics/metadata-api/openapi/models/ProductConfigurationItem.d.ts +5 -0
  16. package/src/lib/components/analytics/metadata-api/openapi/models/ProductConfigurationItemCreate.d.ts +8 -0
  17. package/src/lib/components/analytics/metadata-api/openapi/models/ProductOrigin.d.ts +10 -0
  18. package/src/lib/components/analytics/metadata-api/openapi/models/ProductView.d.ts +14 -0
  19. package/src/lib/components/analytics/metadata-api/openapi/models/ProductsResponse.d.ts +4 -0
  20. package/src/lib/components/analytics/metadata-api/openapi/services/BiService.d.ts +12 -6
  21. package/src/lib/components/analytics/metadata-api/openapi/services/CategoriesService.d.ts +4 -2
  22. package/src/lib/components/analytics/metadata-api/openapi/services/DashboardsService.d.ts +65 -20
  23. package/src/lib/components/analytics/metadata-api/openapi/services/EntitiesService.d.ts +10 -5
  24. package/src/lib/components/analytics/metadata-api/openapi/services/EntityAttributesService.d.ts +12 -6
  25. package/src/lib/components/analytics/metadata-api/openapi/services/EntityClassService.d.ts +10 -5
  26. package/src/lib/components/analytics/metadata-api/openapi/services/HelpContentService.d.ts +10 -5
  27. package/src/lib/components/analytics/metadata-api/openapi/services/MrProxyService.d.ts +40 -0
  28. package/src/lib/components/analytics/metadata-api/openapi/services/OriginInstancesService.d.ts +10 -5
  29. package/src/lib/components/analytics/metadata-api/openapi/services/OriginsService.d.ts +10 -5
  30. package/src/lib/components/analytics/metadata-api/openapi/services/ProductsService.d.ts +53 -0
  31. package/src/lib/components/analytics/metadata-api/openapi/services/UtilityService.d.ts +10 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital-ai/dot-components",
3
- "version": "4.16.2",
3
+ "version": "4.17.1",
4
4
  "private": false,
5
5
  "license": "SEE LICENSE IN <LICENSE.md>",
6
6
  "contributors": [
@@ -0,0 +1,2 @@
1
+ import { DashboardView } from '../metadata-api/openapi';
2
+ export declare const editInProgressByUser: (dashboard: DashboardView, userId: string) => boolean;
@@ -7,15 +7,16 @@ export interface MetadataApiProviderProps {
7
7
  token?: string;
8
8
  }
9
9
  interface DotMetadataApiContextProps {
10
+ createInProgressDashboard: (dashboardId: string, dashboard: DashboardPatchBody, isSync?: boolean) => Promise<DashboardView>;
10
11
  dashboardSearchLoading: boolean;
11
12
  dashboardsError: ApiError;
12
13
  dashboardsLoading: boolean;
13
- deleteDashboard: (dashboardId: string) => Promise<boolean>;
14
+ deleteDashboard: (dashboard: DashboardView) => Promise<boolean>;
14
15
  duplicateDashboard: (dashboardId: string, dashboard: DashboardCopyBody) => Promise<DashboardView>;
15
16
  favoriteDashboard: (dashboardId: string, favoriteValue: boolean) => Promise<DashboardView>;
16
17
  getAuthors: (appType: string, publishedOnly?: boolean) => Promise<Author[]>;
17
18
  getCategories: (appType: string, publishedOnly?: boolean) => Promise<string[]>;
18
- getDashboard: (dashboardId: string, viewModified?: boolean) => Promise<DashboardView>;
19
+ getDashboard: (dashboardId: string) => Promise<DashboardView>;
19
20
  getDashboardHelpContent: (helpContentId: string) => Promise<string>;
20
21
  metadataLoading: boolean;
21
22
  openedDashboardDetails: DashboardView;
@@ -26,7 +27,7 @@ interface DotMetadataApiContextProps {
26
27
  setOpenedDashboardDetails: (dashboard: DashboardView) => void;
27
28
  setOverrideAccountId: (accountId: string) => void;
28
29
  setToken: (token: string) => void;
29
- updateDashboard: (dashboardId: string, dashboard: DashboardPatchBody, isSync?: boolean) => Promise<DashboardView>;
30
+ updateDashboard: (dashboard: DashboardView, updatePayload: DashboardPatchBody, isSync?: boolean) => Promise<DashboardView>;
30
31
  }
31
32
  interface DashboardFilters {
32
33
  authorFullname?: string;
@@ -33,6 +33,11 @@ export type { OriginInstancePagedResponse } from './models/OriginInstancePagedRe
33
33
  export type { OriginPagedResponse } from './models/OriginPagedResponse';
34
34
  export type { PaginationHeaders } from './models/PaginationHeaders';
35
35
  export type { PaginationMetadata } from './models/PaginationMetadata';
36
+ export type { ProductConfigurationItem } from './models/ProductConfigurationItem';
37
+ export type { ProductConfigurationItemCreate } from './models/ProductConfigurationItemCreate';
38
+ export type { ProductOrigin } from './models/ProductOrigin';
39
+ export type { ProductsResponse } from './models/ProductsResponse';
40
+ export type { ProductView } from './models/ProductView';
36
41
  export type { SSLoginTokenResponse } from './models/SSLoginTokenResponse';
37
42
  export type { TenantInfo } from './models/TenantInfo';
38
43
  export type { VersionResponse } from './models/VersionResponse';
@@ -43,6 +48,8 @@ export { EntitiesService } from './services/EntitiesService';
43
48
  export { EntityAttributesService } from './services/EntityAttributesService';
44
49
  export { EntityClassService } from './services/EntityClassService';
45
50
  export { HelpContentService } from './services/HelpContentService';
51
+ export { MrProxyService } from './services/MrProxyService';
46
52
  export { OriginInstancesService } from './services/OriginInstancesService';
47
53
  export { OriginsService } from './services/OriginsService';
54
+ export { ProductsService } from './services/ProductsService';
48
55
  export { UtilityService } from './services/UtilityService';
@@ -15,4 +15,8 @@ export type DashboardCopyBody = {
15
15
  * List of categories associated with this dashboard.
16
16
  */
17
17
  categories?: Array<string> | null;
18
+ /**
19
+ * Thumbnail representing dashboard. Base64 encoded SVG.
20
+ */
21
+ thumbnail?: string | null;
18
22
  };
@@ -23,6 +23,10 @@ export type DashboardCreateBody = {
23
23
  * Categories associated with the dashboard.
24
24
  */
25
25
  categories?: Array<string> | null;
26
+ /**
27
+ * Thumbnail representing dashboard. Base64 encoded SVG.
28
+ */
29
+ thumbnail?: string | null;
26
30
  /**
27
31
  * (Internal) BI type of the dashboard.
28
32
  */
@@ -31,10 +35,6 @@ export type DashboardCreateBody = {
31
35
  * (Internal) Whether the dashboard is 'Out-of-the-box'.
32
36
  */
33
37
  is_ootb_dashboard?: boolean | null;
34
- /**
35
- * (Internal) Thumbnail representing dashboard. Base64 encoded SVG.
36
- */
37
- thumbnail?: string | null;
38
38
  /**
39
39
  * (Internal) ID of the dashboard in the BI tool.
40
40
  */
@@ -23,6 +23,10 @@ export type DashboardPatchBody = {
23
23
  * App types that can be targeted by the dashboard.
24
24
  */
25
25
  target_apps?: Array<'AGILITY' | 'RELEASE' | 'DEPLOY' | 'CONTINUOUSTEST' | 'TEAMFORGE' | 'CHANGERISKPREDICTION' | 'APPLICATIONSECURITY'> | null;
26
+ /**
27
+ * Thumbnail representing dashboard. Base64 encoded SVG.
28
+ */
29
+ thumbnail?: string | null;
26
30
  /**
27
31
  * (Internal) BI type of the dashboard.
28
32
  */
@@ -31,10 +35,6 @@ export type DashboardPatchBody = {
31
35
  * (Internal) Whether the dashboard is 'Out-of-the-box'.
32
36
  */
33
37
  is_ootb_dashboard?: boolean | null;
34
- /**
35
- * (Internal) Thumbnail representing dashboard. Base64 encoded SVG.
36
- */
37
- thumbnail?: string | null;
38
38
  /**
39
39
  * (Internal) ID of the dashboard in the BI tool.
40
40
  */
@@ -23,6 +23,10 @@ export type DashboardPutBody = {
23
23
  * App types that can be targeted by the dashboard.
24
24
  */
25
25
  target_apps: Array<'AGILITY' | 'RELEASE' | 'DEPLOY' | 'CONTINUOUSTEST' | 'TEAMFORGE' | 'CHANGERISKPREDICTION' | 'APPLICATIONSECURITY'>;
26
+ /**
27
+ * Thumbnail representing dashboard. Base64 encoded SVG.
28
+ */
29
+ thumbnail: string;
26
30
  /**
27
31
  * (Internal) BI type of the dashboard.
28
32
  */
@@ -31,10 +35,6 @@ export type DashboardPutBody = {
31
35
  * (Internal) Whether the dashboard is 'Out-of-the-box'.
32
36
  */
33
37
  is_ootb_dashboard?: boolean | null;
34
- /**
35
- * (Internal) Thumbnail representing dashboard. Base64 encoded SVG.
36
- */
37
- thumbnail?: string | null;
38
38
  /**
39
39
  * (Internal) ID of the dashboard in the BI tool.
40
40
  */
@@ -100,13 +100,13 @@ export type DashboardView = {
100
100
  */
101
101
  updated_dt?: string | null;
102
102
  /**
103
- * Whether a published dashboard is currently being modified.
103
+ * Current in-progress changes for a published dashboard.
104
104
  */
105
- is_being_modified?: boolean | null;
105
+ in_progress_changes?: DashboardView;
106
106
  /**
107
- * The platform id of the author currently modifying the dashboard.
107
+ * Id of the original dashboard if this is in-progress changes.
108
108
  */
109
- modified_author_id?: string | null;
109
+ parent_id?: string | null;
110
110
  };
111
111
  export declare namespace DashboardView {
112
112
  /**
@@ -2,6 +2,7 @@ export type Entity = {
2
2
  name: string;
3
3
  description: string;
4
4
  origin_instance_id?: string | null;
5
+ origin_instance_unique_string?: string | null;
5
6
  created_dt?: string | null;
6
7
  id?: string | null;
7
8
  };
@@ -14,5 +14,5 @@ export type Error = {
14
14
  /**
15
15
  * Errors
16
16
  */
17
- errors?: any;
17
+ errors?: Record<string, any>;
18
18
  };
@@ -6,4 +6,8 @@ export type HealthCheckResponse = {
6
6
  repository: string;
7
7
  updated: string;
8
8
  version: string;
9
+ /**
10
+ * ISO-formatted datetime of when health was assessed
11
+ */
12
+ evaluated?: string;
9
13
  };
@@ -1,6 +1,7 @@
1
1
  export type OriginInstance = {
2
2
  name: string;
3
3
  description: string;
4
+ unique_string: string;
4
5
  origin_id?: string | null;
5
6
  created_dt?: string | null;
6
7
  id?: string | null;
@@ -0,0 +1,5 @@
1
+ export type ProductConfigurationItem = {
2
+ configuration_id?: string | null;
3
+ type_name: string;
4
+ origin_id: string;
5
+ };
@@ -0,0 +1,8 @@
1
+ export type ProductConfigurationItemCreate = {
2
+ data: Record<string, any>;
3
+ description?: string | null;
4
+ id?: string | null;
5
+ name: string;
6
+ origin_id: string;
7
+ type_name: string;
8
+ };
@@ -0,0 +1,10 @@
1
+ import type { ProductConfigurationItem } from './ProductConfigurationItem';
2
+ export type ProductOrigin = {
3
+ configuration_types?: Array<string>;
4
+ created_dt?: string | null;
5
+ id?: string | null;
6
+ is_platform_origin?: boolean;
7
+ name: string;
8
+ configuration_items?: Array<ProductConfigurationItem>;
9
+ updated_dt?: string | null;
10
+ };
@@ -0,0 +1,14 @@
1
+ import type { ProductOrigin } from './ProductOrigin';
2
+ export type ProductView = {
3
+ created_dt?: string | null;
4
+ dashboard_origins?: Array<string> | null;
5
+ external_id?: string | null;
6
+ id?: string | null;
7
+ name: string;
8
+ origins?: Array<ProductOrigin>;
9
+ updated_dt?: string | null;
10
+ /**
11
+ * Effective configuration types, calculated from associated origins.
12
+ */
13
+ effective_configuration_types: Array<string>;
14
+ };
@@ -0,0 +1,4 @@
1
+ import type { ProductView } from './ProductView';
2
+ export type ProductsResponse = {
3
+ products?: Array<ProductView>;
4
+ };
@@ -8,52 +8,58 @@ export declare class BiService {
8
8
  /**
9
9
  * Digital.ai Business Intelligence engine details.
10
10
  * Details about the Digital.ai Business Intelligence engine supporting the authenticated account.
11
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
11
12
  * @returns BiServerResponse OK
12
13
  * @returns Error Default error response
13
14
  * @throws ApiError
14
15
  */
15
- static getBiService(): Promise<BiServerResponse | Error>;
16
+ static getBiService(xDigitalaiAccountId?: string): Promise<BiServerResponse | Error>;
16
17
  /**
17
18
  * @deprecated
18
19
  * Obtain a Guest Token from the superset instance.
19
20
  * Get a `guest token`, suitable for passing to the superset EmbeddingSDK.
20
21
  * @param requestBody
22
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
21
23
  * @returns Error Default error response
22
24
  * @throws ApiError
23
25
  */
24
- static postBiService(requestBody: GuestTokenRequest): Promise<Error>;
26
+ static postBiService(requestBody: GuestTokenRequest, xDigitalaiAccountId?: string): Promise<Error>;
25
27
  /**
26
28
  * @deprecated
27
29
  * Obtain a standard Bearer Token from Superset.
28
30
  * Get a bearer token, suitable for directly using the Superset APIs.
31
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
29
32
  * @returns SSLoginTokenResponse OK
30
33
  * @returns Error Default error response
31
34
  * @throws ApiError
32
35
  */
33
- static getBiService1(): Promise<SSLoginTokenResponse | Error>;
36
+ static getBiService1(xDigitalaiAccountId?: string): Promise<SSLoginTokenResponse | Error>;
34
37
  /**
35
38
  * Obtain an identity token from Microstrategy.
36
39
  * Get a Microstrategy identity token, used for creating a session in another application.
40
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
37
41
  * @returns MSTRLoginTokenResponse OK
38
42
  * @returns Error Default error response
39
43
  * @throws ApiError
40
44
  */
41
- static getBiService2(): Promise<MSTRLoginTokenResponse | Error>;
45
+ static getBiService2(xDigitalaiAccountId?: string): Promise<MSTRLoginTokenResponse | Error>;
42
46
  /**
43
47
  * @deprecated
44
48
  * Passthru to the superset server instance's API.
45
49
  * [EXPERIMENTAL] - Proxies a call through to the superset instance.
46
50
  * @param path
51
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
47
52
  * @returns Error Default error response
48
53
  * @throws ApiError
49
54
  */
50
- static getBiService3(path: string): Promise<Error>;
55
+ static getBiService3(path: string, xDigitalaiAccountId?: string): Promise<Error>;
51
56
  /**
52
57
  * Return info on MSTR server for this tenant.
53
58
  * Return info on MSTR server for this tenant.
59
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
54
60
  * @returns MSTRServerResponse OK
55
61
  * @returns Error Default error response
56
62
  * @throws ApiError
57
63
  */
58
- static getBiService4(): Promise<MSTRServerResponse | Error>;
64
+ static getBiService4(xDigitalaiAccountId?: string): Promise<MSTRServerResponse | Error>;
59
65
  }
@@ -5,18 +5,20 @@ export declare class CategoriesService {
5
5
  /**
6
6
  * Get a list of Categories by Application type.
7
7
  * Return a list of Categories by Application type.
8
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
8
9
  * @returns AllCategoriesResponse OK
9
10
  * @returns Error Default error response
10
11
  * @throws ApiError
11
12
  */
12
- static getCategoriesService(): Promise<AllCategoriesResponse | Error>;
13
+ static getCategories(xDigitalaiAccountId?: string): Promise<AllCategoriesResponse | Error>;
13
14
  /**
14
15
  * Get Categories for a single application type.
15
16
  * Return all Categories for a single application type.
16
17
  * @param appType
18
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
17
19
  * @returns CategoriesResponse OK
18
20
  * @returns Error Default error response
19
21
  * @throws ApiError
20
22
  */
21
- static getCategoriesService1(appType: string): Promise<CategoriesResponse | Error>;
23
+ static getCategoryByAppType(appType: string, xDigitalaiAccountId?: string): Promise<CategoriesResponse | Error>;
22
24
  }
@@ -10,12 +10,13 @@ export declare class DashboardsService {
10
10
  /**
11
11
  * Get a list of Dashboards.
12
12
  * Return a list of Dashboard definitions, filtered by query parameters.
13
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
13
14
  * @param start Offset of the first fetched item.
14
15
  * @param count Maximum number of fetched items.
15
16
  * @param sort Sort ordering to apply to the query.
16
17
  * @param filter List of filters (each filter is a separate query param, and they are OR'ed).
17
18
  *
18
- * * **Filterable field names**: author_fullname, author_id, bi_type, categories, created_dt, description, external_embedding_id, external_id, id, is_ootb_dashboard, lifecycle_state, modified_parent_id, name, target_apps, updated_by_fullname, updated_by_id, updated_dt
19
+ * * **Filterable field names**: author_fullname, author_id, bi_type, categories, created_dt, dataset_id, description, external_embedding_id, external_id, id, is_ootb_dashboard, lifecycle_state, name, target_apps, updated_by_fullname, updated_by_id, updated_dt
19
20
  * * **Searchable field names**: author_fullname, categories, description, name, updated_by_fullname
20
21
  *
21
22
  * @param favorite Boolean flag to only return dashboards marked as favorites.
@@ -29,111 +30,155 @@ export declare class DashboardsService {
29
30
  * @param lifecycleState String match on Dashboard lifecycle state - 'DRAFT' or 'PUBLISHED'.
30
31
  * @param name String match on Dashboard name.
31
32
  * @param targetApp String match on the Dashboard target application - 'AGILITY', 'CONTINUOUSTEST', 'DEPLOY', 'RELEASE', 'TEAMFORGE', 'CHANGERISKPREDICTION', or APPLICATIONSECURITY.
33
+ * @param viewModified Return dashboards with modified changes if they exist for this user.
32
34
  * @returns DashboardViewPagedResponse OK
33
35
  * @returns Error Default error response
34
36
  * @throws ApiError
35
37
  */
36
- static getDashboardsService(start?: number, count?: number, sort?: string, filter?: Array<string>, favorite?: boolean, q?: string, authorFullname?: string, authorId?: string, biType?: string, description?: string, id?: string, isOotbDashboard?: boolean, lifecycleState?: string, name?: string, targetApp?: string): Promise<DashboardViewPagedResponse | Error>;
38
+ static getDashboards(xDigitalaiAccountId?: string, start?: number, count?: number, sort?: string, filter?: Array<string>, favorite?: boolean, q?: string, authorFullname?: string, authorId?: string, biType?: string, description?: string, id?: string, isOotbDashboard?: boolean, lifecycleState?: string, name?: string, targetApp?: string, viewModified?: boolean): Promise<DashboardViewPagedResponse | Error>;
37
39
  /**
38
40
  * Create a Dashboard definition.
39
41
  * Creates a Dashboard definition.
40
42
  * @param requestBody
43
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
41
44
  * @returns DashboardView Dashboard created.
42
45
  * @returns Error Default error response
43
46
  * @throws ApiError
44
47
  */
45
- static postDashboardsService(requestBody: DashboardCreateBody): Promise<DashboardView | Error>;
48
+ static postDashboards(requestBody: DashboardCreateBody, xDigitalaiAccountId?: string): Promise<DashboardView | Error>;
46
49
  /**
47
50
  * Get one Dashboard definition.
48
51
  * Return a single Dashboard definition, selected by ID.
49
52
  * @param dashboardId
50
- * @param viewModified Return the dashboard with modified changes if they exist for this user.
53
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
51
54
  * @returns DashboardView OK
52
55
  * @returns Error Default error response
53
56
  * @throws ApiError
54
57
  */
55
- static getDashboardsService1(dashboardId: string, viewModified?: boolean): Promise<DashboardView | Error>;
58
+ static getDashboard(dashboardId: string, xDigitalaiAccountId?: string): Promise<DashboardView | Error>;
56
59
  /**
57
60
  * Sets a single Dashboard definition.
58
61
  * Sets a Dashboard definition, selected by ID.
59
62
  * @param dashboardId
60
63
  * @param requestBody
64
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
61
65
  * @param isSync Sync the dashboard with BI
62
66
  * @returns DashboardView Dashboard updated.
63
67
  * @returns Error Default error response
64
68
  * @throws ApiError
65
69
  */
66
- static putDashboardsService(dashboardId: string, requestBody: DashboardPutBody, isSync?: boolean): Promise<DashboardView | Error>;
70
+ static putDashboard(dashboardId: string, requestBody: DashboardPutBody, xDigitalaiAccountId?: string, isSync?: boolean): Promise<DashboardView | Error>;
67
71
  /**
68
72
  * Updates a single Dashboard definition.
69
73
  * Updates a Dashboard definition, selected by ID.
70
74
  * @param dashboardId
71
75
  * @param requestBody
76
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
72
77
  * @param isSync Sync the dashboard with BI
73
78
  * @returns DashboardView Dashboard updated.
74
79
  * @returns Error Default error response
75
80
  * @throws ApiError
76
81
  */
77
- static patchDashboardsService(dashboardId: string, requestBody: DashboardPatchBody, isSync?: boolean): Promise<DashboardView | Error>;
82
+ static patchDashboard(dashboardId: string, requestBody: DashboardPatchBody, xDigitalaiAccountId?: string, isSync?: boolean): Promise<DashboardView | Error>;
78
83
  /**
79
84
  * Delete a Dashboard definition.
80
85
  * Deletes a single Dashboard definition, selected by ID.
81
86
  * @param dashboardId
87
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
82
88
  * @returns Error Default error response
83
89
  * @throws ApiError
84
90
  */
85
- static deleteDashboardsService(dashboardId: string): Promise<Error>;
91
+ static deleteDashboard(dashboardId: string, xDigitalaiAccountId?: string): Promise<Error>;
86
92
  /**
87
- * Publish modifications to a dashboard
88
- * Publish modifications to a dashboard
93
+ * Get one in-progress Dashboard definition.
94
+ * Return a single Dashboard definition with pending changes, selected by ID.
89
95
  * @param dashboardId
96
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
97
+ * @returns DashboardView OK
98
+ * @returns Error Default error response
99
+ * @throws ApiError
100
+ */
101
+ static getInProgressDashboard(dashboardId: string, xDigitalaiAccountId?: string): Promise<DashboardView | Error>;
102
+ /**
103
+ * Create an edit-in-progress version of the dashboard
104
+ * Create an edit-in-progress version of the dashboard while leaving the original unchanged.
105
+ * @param dashboardId
106
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
90
107
  * @param requestBody
108
+ * @returns DashboardView Edit-in-progress dashboard created.
109
+ * @returns Error Default error response
110
+ * @throws ApiError
111
+ */
112
+ static postInProgressDashboard(dashboardId: string, xDigitalaiAccountId?: string, requestBody?: DashboardPatchBody): Promise<DashboardView | Error>;
113
+ /**
114
+ * Sets a single Dashboard in-progress definition.
115
+ * Sets a Dashboard definition with pending changes, selected by ID.
116
+ * @param dashboardId
117
+ * @param requestBody
118
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
119
+ * @param isSync Sync the dashboard with BI
120
+ * @returns DashboardView Dashboard updated.
121
+ * @returns Error Default error response
122
+ * @throws ApiError
123
+ */
124
+ static putInProgressDashboard(dashboardId: string, requestBody: DashboardPutBody, xDigitalaiAccountId?: string, isSync?: boolean): Promise<DashboardView | Error>;
125
+ /**
126
+ * Updates a single Dashboard in-progress definition.
127
+ * Updates a Dashboard definition with pending changes, selected by ID.
128
+ * @param dashboardId
129
+ * @param requestBody
130
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
91
131
  * @param isSync Sync the dashboard with BI
92
- * @returns DashboardView Dashboard published.
132
+ * @returns DashboardView Dashboard updated.
93
133
  * @returns Error Default error response
94
134
  * @throws ApiError
95
135
  */
96
- static postDashboardsService1(dashboardId: string, requestBody: DashboardPatchBody, isSync?: boolean): Promise<DashboardView | Error>;
136
+ static patchInProgressDashboard(dashboardId: string, requestBody: DashboardPatchBody, xDigitalaiAccountId?: string, isSync?: boolean): Promise<DashboardView | Error>;
97
137
  /**
98
- * Revert modifications to a dashboard
99
- * Revert modifications to a dashboard
138
+ * Revert in-progress changes.
139
+ * Discards edit in progress dashboard changes.
100
140
  * @param dashboardId
101
- * @returns DashboardView Dashboard changes reverted.
141
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
142
+ * @param publish Publish changes to the original dashboard and delete the in-progress version.
102
143
  * @returns Error Default error response
103
144
  * @throws ApiError
104
145
  */
105
- static postDashboardsService2(dashboardId: string): Promise<DashboardView | Error>;
146
+ static deleteInProgressDashboard(dashboardId: string, xDigitalaiAccountId?: string, publish?: boolean): Promise<Error>;
106
147
  /**
107
148
  * Create a copy of existing dashboard
108
149
  * Create a copy of existing dashboard
109
150
  * @param dashboardId
151
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
110
152
  * @param requestBody
111
153
  * @returns DashboardView Dashboard copied.
112
154
  * @returns Error Default error response
113
155
  * @throws ApiError
114
156
  */
115
- static postDashboardsService3(dashboardId: string, requestBody?: DashboardCopyBody): Promise<DashboardView | Error>;
157
+ static copyDashboard(dashboardId: string, xDigitalaiAccountId?: string, requestBody?: DashboardCopyBody): Promise<DashboardView | Error>;
116
158
  /**
117
159
  * Favorite a dashboard
118
160
  * Favorite a dashboard
119
161
  * @param dashboardId
162
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
120
163
  * @returns DashboardView Dashboard favorited.
121
164
  * @returns Error Default error response
122
165
  * @throws ApiError
123
166
  */
124
- static postDashboardsService4(dashboardId: string): Promise<DashboardView | Error>;
167
+ static favoriteDashboard(dashboardId: string, xDigitalaiAccountId?: string): Promise<DashboardView | Error>;
125
168
  /**
126
169
  * Un-favorite a dashboard
127
170
  * Un-favorite a dashboard
128
171
  * @param dashboardId
172
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
129
173
  * @returns DashboardView Dashboard un-favorited.
130
174
  * @returns Error Default error response
131
175
  * @throws ApiError
132
176
  */
133
- static deleteDashboardsService1(dashboardId: string): Promise<DashboardView | Error>;
177
+ static unfavoriteDashboard(dashboardId: string, xDigitalaiAccountId?: string): Promise<DashboardView | Error>;
134
178
  /**
135
179
  * Get Metadata (categories and authors)
136
180
  * Return all Metadata for dashboards optionally filtered by the given parameters
181
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
137
182
  * @param filter List of filters (each filter is a separate query param, and they are OR'ed).
138
183
  *
139
184
  * * **Filterable field names**: author_fullname, bi_type, categories, created_dt, description, is_ootb_dashboard, lifecycle_state, name, updated_by_fullname, updated_dt
@@ -147,5 +192,5 @@ export declare class DashboardsService {
147
192
  * @returns Error Default error response
148
193
  * @throws ApiError
149
194
  */
150
- static getDashboardsMetadata(filter?: Array<string>, targetApp?: string, biType?: string, isOotbDashboard?: boolean, lifecycleState?: string): Promise<MetadataResponse | Error>;
195
+ static getDashboardsMetadata(xDigitalaiAccountId?: string, filter?: Array<string>, targetApp?: string, biType?: string, isOotbDashboard?: boolean, lifecycleState?: string): Promise<MetadataResponse | Error>;
151
196
  }
@@ -5,6 +5,7 @@ export declare class EntitiesService {
5
5
  /**
6
6
  * Get a list of Entities.
7
7
  * Return a list of Entities, filtered by query parameters.
8
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
8
9
  * @param start Offset of the first fetched item.
9
10
  * @param count Maximum number of fetched items.
10
11
  * @param sort Sort ordering to apply to the query.
@@ -17,41 +18,45 @@ export declare class EntitiesService {
17
18
  * @returns Error Default error response
18
19
  * @throws ApiError
19
20
  */
20
- static getEntitiesService(start?: number, count?: number, sort?: string, name?: string, description?: string, originInstanceName?: string, q?: string, id?: string): Promise<EntityPagedResponse | Error>;
21
+ static getEntitiesService(xDigitalaiAccountId?: string, start?: number, count?: number, sort?: string, name?: string, description?: string, originInstanceName?: string, q?: string, id?: string): Promise<EntityPagedResponse | Error>;
21
22
  /**
22
23
  * Create an Entity.
23
24
  * Creates an Entity, owned by the authenticated API user.
24
25
  * @param requestBody
26
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
25
27
  * @returns Entity Entity created.
26
28
  * @returns Error Default error response
27
29
  * @throws ApiError
28
30
  */
29
- static postEntitiesService(requestBody: Entity): Promise<Entity | Error>;
31
+ static postEntitiesService(requestBody: Entity, xDigitalaiAccountId?: string): Promise<Entity | Error>;
30
32
  /**
31
33
  * Get one Entity.
32
34
  * Return a single Entity, selected by ID.
33
35
  * @param id
36
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
34
37
  * @returns Entity OK
35
38
  * @returns Error Default error response
36
39
  * @throws ApiError
37
40
  */
38
- static getEntitiesService1(id: string): Promise<Entity | Error>;
41
+ static getEntitiesService1(id: string, xDigitalaiAccountId?: string): Promise<Entity | Error>;
39
42
  /**
40
43
  * Update a single Entity.
41
44
  * Updates an Entity, selected by ID.
42
45
  * @param id
43
46
  * @param requestBody
47
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
44
48
  * @returns Entity Entity updated.
45
49
  * @returns Error Default error response
46
50
  * @throws ApiError
47
51
  */
48
- static putEntitiesService(id: string, requestBody: Entity): Promise<Entity | Error>;
52
+ static putEntitiesService(id: string, requestBody: Entity, xDigitalaiAccountId?: string): Promise<Entity | Error>;
49
53
  /**
50
54
  * Delete a Entity.
51
55
  * Deletes a single Entity, selected by ID.
52
56
  * @param id
57
+ * @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
53
58
  * @returns Error Default error response
54
59
  * @throws ApiError
55
60
  */
56
- static deleteEntitiesService(id: string): Promise<Error>;
61
+ static deleteEntitiesService(id: string, xDigitalaiAccountId?: string): Promise<Error>;
57
62
  }