@digital-ai/dot-components 3.7.0 → 3.8.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 (98) hide show
  1. package/index.esm.js +2671 -590
  2. package/package.json +1 -1
  3. package/src/lib/components/analytics/dashboard-actions/DashboardActions.d.ts +19 -0
  4. package/src/lib/components/analytics/dashboard-actions/DashboardActions.styles.d.ts +2 -0
  5. package/src/lib/components/analytics/dashboard-actions/DashboardOptionsMenu.d.ts +10 -0
  6. package/src/lib/components/analytics/dashboard-actions/DashboardOptionsMenu.styles.d.ts +1 -0
  7. package/src/lib/components/analytics/dashboard-actions/DashboardPublishConfirm.d.ts +18 -0
  8. package/src/lib/components/analytics/dashboard-actions/DashboardPublishConfirm.styles.d.ts +6 -0
  9. package/src/lib/components/analytics/dashboard-dialog/DashboardDialog.d.ts +30 -0
  10. package/src/lib/components/analytics/dashboard-dialog/DashboardDialog.styles.d.ts +3 -0
  11. package/src/lib/components/analytics/dashboard-header/DashboardHeader.d.ts +6 -0
  12. package/src/lib/components/analytics/dashboard-header/DashboardHeader.styles.d.ts +1 -0
  13. package/src/lib/components/analytics/metadata-api/MetadataApiProvider.d.ts +45 -0
  14. package/src/lib/components/analytics/metadata-api/openapi/core/ApiError.d.ts +8 -0
  15. package/src/lib/components/analytics/metadata-api/openapi/core/ApiRequestOptions.d.ts +12 -0
  16. package/src/lib/components/analytics/metadata-api/openapi/core/ApiResult.d.ts +7 -0
  17. package/src/lib/components/analytics/metadata-api/openapi/core/OpenAPI.d.ts +15 -0
  18. package/src/lib/components/analytics/metadata-api/openapi/core/request.d.ts +9 -0
  19. package/src/lib/components/analytics/metadata-api/openapi/index.d.ts +48 -0
  20. package/src/lib/components/analytics/metadata-api/openapi/models/AllCategoriesResponse.d.ts +3 -0
  21. package/src/lib/components/analytics/metadata-api/openapi/models/Author.d.ts +4 -0
  22. package/src/lib/components/analytics/metadata-api/openapi/models/BiServerResponse.d.ts +3 -0
  23. package/src/lib/components/analytics/metadata-api/openapi/models/CategoriesResponse.d.ts +3 -0
  24. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardCopyBody.d.ts +18 -0
  25. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardCreateBody.d.ts +74 -0
  26. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardPatchBody.d.ts +74 -0
  27. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardPutBody.d.ts +74 -0
  28. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardView.d.ts +106 -0
  29. package/src/lib/components/analytics/metadata-api/openapi/models/DashboardViewPagedResponse.d.ts +6 -0
  30. package/src/lib/components/analytics/metadata-api/openapi/models/Entity.d.ts +7 -0
  31. package/src/lib/components/analytics/metadata-api/openapi/models/EntityAttribute.d.ts +11 -0
  32. package/src/lib/components/analytics/metadata-api/openapi/models/EntityAttributePagedResponse.d.ts +6 -0
  33. package/src/lib/components/analytics/metadata-api/openapi/models/EntityAttributeRequest.d.ts +4 -0
  34. package/src/lib/components/analytics/metadata-api/openapi/models/EntityClass.d.ts +7 -0
  35. package/src/lib/components/analytics/metadata-api/openapi/models/EntityClassPagedResponse.d.ts +6 -0
  36. package/src/lib/components/analytics/metadata-api/openapi/models/EntityPagedResponse.d.ts +6 -0
  37. package/src/lib/components/analytics/metadata-api/openapi/models/Error.d.ts +18 -0
  38. package/src/lib/components/analytics/metadata-api/openapi/models/GuestTokenRequest.d.ts +14 -0
  39. package/src/lib/components/analytics/metadata-api/openapi/models/HealthCheckResponse.d.ts +9 -0
  40. package/src/lib/components/analytics/metadata-api/openapi/models/HelpContent.d.ts +5 -0
  41. package/src/lib/components/analytics/metadata-api/openapi/models/HelpContentCreateBody.d.ts +3 -0
  42. package/src/lib/components/analytics/metadata-api/openapi/models/HelpContentPagedResponse.d.ts +6 -0
  43. package/src/lib/components/analytics/metadata-api/openapi/models/HelpContentPutBody.d.ts +3 -0
  44. package/src/lib/components/analytics/metadata-api/openapi/models/MSTRLoginTokenResponse.d.ts +3 -0
  45. package/src/lib/components/analytics/metadata-api/openapi/models/MSTRServerResponse.d.ts +5 -0
  46. package/src/lib/components/analytics/metadata-api/openapi/models/MetadataResponse.d.ts +5 -0
  47. package/src/lib/components/analytics/metadata-api/openapi/models/Origin.d.ts +7 -0
  48. package/src/lib/components/analytics/metadata-api/openapi/models/OriginInstance.d.ts +7 -0
  49. package/src/lib/components/analytics/metadata-api/openapi/models/OriginInstancePagedResponse.d.ts +6 -0
  50. package/src/lib/components/analytics/metadata-api/openapi/models/OriginPagedResponse.d.ts +6 -0
  51. package/src/lib/components/analytics/metadata-api/openapi/models/PaginationHeaders.d.ts +7 -0
  52. package/src/lib/components/analytics/metadata-api/openapi/models/PaginationMetadata.d.ts +9 -0
  53. package/src/lib/components/analytics/metadata-api/openapi/models/SSLoginTokenResponse.d.ts +4 -0
  54. package/src/lib/components/analytics/metadata-api/openapi/models/TenantInfo.d.ts +5 -0
  55. package/src/lib/components/analytics/metadata-api/openapi/models/VersionResponse.d.ts +3 -0
  56. package/src/lib/components/analytics/metadata-api/openapi/services/BiService.d.ts +59 -0
  57. package/src/lib/components/analytics/metadata-api/openapi/services/CategoriesService.d.ts +22 -0
  58. package/src/lib/components/analytics/metadata-api/openapi/services/DashboardsService.d.ts +125 -0
  59. package/src/lib/components/analytics/metadata-api/openapi/services/EntitiesService.d.ts +57 -0
  60. package/src/lib/components/analytics/metadata-api/openapi/services/EntityAttributesService.d.ts +69 -0
  61. package/src/lib/components/analytics/metadata-api/openapi/services/EntityClassService.d.ts +56 -0
  62. package/src/lib/components/analytics/metadata-api/openapi/services/HelpContentService.d.ts +51 -0
  63. package/src/lib/components/analytics/metadata-api/openapi/services/OriginInstancesService.d.ts +56 -0
  64. package/src/lib/components/analytics/metadata-api/openapi/services/OriginsService.d.ts +56 -0
  65. package/src/lib/components/analytics/metadata-api/openapi/services/UtilityService.d.ts +46 -0
  66. package/src/lib/components/board/board/Board.context.d.ts +5 -0
  67. package/src/lib/components/board/board/Board.d.ts +8 -0
  68. package/src/lib/components/board/board/Board.styles.d.ts +8 -0
  69. package/src/lib/components/board/board/index.d.ts +2 -0
  70. package/src/lib/components/board/column/Column.context.d.ts +5 -0
  71. package/src/lib/components/board/column/Column.d.ts +7 -0
  72. package/src/lib/components/board/column/Column.styles.d.ts +7 -0
  73. package/src/lib/components/board/column/index.d.ts +2 -0
  74. package/src/lib/components/board/column-actionbar/ColumnActionBar.d.ts +2 -0
  75. package/src/lib/components/board/column-actionbar/ColumnActionBar.styles.d.ts +6 -0
  76. package/src/lib/components/board/column-actionbar/index.d.ts +1 -0
  77. package/src/lib/components/board/column-collapse/ColumnCollapse.d.ts +6 -0
  78. package/src/lib/components/board/column-collapse/index.d.ts +1 -0
  79. package/src/lib/components/board/column-expand/ColumnExpand.d.ts +6 -0
  80. package/src/lib/components/board/column-expand/index.d.ts +1 -0
  81. package/src/lib/components/board/column-header/ColumnHeader.d.ts +5 -0
  82. package/src/lib/components/board/column-header/ColumnHeader.styles.d.ts +8 -0
  83. package/src/lib/components/board/column-header/index.d.ts +1 -0
  84. package/src/lib/components/board/column-items/ColumnItems.d.ts +5 -0
  85. package/src/lib/components/board/column-items/ColumnItems.styles.d.ts +6 -0
  86. package/src/lib/components/board/column-items/index.d.ts +1 -0
  87. package/src/lib/components/board/column-summary/ColumnSummary.d.ts +5 -0
  88. package/src/lib/components/board/column-summary/ColumnSummary.styles.d.ts +8 -0
  89. package/src/lib/components/board/column-summary/index.d.ts +1 -0
  90. package/src/lib/components/board/index.d.ts +9 -0
  91. package/src/lib/components/board/interfaces.d.ts +43 -0
  92. package/src/lib/components/core-api/openapi/models/ApplicationModel.d.ts +1 -1
  93. package/src/lib/components/index.d.ts +8 -1
  94. package/src/lib/components/snackbar/SnackbarProvider.d.ts +2 -0
  95. package/src/lib/components/snackbar/index.d.ts +1 -1
  96. package/src/lib/components/snackbar/utils/helpers.d.ts +9 -0
  97. package/src/lib/utils/index.d.ts +10 -0
  98. /package/src/lib/{components/core-api → utils/cancelable-promise}/CancelablePromise.d.ts +0 -0
