@digital-ai/dot-components 3.7.0 → 3.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital-ai/dot-components",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "private": false,
   "license": "SEE LICENSE IN <LICENSE.md>",
   "contributors": [

package/src/lib/components/analytics/dashboard-actions/DashboardActions.d.ts

@@ -0,0 +1,19 @@
+import { ApplicationModel } from '../../core-api/openapi';
+import { AllCategories } from '../metadata-api/MetadataApiProvider';
+import { DashboardView } from '../metadata-api/openapi/';
+interface DashboardActionsCommonProps {
+    canEdit?: boolean;
+    dashboard: DashboardView;
+    isEdit?: boolean;
+    onClose?: (dashboard: DashboardView) => void;
+    onDuplicated?: (dashboard: DashboardView, isDone?: boolean) => void;
+    onFavorite?: (id: string, value: boolean) => void;
+    onStatusChanged?: (dashboard: DashboardView) => void;
+    onViewMode?: (dashboard: DashboardView, mode: string) => void;
+}
+interface DashboardActionsProps extends DashboardActionsCommonProps {
+    applications: ApplicationModel[];
+    categories: AllCategories;
+}
+declare function DotDashboardActions({ applications, categories, dashboard, isEdit, canEdit, onClose, onFavorite, onStatusChanged, onDuplicated, onViewMode, }: DashboardActionsProps): import("react/jsx-runtime").JSX.Element;
+export { DashboardActionsCommonProps, DotDashboardActions };

package/src/lib/components/analytics/dashboard-actions/DashboardActions.styles.d.ts

@@ -0,0 +1,2 @@
+export declare const helpButtonClassName = "help-button";
+export declare const StyledDashboardActions: import("styled-components").StyledComponent<"div", any, {}, never>;

package/src/lib/components/analytics/dashboard-actions/DashboardOptionsMenu.d.ts

@@ -0,0 +1,10 @@
+import { DashboardView } from '../metadata-api/openapi';
+interface DashboardOptionsMenuProps {
+    dashboard: DashboardView;
+    isEdit?: boolean;
+    onStartDuplicate?: (dashboard: DashboardView) => void;
+    onStartStatusChange?: (dashboard: DashboardView, status: DashboardView.lifecycle_state) => void;
+    onViewMode?: (dashboard: DashboardView, mode: string) => void;
+}
+export declare function DotDashboardOptionsMenu({ dashboard, isEdit, onStartDuplicate, onStartStatusChange, onViewMode, }: DashboardOptionsMenuProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/src/lib/components/analytics/dashboard-actions/DashboardOptionsMenu.styles.d.ts

@@ -0,0 +1 @@
+export declare const StyledDotMenu: import("styled-components").StyledComponent<({ anchorEl, ariaLabel, ariaRole, className, "data-testid": dataTestId, dense, disablePortal, id, loading, maxVisibleItems, menuItemHeight, menuItems, menuPlacement, onLeave, onSelect, open, selectedKey, }: import("../../menu/Menu").MenuProps) => import("react/jsx-runtime").JSX.Element, any, {}, never>;

package/src/lib/components/analytics/dashboard-actions/DashboardPublishConfirm.d.ts

@@ -0,0 +1,18 @@
+import { ApplicationModel } from '../../core-api/openapi';
+import { AllCategoriesResponse, DashboardView } from '../metadata-api/openapi';
+interface DashboardPublishConfirmProps {
+    /** List of applications the dashboard can be published to **/
+    applicationList: ApplicationModel[];
+    /** Categories for dashboard publishing **/
+    categories: AllCategoriesResponse;
+    /** Dashboard to confirm publishing for **/
+    dashboardToPublish: DashboardView;
+    /** Dashboard to confirm unpublishing for **/
+    dashboardToUnpublish: DashboardView;
+    /** When the confirmation is closed (canceled, finished, or clicked away) this function is called **/
+    onClose: () => void;
+    /** When a dashboard is updated, this function is called with the updated dashboard **/
+    onStatusChanged: (updatedDashboard: DashboardView) => void;
+}
+export declare function DotDashboardPublishConfirm({ applicationList, categories, dashboardToPublish, dashboardToUnpublish, onClose, onStatusChanged, }: Readonly<DashboardPublishConfirmProps>): import("react/jsx-runtime").JSX.Element;
+export {};

package/src/lib/components/analytics/dashboard-actions/DashboardPublishConfirm.styles.d.ts

@@ -0,0 +1,6 @@
+export declare const dashboardCategoriesContainerClassName = "dashboard-categories-container";
+export declare const InlineMessage: import("styled-components").StyledComponent<({ ariaLabel, ariaLevel, ariaRole, className, "data-testid": dataTestId, children, component, noMarginBottom, noWrap, variant, }: import("../../typography/Typography").TypographyProps) => import("react/jsx-runtime").JSX.Element, any, {}, never>;
+export declare const StyledPublishConfirmDiv: import("styled-components").StyledComponent<"div", any, {}, never>;
+export declare const StyledAppSelectDiv: import("styled-components").StyledComponent<"div", any, {}, never>;
+export declare const StyledAppSelectDotAutoComplete: import("styled-components").StyledComponent<(<T extends import("../..").AutoCompleteOption>({ ListboxComponent, actionItem, ariaLabel, autoFocus, autoHighlight, className, "data-pendoid": dataPendoId, "data-testid": dataTestId, defaultValue, dense, disabled, disablePortal, endAdornmentTooltip, error, filterOptions, filterSelectedOptions, freesolo, checkIfOptionDisabled, group, helperText, inputId, inputRef, inputValue, isOptionEqualToValue, label, loading, maxHeight, multiple, onBlur, onChange, onClose, onInputChange, onOpen, open, options, persistentLabel, placeholder, popperClassName, readOnly, renderGroup, renderOption, renderTags, required, size, value, warning, }: import("../../auto-complete/AutoComplete").AutoCompleteProps<T>) => import("react/jsx-runtime").JSX.Element), any, {}, never>;
+export declare const StyledAppSelectAutoCompleteOption: import("styled-components").StyledComponent<"li", any, {}, never>;

package/src/lib/components/analytics/dashboard-dialog/DashboardDialog.d.ts

@@ -0,0 +1,30 @@
+import { InputSelectOption } from '../../input-form-fields/InputSelect';
+import { DashboardView } from '../metadata-api/openapi';
+export declare const DashboardAppTypeOptions: InputSelectOption[];
+interface DashboardData {
+    categories: string[];
+    description: string;
+    name: string;
+}
+export declare const DASHBOARD_NAME_MAX_LENGTH = 250;
+export declare const DASHBOARD_DESCRIPTION_MAX_LENGTH = 250;
+interface DashboardDialogProps {
+    /** Categories for dashboard publishing **/
+    availableCategories: string[];
+    /** Dashboard to copy when creating a new dashoard. **/
+    copyDashboard?: DashboardView;
+    /** Dashboard to edit **/
+    editDashboard?: DashboardView;
+    /** When the confirmation is closed (canceled, finished, or clicked away) this function is called **/
+    onClose: (returnToList?: boolean) => void;
+    /** When the form is submitted with no changes, this function is called **/
+    onContinue?: () => void;
+    /** When the form is submitted with a valid name this function is called **/
+    onSubmit: (data: DashboardData, returnToList?: boolean) => Promise<void>;
+    /** Controls if the dialog should be open or not **/
+    open: boolean;
+    /** Dialog title **/
+    title?: string;
+}
+declare function DotDashboardDialog({ availableCategories, copyDashboard, editDashboard, open, onClose, onSubmit, onContinue, title, }: Readonly<DashboardDialogProps>): import("react/jsx-runtime").JSX.Element;
+export { DotDashboardDialog, DashboardData };

package/src/lib/components/analytics/dashboard-dialog/DashboardDialog.styles.d.ts

@@ -0,0 +1,3 @@
+import { DialogActions } from '@mui/material';
+export declare const StyledDashboardDialog: import("styled-components").StyledComponent<({ ariaLabel, cancelButtonProps, cancelButtonVisible, className, "data-pendoid": dataPendoId, "data-testid": dataTestId, children, closeIconVisible, closeOnClickAway, closeOnSubmit, hasPrimaryAction, onCancel, onSubmit, open, submitButtonProps, title, }: import("../../dialog/Dialog").DialogProps) => import("react/jsx-runtime").JSX.Element, any, {}, never>;
+export declare const StyledDialogActions: import("styled-components").StyledComponent<typeof DialogActions, any, {}, never>;

package/src/lib/components/analytics/dashboard-header/DashboardHeader.d.ts

@@ -0,0 +1,6 @@
+import { DashboardActionsCommonProps } from '../dashboard-actions/DashboardActions';
+interface DashboardHeaderProps extends DashboardActionsCommonProps {
+    accountId?: string;
+}
+declare function DotDashboardHeader({ accountId, dashboard, isEdit, canEdit, onClose, onFavorite, onStatusChanged, onDuplicated, onViewMode, }: DashboardHeaderProps): import("react/jsx-runtime").JSX.Element;
+export { DashboardHeaderProps, DotDashboardHeader };

package/src/lib/components/analytics/dashboard-header/DashboardHeader.styles.d.ts

@@ -0,0 +1 @@
+export declare const StyledDashboardHeader: import("styled-components").StyledComponent<({ ariaLabel, children, className, "data-testid": dataTestId, variant, }: import("../../action-toolbar/ActionToolbar").DotActionBarProps) => import("react/jsx-runtime").JSX.Element, any, {}, never>;

package/src/lib/components/analytics/metadata-api/MetadataApiProvider.d.ts

@@ -0,0 +1,45 @@
+import { ReactNode } from 'react';
+import { ApiError, AllCategoriesResponse, DashboardView, DashboardCopyBody, DashboardPatchBody } from './openapi';
+export interface MetadataApiProviderProps {
+    accountOverrideId?: string;
+    apiUrl: string;
+    children: ReactNode;
+    token?: string;
+}
+interface DotMetadataApiContextProps {
+    categories: AllCategoriesResponse;
+    categoriesLoading: boolean;
+    dashboards: DashboardView[];
+    dashboardsError: ApiError;
+    dashboardsLoading: boolean;
+    duplicateDashboard: (dashboardId: string, dashboard: DashboardCopyBody) => Promise<DashboardView>;
+    favoriteDashboard: (dashboardId: string, favoriteValue: boolean) => Promise<DashboardView>;
+    getCategories: () => Promise<AllCategoriesResponse>;
+    getDashboardHelpContent: (helpContentId: string) => Promise<string>;
+    platformConsoleUrl: string;
+    searchDashboards: (search: DashboardFilters) => Promise<DashboardView[]>;
+    setOverrideAccountId: (accountId: string) => void;
+    setToken: (token: string) => void;
+    updateDashboard: (dashboardId: string, dashboard: DashboardPatchBody, isSync?: boolean) => Promise<DashboardView>;
+}
+interface DashboardFilters {
+    authorFullname?: string;
+    authorId?: string;
+    biType?: string;
+    count?: number;
+    description?: string;
+    favorite?: boolean;
+    filter?: Array<string>;
+    id?: string;
+    isOotbDashboard?: boolean;
+    lifecycleState?: 'DRAFT' | 'PUBLISHED';
+    name?: string;
+    q?: string;
+    sort?: string;
+    start?: number;
+    targetApp?: string;
+}
+export declare const DotMetadataApiProvider: ({ accountOverrideId, apiUrl, token, children, }: MetadataApiProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useDotMetadataApiContext: () => DotMetadataApiContextProps;
+export type AllCategories = AllCategoriesResponse;
+export {};

package/src/lib/components/analytics/metadata-api/openapi/core/ApiError.d.ts

@@ -0,0 +1,8 @@
+import type { ApiResult } from './ApiResult';
+export declare class ApiError extends Error {
+    readonly url: string;
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: any;
+    constructor(response: ApiResult, message: string);
+}

package/src/lib/components/analytics/metadata-api/openapi/core/ApiRequestOptions.d.ts

@@ -0,0 +1,12 @@
+export type ApiRequestOptions = {
+    readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
+    readonly path: string;
+    readonly cookies?: Record<string, any>;
+    readonly headers?: Record<string, any>;
+    readonly query?: Record<string, any>;
+    readonly formData?: Record<string, any>;
+    readonly body?: any;
+    readonly mediaType?: string;
+    readonly responseHeader?: string;
+    readonly errors?: Record<number, string>;
+};

package/src/lib/components/analytics/metadata-api/openapi/core/ApiResult.d.ts

@@ -0,0 +1,7 @@
+export type ApiResult = {
+    readonly url: string;
+    readonly ok: boolean;
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: any;
+};

package/src/lib/components/analytics/metadata-api/openapi/core/OpenAPI.d.ts

@@ -0,0 +1,15 @@
+import type { ApiRequestOptions } from './ApiRequestOptions';
+type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
+type Headers = Record<string, string>;
+type Config = {
+    BASE: string;
+    VERSION: string;
+    WITH_CREDENTIALS: boolean;
+    TOKEN?: string | Resolver<string>;
+    USERNAME?: string | Resolver<string>;
+    PASSWORD?: string | Resolver<string>;
+    HEADERS?: Headers | Resolver<Headers>;
+    ENCODE_PATH?: (path: string) => string;
+};
+export declare const OpenAPI: Config;
+export {};

package/src/lib/components/analytics/metadata-api/openapi/core/request.d.ts

@@ -0,0 +1,9 @@
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { ApiResult } from './ApiResult';
+/**
+ * Request using fetch client
+ * @param options The request options from the the service
+ * @returns ApiResult
+ * @throws ApiError
+ */
+export declare function request(options: ApiRequestOptions): Promise<ApiResult>;

package/src/lib/components/analytics/metadata-api/openapi/index.d.ts

@@ -0,0 +1,48 @@
+export { ApiError } from './core/ApiError';
+export { OpenAPI } from './core/OpenAPI';
+export type { AllCategoriesResponse } from './models/AllCategoriesResponse';
+export type { Author } from './models/Author';
+export type { BiServerResponse } from './models/BiServerResponse';
+export type { CategoriesResponse } from './models/CategoriesResponse';
+export type { DashboardCopyBody } from './models/DashboardCopyBody';
+export { DashboardCreateBody } from './models/DashboardCreateBody';
+export { DashboardPatchBody } from './models/DashboardPatchBody';
+export { DashboardPutBody } from './models/DashboardPutBody';
+export { DashboardView } from './models/DashboardView';
+export type { DashboardViewPagedResponse } from './models/DashboardViewPagedResponse';
+export type { Entity } from './models/Entity';
+export type { EntityAttribute } from './models/EntityAttribute';
+export type { EntityAttributePagedResponse } from './models/EntityAttributePagedResponse';
+export type { EntityAttributeRequest } from './models/EntityAttributeRequest';
+export type { EntityClass } from './models/EntityClass';
+export type { EntityClassPagedResponse } from './models/EntityClassPagedResponse';
+export type { EntityPagedResponse } from './models/EntityPagedResponse';
+export type { Error } from './models/Error';
+export type { GuestTokenRequest } from './models/GuestTokenRequest';
+export type { HealthCheckResponse } from './models/HealthCheckResponse';
+export type { HelpContent } from './models/HelpContent';
+export type { HelpContentCreateBody } from './models/HelpContentCreateBody';
+export type { HelpContentPagedResponse } from './models/HelpContentPagedResponse';
+export type { HelpContentPutBody } from './models/HelpContentPutBody';
+export type { MetadataResponse } from './models/MetadataResponse';
+export type { MSTRLoginTokenResponse } from './models/MSTRLoginTokenResponse';
+export type { MSTRServerResponse } from './models/MSTRServerResponse';
+export type { Origin } from './models/Origin';
+export type { OriginInstance } from './models/OriginInstance';
+export type { OriginInstancePagedResponse } from './models/OriginInstancePagedResponse';
+export type { OriginPagedResponse } from './models/OriginPagedResponse';
+export type { PaginationHeaders } from './models/PaginationHeaders';
+export type { PaginationMetadata } from './models/PaginationMetadata';
+export type { SSLoginTokenResponse } from './models/SSLoginTokenResponse';
+export type { TenantInfo } from './models/TenantInfo';
+export type { VersionResponse } from './models/VersionResponse';
+export { BiService } from './services/BiService';
+export { CategoriesService } from './services/CategoriesService';
+export { DashboardsService } from './services/DashboardsService';
+export { EntitiesService } from './services/EntitiesService';
+export { EntityAttributesService } from './services/EntityAttributesService';
+export { EntityClassService } from './services/EntityClassService';
+export { HelpContentService } from './services/HelpContentService';
+export { OriginInstancesService } from './services/OriginInstancesService';
+export { OriginsService } from './services/OriginsService';
+export { UtilityService } from './services/UtilityService';

package/src/lib/components/analytics/metadata-api/openapi/models/AllCategoriesResponse.d.ts

@@ -0,0 +1,3 @@
+export type AllCategoriesResponse = {
+    categories?: Record<string, Array<string>>;
+};

package/src/lib/components/analytics/metadata-api/openapi/models/Author.d.ts

@@ -0,0 +1,4 @@
+export type Author = {
+    id: string;
+    full_name: string;
+};

package/src/lib/components/analytics/metadata-api/openapi/models/BiServerResponse.d.ts

@@ -0,0 +1,3 @@
+export type BiServerResponse = {
+    url: string;
+};

package/src/lib/components/analytics/metadata-api/openapi/models/CategoriesResponse.d.ts

@@ -0,0 +1,3 @@
+export type CategoriesResponse = {
+    categories?: Array<string>;
+};

package/src/lib/components/analytics/metadata-api/openapi/models/DashboardCopyBody.d.ts

@@ -0,0 +1,18 @@
+export type DashboardCopyBody = {
+    /**
+     * Name of the dashboard to be copied.
+     */
+    name?: string | null;
+    /**
+     * Description of the dashboard.
+     */
+    description?: string | null;
+    /**
+     * List of application instances associated with this dashboard.
+     */
+    application_instances?: Array<string> | null;
+    /**
+     * List of categories associated with this dashboard.
+     */
+    categories?: Array<string> | null;
+};

package/src/lib/components/analytics/metadata-api/openapi/models/DashboardCreateBody.d.ts

@@ -0,0 +1,74 @@
+export type DashboardCreateBody = {
+    /**
+     * Name of the dashboard.
+     */
+    name: string;
+    /**
+     * App types that can be targeted by the dashboard.
+     */
+    target_apps: Array<'AGILITY' | 'RELEASE' | 'DEPLOY' | 'CONTINUOUSTEST' | 'TEAMFORGE'>;
+    /**
+     * Description of the dashboard.
+     */
+    description?: string | null;
+    /**
+     * The state of the dashboard.
+     */
+    lifecycle_state?: DashboardCreateBody.lifecycle_state | null;
+    /**
+     * Application instances associated with the dashboard.
+     */
+    application_instances?: Array<string> | null;
+    /**
+     * Categories associated with the dashboard.
+     */
+    categories?: Array<string> | null;
+    /**
+     * (Internal) BI type of the dashboard.
+     */
+    bi_type?: DashboardCreateBody.bi_type | null;
+    /**
+     * (Internal) Whether the dashboard is 'Out-of-the-box'.
+     */
+    is_ootb_dashboard?: boolean | null;
+    /**
+     * (Internal) Thumbnail representing dashboard. Base64 encoded SVG.
+     */
+    thumbnail?: string | null;
+    /**
+     * (Internal) ID of the dashboard in the BI tool.
+     */
+    external_id?: string | null;
+    /**
+     * (Internal) ID used to embed the dashboard from the BI tool. (superset only)
+     */
+    external_embedding_id?: string | null;
+    /**
+     * (Internal) Dictionary of data from the BI tool, for configuration and embedding.
+     */
+    external_object?: Record<string, any> | null;
+    /**
+     * (Internal) Dictionary of MSTR embed SDK props.
+     */
+    embed_config?: Record<string, any> | null;
+    /**
+     * (Internal) Id of a help content definition to show for the dashboard.
+     */
+    help_content_id?: string | null;
+};
+export declare namespace DashboardCreateBody {
+    /**
+     * The state of the dashboard.
+     */
+    enum lifecycle_state {
+        DRAFT = "DRAFT",
+        PUBLISHED = "PUBLISHED"
+    }
+    /**
+     * (Internal) BI type of the dashboard.
+     */
+    enum bi_type {
+        SUPERSET = "SUPERSET",
+        MICROSTRATEGY = "MICROSTRATEGY"
+    }
+}

package/src/lib/components/analytics/metadata-api/openapi/models/DashboardPatchBody.d.ts

@@ -0,0 +1,74 @@
+export type DashboardPatchBody = {
+    /**
+     * Name of the dashboard.
+     */
+    name?: string | null;
+    /**
+     * Description of the dashboard.
+     */
+    description?: string | null;
+    /**
+     * The state of the dashboard.
+     */
+    lifecycle_state?: DashboardPatchBody.lifecycle_state | null;
+    /**
+     * Application instances associated with the dashboard.
+     */
+    application_instances?: Array<string> | null;
+    /**
+     * Categories associated with the dashboard.
+     */
+    categories?: Array<string> | null;
+    /**
+     * App types that can be targeted by the dashboard.
+     */
+    target_apps?: Array<'AGILITY' | 'RELEASE' | 'DEPLOY' | 'CONTINUOUSTEST' | 'TEAMFORGE'> | null;
+    /**
+     * (Internal) BI type of the dashboard.
+     */
+    bi_type?: DashboardPatchBody.bi_type | null;
+    /**
+     * (Internal) Whether the dashboard is 'Out-of-the-box'.
+     */
+    is_ootb_dashboard?: boolean | null;
+    /**
+     * (Internal) Thumbnail representing dashboard. Base64 encoded SVG.
+     */
+    thumbnail?: string | null;
+    /**
+     * (Internal) ID of the dashboard in the BI tool.
+     */
+    external_id?: string | null;
+    /**
+     * (Internal) ID used to embed the dashboard from the BI tool. (superset only)
+     */
+    external_embedding_id?: string | null;
+    /**
+     * (Internal) Dictionary of data from the BI tool, for configuration and embedding.
+     */
+    external_object?: Record<string, any> | null;
+    /**
+     * (Internal) Dictionary of MSTR embed SDK props.
+     */
+    embed_config?: Record<string, any> | null;
+    /**
+     * (Internal) Id of a help content definition to show for the dashboard.
+     */
+    help_content_id?: string | null;
+};
+export declare namespace DashboardPatchBody {
+    /**
+     * The state of the dashboard.
+     */
+    enum lifecycle_state {
+        DRAFT = "DRAFT",
+        PUBLISHED = "PUBLISHED"
+    }
+    /**
+     * (Internal) BI type of the dashboard.
+     */
+    enum bi_type {
+        SUPERSET = "SUPERSET",
+        MICROSTRATEGY = "MICROSTRATEGY"
+    }
+}

package/src/lib/components/analytics/metadata-api/openapi/models/DashboardPutBody.d.ts

@@ -0,0 +1,74 @@
+export type DashboardPutBody = {
+    /**
+     * Name of the dashboard.
+     */
+    name: string;
+    /**
+     * Description of the dashboard.
+     */
+    description: string;
+    /**
+     * The state of the dashboard.
+     */
+    lifecycle_state: DashboardPutBody.lifecycle_state;
+    /**
+     * Application instances associated with the dashboard.
+     */
+    application_instances: Array<string>;
+    /**
+     * Categories associated with the dashboard.
+     */
+    categories: Array<string>;
+    /**
+     * App types that can be targeted by the dashboard.
+     */
+    target_apps: Array<'AGILITY' | 'RELEASE' | 'DEPLOY' | 'CONTINUOUSTEST' | 'TEAMFORGE'>;
+    /**
+     * (Internal) BI type of the dashboard.
+     */
+    bi_type?: DashboardPutBody.bi_type | null;
+    /**
+     * (Internal) Whether the dashboard is 'Out-of-the-box'.
+     */
+    is_ootb_dashboard?: boolean | null;
+    /**
+     * (Internal) Thumbnail representing dashboard. Base64 encoded SVG.
+     */
+    thumbnail?: string | null;
+    /**
+     * (Internal) ID of the dashboard in the BI tool.
+     */
+    external_id?: string | null;
+    /**
+     * (Internal) ID used to embed the dashboard from the BI tool. (superset only)
+     */
+    external_embedding_id?: string | null;
+    /**
+     * (Internal) Dictionary of data from the BI tool, for configuration and embedding.
+     */
+    external_object?: Record<string, any> | null;
+    /**
+     * (Internal) Dictionary of MSTR embed SDK props.
+     */
+    embed_config?: Record<string, any> | null;
+    /**
+     * (Internal) Id of a help content definition to show for the dashboard.
+     */
+    help_content_id?: string | null;
+};
+export declare namespace DashboardPutBody {
+    /**
+     * The state of the dashboard.
+     */
+    enum lifecycle_state {
+        DRAFT = "DRAFT",
+        PUBLISHED = "PUBLISHED"
+    }
+    /**
+     * (Internal) BI type of the dashboard.
+     */
+    enum bi_type {
+        SUPERSET = "SUPERSET",
+        MICROSTRATEGY = "MICROSTRATEGY"
+    }
+}

package/src/lib/components/analytics/metadata-api/openapi/models/DashboardView.d.ts

@@ -0,0 +1,106 @@
+export type DashboardView = {
+    /**
+     * The id of the dashboard.
+     */
+    id: string;
+    /**
+     * The full name of the dashboard author.
+     */
+    author_fullname: string;
+    /**
+     * The platform id of the dashboard author.
+     */
+    author_id: string;
+    /**
+     * Name of the dashboard.
+     */
+    name: string;
+    /**
+     * App types that can be targeted by the dashboard.
+     */
+    target_apps: Array<'AGILITY' | 'RELEASE' | 'DEPLOY' | 'CONTINUOUSTEST' | 'TEAMFORGE'>;
+    /**
+     * Description of the dashboard.
+     */
+    description: string;
+    /**
+     * The state of the dashboard.
+     */
+    lifecycle_state: DashboardView.lifecycle_state;
+    /**
+     * Application instances associated with the dashboard.
+     */
+    application_instances: Array<string>;
+    /**
+     * Categories associated with the dashboard.
+     */
+    categories: Array<string>;
+    /**
+     * BI type of the dashboard.
+     */
+    bi_type: DashboardView.bi_type;
+    /**
+     * Whether the dashboard is 'Out-of-the-box'.
+     */
+    is_ootb_dashboard: boolean;
+    /**
+     * Thumbnail representing dashboard. Base64 encoded SVG.
+     */
+    thumbnail: string;
+    /**
+     * ID of the dashboard in the BI tool.
+     */
+    external_id: string;
+    /**
+     * ID used to embed the dashboard from the BI tool. (superset only)
+     */
+    external_embedding_id: string;
+    /**
+     * Dictionary of data from the BI tool, for configuration and embedding.
+     */
+    external_object: Record<string, any>;
+    /**
+     * Dictionary of MSTR embed SDK props.
+     */
+    embed_config: Record<string, any>;
+    /**
+     * Id of a help content definition to show for the dashboard.
+     */
+    help_content_id: string;
+    /**
+     * The url of the underlying BI server.
+     */
+    server_url: string;
+    /**
+     * The url of the dashboard.
+     */
+    dashboard_url: string;
+    /**
+     * Filter configurations for the dashboard.
+     */
+    filter_configuration: Array<any>;
+    /**
+     * The date and time that the dashboard was created.
+     */
+    created_dt?: string | null;
+    /**
+     * Whether the dashboard is marked as a favorite by this user.
+     */
+    favorite: boolean;
+};
+export declare namespace DashboardView {
+    /**
+     * The state of the dashboard.
+     */
+    enum lifecycle_state {
+        DRAFT = "DRAFT",
+        PUBLISHED = "PUBLISHED"
+    }
+    /**
+     * BI type of the dashboard.
+     */
+    enum bi_type {
+        SUPERSET = "SUPERSET",
+        MICROSTRATEGY = "MICROSTRATEGY"
+    }
+}

package/src/lib/components/analytics/metadata-api/openapi/models/DashboardViewPagedResponse.d.ts

@@ -0,0 +1,6 @@
+import type { DashboardView } from './DashboardView';
+import type { PaginationHeaders } from './PaginationHeaders';
+export type DashboardViewPagedResponse = {
+    results: Array<DashboardView>;
+    pagination: PaginationHeaders;
+};