@@ -0,0 +1,7 @@
1
+ export type Entity = {
2
+ name: string;
3
+ description: string;
4
+ origin_instance_id?: string | null;
5
+ created_dt?: string | null;
6
+ id?: string | null;
7
+ };
@@ -0,0 +1,11 @@
1
+ export type EntityAttribute = {
2
+ name: string;
3
+ description: string;
4
+ entity_id?: string | null;
5
+ created_dt?: string | null;
6
+ is_key?: boolean;
7
+ schema?: Record<string, any>;
8
+ updated_dt?: string | null;
9
+ id?: string | null;
10
+ origin_inst_id?: string | null;
11
+ };
@@ -0,0 +1,6 @@
1
+ import type { EntityAttribute } from './EntityAttribute';
2
+ import type { PaginationHeaders } from './PaginationHeaders';
3
+ export type EntityAttributePagedResponse = {
4
+ results: Array<EntityAttribute>;
5
+ pagination: PaginationHeaders;
6
+ };
@@ -0,0 +1,4 @@
1
+ import type { EntityAttribute } from './EntityAttribute';
2
+ export type EntityAttributeRequest = {
3
+ entity_attr_list: Array<EntityAttribute>;
4
+ };
@@ -0,0 +1,7 @@
1
+ export type EntityClass = {
2
+ name: string;
3
+ description: string;
4
+ origin_id?: string | null;
5
+ created_dt?: string | null;
6
+ id?: string | null;
7
+ };
@@ -0,0 +1,6 @@
1
+ import type { EntityClass } from './EntityClass';
2
+ import type { PaginationHeaders } from './PaginationHeaders';
3
+ export type EntityClassPagedResponse = {
4
+ results: Array<EntityClass>;
5
+ pagination: PaginationHeaders;
6
+ };
@@ -0,0 +1,6 @@
1
+ import type { Entity } from './Entity';
2
+ import type { PaginationHeaders } from './PaginationHeaders';
3
+ export type EntityPagedResponse = {
4
+ results: Array<Entity>;
5
+ pagination: PaginationHeaders;
6
+ };
@@ -0,0 +1,18 @@
1
+ export type Error = {
2
+ /**
3
+ * Error code
4
+ */
5
+ code?: number;
6
+ /**
7
+ * Error name
8
+ */
9
+ status?: string;
10
+ /**
11
+ * Error message
12
+ */
13
+ message?: string;
14
+ /**
15
+ * Errors
16
+ */
17
+ errors?: any;
18
+ };
@@ -0,0 +1,14 @@
1
+ export type GuestTokenRequest = {
2
+ /**
3
+ * `resources` array, required, empty array allowed.
4
+ */
5
+ resources: Array<Record<string, any>>;
6
+ /**
7
+ * `rls` array, required, empty array allowed.
8
+ */
9
+ rls: Array<Record<string, any>>;
10
+ /**
11
+ * `user` object, required, empty object allowed.
12
+ */
13
+ user?: Record<string, any>;
14
+ };
@@ -0,0 +1,9 @@
1
+ export type HealthCheckResponse = {
2
+ checks: Record<string, Record<string, any>>;
3
+ commit_sha: string;
4
+ description: string;
5
+ healthy: boolean;
6
+ repository: string;
7
+ updated: string;
8
+ version: string;
9
+ };
@@ -0,0 +1,5 @@
1
+ export type HelpContent = {
2
+ content: string;
3
+ id?: string | null;
4
+ created_dt?: string | null;
5
+ };
@@ -0,0 +1,3 @@
1
+ export type HelpContentCreateBody = {
2
+ content?: string;
3
+ };
@@ -0,0 +1,6 @@
1
+ import type { HelpContent } from './HelpContent';
2
+ import type { PaginationHeaders } from './PaginationHeaders';
3
+ export type HelpContentPagedResponse = {
4
+ results: Array<HelpContent>;
5
+ pagination: PaginationHeaders;
6
+ };
@@ -0,0 +1,3 @@
1
+ export type HelpContentPutBody = {
2
+ content?: string;
3
+ };
@@ -0,0 +1,3 @@
1
+ export type MSTRLoginTokenResponse = {
2
+ access_token: string;
3
+ };
@@ -0,0 +1,5 @@
1
+ export type MSTRServerResponse = {
2
+ url: string;
3
+ project_id: string;
4
+ oidc_enabled: boolean;
5
+ };
@@ -0,0 +1,5 @@
1
+ import type { Author } from './Author';
2
+ export type MetadataResponse = {
3
+ categories?: Array<string>;
4
+ authors?: Array<Author>;
5
+ };
@@ -0,0 +1,7 @@
1
+ export type Origin = {
2
+ name: string;
3
+ description: string;
4
+ created_dt?: string | null;
5
+ id?: string | null;
6
+ origin_family?: Array<string> | null;
7
+ };
@@ -0,0 +1,7 @@
1
+ export type OriginInstance = {
2
+ name: string;
3
+ description: string;
4
+ origin_id?: string | null;
5
+ created_dt?: string | null;
6
+ id?: string | null;
7
+ };
@@ -0,0 +1,6 @@
1
+ import type { OriginInstance } from './OriginInstance';
2
+ import type { PaginationHeaders } from './PaginationHeaders';
3
+ export type OriginInstancePagedResponse = {
4
+ results: Array<OriginInstance>;
5
+ pagination: PaginationHeaders;
6
+ };
@@ -0,0 +1,6 @@
1
+ import type { Origin } from './Origin';
2
+ import type { PaginationHeaders } from './PaginationHeaders';
3
+ export type OriginPagedResponse = {
4
+ results: Array<Origin>;
5
+ pagination: PaginationHeaders;
6
+ };
@@ -0,0 +1,7 @@
1
+ export type PaginationHeaders = {
2
+ count?: number;
3
+ start?: number;
4
+ total_available?: number;
5
+ next_start?: number | null;
6
+ previous_start?: number | null;
7
+ };
@@ -0,0 +1,9 @@
1
+ export type PaginationMetadata = {
2
+ total?: number;
3
+ total_pages?: number;
4
+ first_page?: number;
5
+ last_page?: number;
6
+ page?: number;
7
+ previous_page?: number;
8
+ next_page?: number;
9
+ };
@@ -0,0 +1,4 @@
1
+ export type SSLoginTokenResponse = {
2
+ access_token: string;
3
+ refresh_token: string;
4
+ };
@@ -0,0 +1,5 @@
1
+ export type TenantInfo = {
2
+ tenant_id: string;
3
+ tenant_domain?: string | null;
4
+ encryption_key: string;
5
+ };
@@ -0,0 +1,3 @@
1
+ export type VersionResponse = {
2
+ version: string;
3
+ };
@@ -0,0 +1,59 @@
1
+ import type { BiServerResponse } from '../models/BiServerResponse';
2
+ import type { Error } from '../models/Error';
3
+ import type { GuestTokenRequest } from '../models/GuestTokenRequest';
4
+ import type { MSTRLoginTokenResponse } from '../models/MSTRLoginTokenResponse';
5
+ import type { MSTRServerResponse } from '../models/MSTRServerResponse';
6
+ import type { SSLoginTokenResponse } from '../models/SSLoginTokenResponse';
7
+ export declare class BiService {
8
+ /**
9
+ * Digital.ai Business Intelligence engine details.
10
+ * Details about the Digital.ai Business Intelligence engine supporting the authenticated account.
11
+ * @returns BiServerResponse OK
12
+ * @returns Error Default error response
13
+ * @throws ApiError
14
+ */
15
+ static getBiService(): Promise<BiServerResponse | Error>;
16
+ /**
17
+ * @deprecated
18
+ * Obtain a Guest Token from the superset instance.
19
+ * Get a `guest token`, suitable for passing to the superset EmbeddingSDK.
20
+ * @param requestBody
21
+ * @returns Error Default error response
22
+ * @throws ApiError
23
+ */
24
+ static postBiService(requestBody: GuestTokenRequest): Promise<Error>;
25
+ /**
26
+ * @deprecated
27
+ * Obtain a standard Bearer Token from Superset.
28
+ * Get a bearer token, suitable for directly using the Superset APIs.
29
+ * @returns SSLoginTokenResponse OK
30
+ * @returns Error Default error response
31
+ * @throws ApiError
32
+ */
33
+ static getBiService1(): Promise<SSLoginTokenResponse | Error>;
34
+ /**
35
+ * Obtain an identity token from Microstrategy.
36
+ * Get a Microstrategy identity token, used for creating a session in another application.
37
+ * @returns MSTRLoginTokenResponse OK
38
+ * @returns Error Default error response
39
+ * @throws ApiError
40
+ */
41
+ static getBiService2(): Promise<MSTRLoginTokenResponse | Error>;
42
+ /**
43
+ * @deprecated
44
+ * Passthru to the superset server instance's API.
45
+ * [EXPERIMENTAL] - Proxies a call through to the superset instance.
46
+ * @param path
47
+ * @returns Error Default error response
48
+ * @throws ApiError
49
+ */
50
+ static getBiService3(path: string): Promise<Error>;
51
+ /**
52
+ * Return info on MSTR server for this tenant.
53
+ * Return info on MSTR server for this tenant.
54
+ * @returns MSTRServerResponse OK
55
+ * @returns Error Default error response
56
+ * @throws ApiError
57
+ */
58
+ static getBiService4(): Promise<MSTRServerResponse | Error>;
59
+ }
@@ -0,0 +1,22 @@
1
+ import type { AllCategoriesResponse } from '../models/AllCategoriesResponse';
2
+ import type { CategoriesResponse } from '../models/CategoriesResponse';
3
+ import type { Error } from '../models/Error';
4
+ export declare class CategoriesService {
5
+ /**
6
+ * Get a list of Categories by Application type.
7
+ * Return a list of Categories by Application type.
8
+ * @returns AllCategoriesResponse OK
9
+ * @returns Error Default error response
10
+ * @throws ApiError
11
+ */
12
+ static getCategoriesService(): Promise<AllCategoriesResponse | Error>;
13
+ /**
14
+ * Get Categories for a single application type.
15
+ * Return all Categories for a single application type.
16
+ * @param appType
17
+ * @returns CategoriesResponse OK
18
+ * @returns Error Default error response
19
+ * @throws ApiError
20
+ */
21
+ static getCategoriesService1(appType: string): Promise<CategoriesResponse | Error>;
22
+ }
@@ -0,0 +1,125 @@
1
+ import type { DashboardCopyBody } from '../models/DashboardCopyBody';
2
+ import type { DashboardCreateBody } from '../models/DashboardCreateBody';
3
+ import type { DashboardPatchBody } from '../models/DashboardPatchBody';
4
+ import type { DashboardPutBody } from '../models/DashboardPutBody';
5
+ import type { DashboardView } from '../models/DashboardView';
6
+ import type { DashboardViewPagedResponse } from '../models/DashboardViewPagedResponse';
7
+ import type { Error } from '../models/Error';
8
+ import type { MetadataResponse } from '../models/MetadataResponse';
9
+ export declare class DashboardsService {
10
+ /**
11
+ * Get a list of Dashboards.
12
+ * Return a list of Dashboard definitions, filtered by query parameters.
13
+ * @param start Offset of the first fetched item.
14
+ * @param count Maximum number of fetched items.
15
+ * @param sort Sort ordering to apply to the query.
16
+ * @param filter List of filters (each filter is a separate query param, and they are OR'ed).
17
+ *
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, name, target_apps, updated_dt
19
+ * * **Searchable field names**: author_fullname, categories, description, name
20
+ *
21
+ * @param favorite Boolean flag to only return dashboards marked as favorites.
22
+ * @param q Case-insensitive search of all text fields.
23
+ * @param authorFullname String match on Dashboard author fullname.
24
+ * @param authorId String match on Dashboard author user id.
25
+ * @param biType String match on Dashboard bi type - 'MICROSTRATEGY'.
26
+ * @param description String match on Dashboard description.
27
+ * @param id Dashboard ID.
28
+ * @param isOotbDashboard Boolean match on Dashboard OOTB status.
29
+ * @param lifecycleState String match on Dashboard lifecycle state - 'DRAFT' or 'PUBLISHED'.
30
+ * @param name String match on Dashboard name.
31
+ * @param targetApp String match on the Dashboard target application - 'AGILITY', 'CONTINUOUSTEST', 'DEPLOY' or 'RELEASE'.
32
+ * @returns DashboardViewPagedResponse OK
33
+ * @returns Error Default error response
34
+ * @throws ApiError
35
+ */
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>;
37
+ /**
38
+ * Create a Dashboard definition.
39
+ * Creates a Dashboard definition.
40
+ * @param requestBody
41
+ * @returns DashboardView Dashboard created.
42
+ * @returns Error Default error response
43
+ * @throws ApiError
44
+ */
45
+ static postDashboardsService(requestBody: DashboardCreateBody): Promise<DashboardView | Error>;
46
+ /**
47
+ * Get one Dashboard definition.
48
+ * Return a single Dashboard definition, selected by ID.
49
+ * @param dashboardId
50
+ * @returns DashboardView OK
51
+ * @returns Error Default error response
52
+ * @throws ApiError
53
+ */
54
+ static getDashboardsService1(dashboardId: string): Promise<DashboardView | Error>;
55
+ /**
56
+ * Sets a single Dashboard definition.
57
+ * Sets a Dashboard definition, selected by ID.
58
+ * @param dashboardId
59
+ * @param requestBody
60
+ * @param isSync Sync the dashboard with BI
61
+ * @returns DashboardView Dashboard updated.
62
+ * @returns Error Default error response
63
+ * @throws ApiError
64
+ */
65
+ static putDashboardsService(dashboardId: string, requestBody: DashboardPutBody, isSync?: boolean): Promise<DashboardView | Error>;
66
+ /**
67
+ * Updates a single Dashboard definition.
68
+ * Updates a Dashboard definition, selected by ID.
69
+ * @param dashboardId
70
+ * @param requestBody
71
+ * @param isSync Sync the dashboard with BI
72
+ * @returns DashboardView Dashboard updated.
73
+ * @returns Error Default error response
74
+ * @throws ApiError
75
+ */
76
+ static patchDashboardsService(dashboardId: string, requestBody: DashboardPatchBody, isSync?: boolean): Promise<DashboardView | Error>;
77
+ /**
78
+ * Delete a Dashboard definition.
79
+ * Deletes a single Dashboard definition, selected by ID.
80
+ * @param dashboardId
81
+ * @returns Error Default error response
82
+ * @throws ApiError
83
+ */
84
+ static deleteDashboardsService(dashboardId: string): Promise<Error>;
85
+ /**
86
+ * Create a copy of existing dashboard
87
+ * Create a copy of existing dashboard
88
+ * @param dashboardId
89
+ * @param requestBody
90
+ * @returns DashboardView Dashboard copied.
91
+ * @returns Error Default error response
92
+ * @throws ApiError
93
+ */
94
+ static postDashboardsService1(dashboardId: string, requestBody?: DashboardCopyBody): Promise<DashboardView | Error>;
95
+ /**
96
+ * Favorite a dashboard
97
+ * Favorite a dashboard
98
+ * @param dashboardId
99
+ * @returns DashboardView Dashboard favorited.
100
+ * @returns Error Default error response
101
+ * @throws ApiError
102
+ */
103
+ static postDashboardsService2(dashboardId: string): Promise<DashboardView | Error>;
104
+ /**
105
+ * Un-favorite a dashboard
106
+ * Un-favorite a dashboard
107
+ * @param dashboardId
108
+ * @returns DashboardView Dashboard un-favorited.
109
+ * @returns Error Default error response
110
+ * @throws ApiError
111
+ */
112
+ static deleteDashboardsService1(dashboardId: string): Promise<DashboardView | Error>;
113
+ /**
114
+ * Get Metadata (categories and authors)
115
+ * Return all Metadata for the given query parameters: bi_type, lifecycle_state, target_app, and/or is_ootb_dashboard
116
+ * @param biType String match on Dashboard bi type - 'MICROSTRATEGY'.
117
+ * @param isOotbDashboard Boolean match on Dashboard OOTB status.
118
+ * @param lifecycleState String match on Dashboard lifecycle state - 'DRAFT' or 'PUBLISHED'.
119
+ * @param targetApp String match on the Dashboard target application - 'AGILITY', 'CONTINUOUSTEST', 'DEPLOY' or 'RELEASE'.
120
+ * @returns MetadataResponse OK
121
+ * @returns Error Default error response
122
+ * @throws ApiError
123
+ */
124
+ static getDashboardsService2(biType?: string, isOotbDashboard?: boolean, lifecycleState?: string, targetApp?: string): Promise<MetadataResponse | Error>;
125
+ }
@@ -0,0 +1,57 @@
1
+ import type { Entity } from '../models/Entity';
2
+ import type { EntityPagedResponse } from '../models/EntityPagedResponse';
3
+ import type { Error } from '../models/Error';
4
+ export declare class EntitiesService {
5
+ /**
6
+ * Get a list of Entities.
7
+ * Return a list of Entities, filtered by query parameters.
8
+ * @param start Offset of the first fetched item.
9
+ * @param count Maximum number of fetched items.
10
+ * @param sort Sort ordering to apply to the query.
11
+ * @param name String match on Entity name.
12
+ * @param description String match on Entity description.
13
+ * @param originInstanceName String match on Entity description.
14
+ * @param q Case-insensitive search of all text fields.
15
+ * @param id
16
+ * @returns EntityPagedResponse OK
17
+ * @returns Error Default error response
18
+ * @throws ApiError
19
+ */
20
+ static getEntitiesService(start?: number, count?: number, sort?: string, name?: string, description?: string, originInstanceName?: string, q?: string, id?: string): Promise<EntityPagedResponse | Error>;
21
+ /**
22
+ * Create an Entity.
23
+ * Creates an Entity, owned by the authenticated API user.
24
+ * @param requestBody
25
+ * @returns Entity Entity created.
26
+ * @returns Error Default error response
27
+ * @throws ApiError
28
+ */
29
+ static postEntitiesService(requestBody: Entity): Promise<Entity | Error>;
30
+ /**
31
+ * Get one Entity.
32
+ * Return a single Entity, selected by ID.
33
+ * @param id
34
+ * @returns Entity OK
35
+ * @returns Error Default error response
36
+ * @throws ApiError
37
+ */
38
+ static getEntitiesService1(id: string): Promise<Entity | Error>;
39
+ /**
40
+ * Update a single Entity.
41
+ * Updates an Entity, selected by ID.
42
+ * @param id
43
+ * @param requestBody
44
+ * @returns Entity Entity updated.
45
+ * @returns Error Default error response
46
+ * @throws ApiError
47
+ */
48
+ static putEntitiesService(id: string, requestBody: Entity): Promise<Entity | Error>;
49
+ /**
50
+ * Delete a Entity.
51
+ * Deletes a single Entity, selected by ID.
52
+ * @param id
53
+ * @returns Error Default error response
54
+ * @throws ApiError
55
+ */
56
+ static deleteEntitiesService(id: string): Promise<Error>;
57
+ }
@@ -0,0 +1,69 @@
1
+ import type { EntityAttribute } from '../models/EntityAttribute';
2
+ import type { EntityAttributePagedResponse } from '../models/EntityAttributePagedResponse';
3
+ import type { EntityAttributeRequest } from '../models/EntityAttributeRequest';
4
+ import type { Error } from '../models/Error';
5
+ export declare class EntityAttributesService {
6
+ /**
7
+ * Get a list of EntityAttributes.
8
+ * Return a list of EntityAttributes, filtered by query parameters.
9
+ * @param start Offset of the first fetched item.
10
+ * @param count Maximum number of fetched items.
11
+ * @param sort Sort ordering to apply to the query.
12
+ * @param name String match on EntityAttribute name.
13
+ * @param description String match on EntityAttribute description.
14
+ * @param entityName String match on Entity name.
15
+ * @param originInstanceName String match on Origin Instance name.
16
+ * @param isKey boolean match on is_key field.
17
+ * @param q Case-insensitive search of all text fields.
18
+ * @param id
19
+ * @returns EntityAttributePagedResponse OK
20
+ * @returns Error Default error response
21
+ * @throws ApiError
22
+ */
23
+ static getEntityAttributesService(start?: number, count?: number, sort?: string, name?: string, description?: string, entityName?: string, originInstanceName?: string, isKey?: boolean, q?: string, id?: string): Promise<EntityAttributePagedResponse | Error>;
24
+ /**
25
+ * Create an EntityAttribute.
26
+ * Creates an EntityAttribute, owned by the authenticated API user.
27
+ * @param requestBody
28
+ * @returns EntityAttribute Entity created.
29
+ * @returns Error Default error response
30
+ * @throws ApiError
31
+ */
32
+ static postEntityAttributesService(requestBody: EntityAttribute): Promise<EntityAttribute | Error>;
33
+ /**
34
+ * Create or Update multiple entity attributes.
35
+ * Creates an EntityAttribute incase id of the attribute is not present in the payload else modify the corresponding property of the attribute, owned by the authenticated API user.
36
+ * @param requestBody
37
+ * @returns EntityAttributeRequest OK
38
+ * @returns Error Default error response
39
+ * @throws ApiError
40
+ */
41
+ static putEntityAttributesService(requestBody: EntityAttributeRequest): Promise<EntityAttributeRequest | Error>;
42
+ /**
43
+ * Get one EntityAttribute.
44
+ * Return a single EntityAttribute, selected by ID.
45
+ * @param id
46
+ * @returns EntityAttribute OK
47
+ * @returns Error Default error response
48
+ * @throws ApiError
49
+ */
50
+ static getEntityAttributesService1(id: string): Promise<EntityAttribute | Error>;
51
+ /**
52
+ * Update a single EntityAttribute.
53
+ * Updates an EntityAttribute, selected by ID.
54
+ * @param id
55
+ * @param requestBody
56
+ * @returns EntityAttribute Entity updated.
57
+ * @returns Error Default error response
58
+ * @throws ApiError
59
+ */
60
+ static putEntityAttributesService1(id: string, requestBody: EntityAttribute): Promise<EntityAttribute | Error>;
61
+ /**
62
+ * Delete a EntityAttribute.
63
+ * Deletes a single EntityAttribute, selected by ID.
64
+ * @param id
65
+ * @returns Error Default error response
66
+ * @throws ApiError
67
+ */
68
+ static deleteEntityAttributesService(id: string): Promise<Error>;
69
+ }
@@ -0,0 +1,56 @@
1
+ import type { EntityClass } from '../models/EntityClass';
2
+ import type { EntityClassPagedResponse } from '../models/EntityClassPagedResponse';
3
+ import type { Error } from '../models/Error';
4
+ export declare class EntityClassService {
5
+ /**
6
+ * Get a list of Entity Class.
7
+ * Return a list of Entity Classes, filtered by query parameters.
8
+ * @param start Offset of the first fetched item.
9
+ * @param count Maximum number of fetched items.
10
+ * @param sort Sort ordering to apply to the query.
11
+ * @param name String match on Entity Class name.
12
+ * @param description String match on Entity Class description.
13
+ * @param q Case-insensitive search of all text fields.
14
+ * @param id
15
+ * @returns EntityClassPagedResponse OK
16
+ * @returns Error Default error response
17
+ * @throws ApiError
18
+ */
19
+ static getEntityClassService(start?: number, count?: number, sort?: string, name?: string, description?: string, q?: string, id?: string): Promise<EntityClassPagedResponse | Error>;
20
+ /**
21
+ * Create an Entity Class.
22
+ * Creates an Entity Class, owned by the authenticated API user.
23
+ * @param requestBody
24
+ * @returns EntityClass Entity class created.
25
+ * @returns Error Default error response
26
+ * @throws ApiError
27
+ */
28
+ static postEntityClassService(requestBody: EntityClass): Promise<EntityClass | Error>;
29
+ /**
30
+ * Get one Entity Class.
31
+ * Return a single Entity Class, selected by ID.
32
+ * @param id
33
+ * @returns EntityClass OK
34
+ * @returns Error Default error response
35
+ * @throws ApiError
36
+ */
37
+ static getEntityClassService1(id: string): Promise<EntityClass | Error>;
38
+ /**
39
+ * Update a single Entity Class.
40
+ * Updates an Entity Class, selected by ID.
41
+ * @param id
42
+ * @param requestBody
43
+ * @returns EntityClass Entity Class updated.
44
+ * @returns Error Default error response
45
+ * @throws ApiError
46
+ */
47
+ static putEntityClassService(id: string, requestBody: EntityClass): Promise<EntityClass | Error>;
48
+ /**
49
+ * Delete a Entity Class.
50
+ * Deletes a single Entity Class, selected by ID.
51
+ * @param id
52
+ * @returns Error Default error response
53
+ * @throws ApiError
54
+ */
55
+ static deleteEntityClassService(id: string): Promise<Error>;
56
+ }