@thoughtspot/visual-embed-sdk 1.33.3 → 1.33.5

package/dist/visual-embed-sdk-react-full.d.ts

@@ -1118,7 +1118,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
         /**
-            * This flag is used to enable the 2 column layout in liveboard
+            * This attribute can be used to enable the two-column layout on an embedded Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -1132,17 +1132,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         enable2ColumnLayout?: boolean;
         /**
-            * Flag to use OnBeforeSearchExecute embed event
+            * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
             * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
             */
         isOnBeforeGetVizDataInterceptEnabled?: boolean;
         /**
             * Flag to use home page search bar mode
-            * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
+            * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
             */
         homePageSearchBarMode?: HomePageSearchBarMode;
         /**
-            * This flag is used to enable the compact header in liveboard
+            * This flag can be used to enable the compact header in Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -1156,7 +1156,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         isLiveboardCompactHeaderEnabled?: boolean;
         /**
-            * This flag is used to show/hide verified Icon in liveboard compact header
+            * This flag can be used to show or hide the Liveboard verified icon in the compact header.
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1170,7 +1170,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1183,6 +1183,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```
             */
         showLiveboardReverifyBanner?: boolean;
+        /**
+            * This flag is used to enable unified search experience for full app embed.
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    isUnifiedSearchExperienceEnabled: true,
+            * })
+            * ```
+            */
+        isUnifiedSearchExperienceEnabled?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -1670,10 +1684,13 @@ export declare const handleAuth: () => Promise<boolean>;
     * to your app.
     * @param url The URL provided for prefetch
     * @param prefetchFeatures Specify features which needs to be prefetched.
+    * @param additionalFlags This can be used to add any URL flag.
     * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
     * @group Global methods
     */
-export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[]) => void;
+export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], additionalFlags?: {
+        [key: string]: string | number | boolean;
+}) => void;
 /**
     * Initializes the Visual Embed SDK globally and perform
     * authentication if applicable. This function needs to be called before any ThoughtSpot
@@ -1777,6 +1794,10 @@ export declare const exportTML: (data: exportTMLInput) => Promise<any>;
     */
 export declare function reset(): void;
 
+/**
+    * Configuration for bodyless conversation options.
+    * @group Embed components
+    */
 export interface BodylessConversationViewConfig extends ViewConfig {
         /**
             * The ID of the worksheet to use for the conversation.
@@ -1786,6 +1807,19 @@ export interface BodylessConversationViewConfig extends ViewConfig {
 /**
     * Create a conversation embed, which can be integrated inside
     * chatbots or other conversational interfaces.
+    * @example
+    * ```js
+    * import { BodylessConversation } from '@thoughtspot/visual-embed-sdk';
+    *
+    * const conversation = new BodylessConversation({
+    *  worksheetId: 'worksheetId',
+    * });
+    *
+    * const { container, error } = await conversation.sendMessage('show me sales by region');
+    *
+    * // append the container to the DOM
+    * document.body.appendChild(container); // or to any other element
+    * ```
     * @group Embed components
     * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
     */
@@ -2591,6 +2625,28 @@ export interface EmbedConfig {
             * @version SDK 1.32.3 | Thoughtspot: *
             */
         disableLoginFailurePage?: boolean;
+        /**
+            * This is an object (key/val) of override flags which will be applied
+            * to the internal embedded object. This can be used to add any
+            * URL flag.
+            * Warning: This option is for advanced use only and is used internally
+            * to control embed behavior in non-regular ways. We do not publish the
+            * list of supported keys and values associated with each.
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   ... // other liveboard view config
+            *   additionalFlags: {
+            *        flag1: 'value1',
+            *        flag2: 'value2'
+            *     }
+            * });
+            * ```
+            * @version SDK: 1.33.5 | ThoughtSpot: *
+            */
+        additionalFlags?: {
+                [key: string]: string | number | boolean;
+        };
 }
 export interface LayoutConfig {
 }
@@ -2778,6 +2834,7 @@ export interface ViewConfig {
             * This is an object (key/val) of override flags which will be applied
             * to the internal embedded object. This can be used to add any
             * URL flag.
+            * If the same flags are passed in init, they will be overriden by the values here.
             * Warning: This option is for advanced use only and is used internally
             * to control embed behavior in non-regular ways. We do not publish the
             * list of supported keys and values associated with each.
@@ -3016,7 +3073,7 @@ export interface ViewConfig {
             */
         enableV2Shell_experimental?: boolean;
         /**
-            * To set the initial state of the search bar in case of saved-answers.
+            * To set the initial state of the search bar in case of saved Answers.
             * @default true
             * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
             * @example
@@ -3029,7 +3086,7 @@ export interface ViewConfig {
         collapseSearchBar?: boolean;
         /**
             * This flag can be used to disable links inside the embedded app,
-            * and disables redirection of links in a new tab.
+            * and disable redirection of links in a new tab.
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -3041,7 +3098,7 @@ export interface ViewConfig {
         disableRedirectionLinksInNewTab?: boolean;
         /**
             * Flag to control Data panel experience
-            * @default true
+            * @default false
             * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
             * @example
             * ```js
@@ -3065,6 +3122,19 @@ export interface ViewConfig {
             * ```
             */
         enableCustomColumnGroups?: boolean;
+        /**
+            * View content for another org directly without having to use the org switcher
+            * This flag is honoured if orgPerUrl feature is enabled for the ThoughtSpot cluster
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   ... // other options
+            *   overrideOrgId: 142536
+            * });
+            * ```
+            * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
+            */
+        overrideOrgId?: number;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3110,7 +3180,7 @@ export type MessageCallbackObj = {
 };
 export type GenericCallbackFn = (...args: any[]) => any;
 export type QueryParams = {
-        [key: string]: string;
+        [key: string]: string | boolean | number;
 };
 /**
     * A map of the supported runtime filter operations
@@ -4149,22 +4219,26 @@ export declare enum EmbedEvent {
             */
         Rename = "rename",
         /**
-            * Emitted if the user wants to intercept the search execution
-            * and implement logic to decide whether to run the search or not
             *
-            * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
+            * This event can be emitted to intercept search execution initiated by
+            * the users and implement the logic to allow or restrict search execution.
+            * You can can also show custom error text if the search query must be
+            * restricted due to your application or business requirements.
+
+            * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
             * for this embed event to get emitted.
             * @param: payload
             * @param: responder
             * Contains elements that lets developers define whether ThoughtSpot
-            * will run the search or not, and if not, which error message to provide.
+            * should run the search, and if not, what error message
+            * should be shown to the user.
             *
-            * execute: When execute returns true, the search will be run.
-            * When execute returns false, the search will not be executed.
+            * execute: When execute returns `true`, the search will be run.
+            * When execute returns `false`, the search will not be executed.
             *
-            * error: Developers can customize the user facing message when execute is
-            * set to false using the error parameter in responder
-            * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+            * error: Developers can customize the error message text when `execute`
+            * returns `false` using the error parameter in responder.
+            * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
             * @example
             *```js
             * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -4204,15 +4278,15 @@ export declare enum EmbedEvent {
             */
         OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
         /**
-            * Emitted when parameter changes in an answer
-            * or liveboard
+            * Emitted when parameter changes in an Answer
+            * or Liveboard
             *
             * ```js
             * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
             *     console.log('payload', payload);
             * })
             *```
-            * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+            * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
             */
         ParameterChanged = "parameterChanged"
 }
@@ -4941,11 +5015,13 @@ export declare enum HostEvent {
             *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
             *
             * `values` - An array of one or several values. The value definition on the
-            *  data type you choose to filter on. For a complete list of supported data types, see
-            *  link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types]
+            *  data type you choose to filter on. For a complete list of supported data types,
+            *  see
+            *  link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported
+            *  data types].
+            *
             * `type`  - To update filters for date time, specify the date format type.
             * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
-            *
             * @example
             * ```js
             *
@@ -5230,7 +5306,9 @@ export declare enum Param {
         ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
         ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
         LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled",
-        SpotterEnabled = "isSpotterExperienceEnabled"
+        SpotterEnabled = "isSpotterExperienceEnabled",
+        IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled",
+        OverrideOrgId = "orgId"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -6200,7 +6278,7 @@ export declare enum Action {
             */
         AIHighlights = "AIHighlights",
         /**
-            * Action ID for edit schedule action on schedule on homepage
+            * Action ID for edit the schedule action on schedule on homepage
             * @example
             * ```js
             * disabledActions: [Action.EditScheduleHomepage]
@@ -6261,7 +6339,16 @@ export declare enum Action {
             * ```
             *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
             */
-        KPIAnalysisCTA = "kpiAnalysisCTA"
+        KPIAnalysisCTA = "kpiAnalysisCTA",
+        /**
+            * Action ID for disabling chip reorder in Answer and Liveboard
+            * @example
+            * ```js
+            * const disabledActions = [Action.DisableChipReorder]
+            * ```
+            * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
+            */
+        DisableChipReorder = "disableChipReorder"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;

package/dist/visual-embed-sdk-react.d.ts

@@ -1108,7 +1108,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
         /**
-            * This flag is used to enable the 2 column layout in liveboard
+            * This attribute can be used to enable the two-column layout on an embedded Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -1122,17 +1122,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         enable2ColumnLayout?: boolean;
         /**
-            * Flag to use OnBeforeSearchExecute embed event
+            * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
             * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
             */
         isOnBeforeGetVizDataInterceptEnabled?: boolean;
         /**
             * Flag to use home page search bar mode
-            * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
+            * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
             */
         homePageSearchBarMode?: HomePageSearchBarMode;
         /**
-            * This flag is used to enable the compact header in liveboard
+            * This flag can be used to enable the compact header in Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -1146,7 +1146,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         isLiveboardCompactHeaderEnabled?: boolean;
         /**
-            * This flag is used to show/hide verified Icon in liveboard compact header
+            * This flag can be used to show or hide the Liveboard verified icon in the compact header.
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1160,7 +1160,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1173,6 +1173,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```
             */
         showLiveboardReverifyBanner?: boolean;
+        /**
+            * This flag is used to enable unified search experience for full app embed.
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    isUnifiedSearchExperienceEnabled: true,
+            * })
+            * ```
+            */
+        isUnifiedSearchExperienceEnabled?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -2203,6 +2217,28 @@ export interface EmbedConfig {
             * @version SDK 1.32.3 | Thoughtspot: *
             */
         disableLoginFailurePage?: boolean;
+        /**
+            * This is an object (key/val) of override flags which will be applied
+            * to the internal embedded object. This can be used to add any
+            * URL flag.
+            * Warning: This option is for advanced use only and is used internally
+            * to control embed behavior in non-regular ways. We do not publish the
+            * list of supported keys and values associated with each.
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   ... // other liveboard view config
+            *   additionalFlags: {
+            *        flag1: 'value1',
+            *        flag2: 'value2'
+            *     }
+            * });
+            * ```
+            * @version SDK: 1.33.5 | ThoughtSpot: *
+            */
+        additionalFlags?: {
+                [key: string]: string | number | boolean;
+        };
 }
 export interface LayoutConfig {
 }
@@ -2390,6 +2426,7 @@ export interface ViewConfig {
             * This is an object (key/val) of override flags which will be applied
             * to the internal embedded object. This can be used to add any
             * URL flag.
+            * If the same flags are passed in init, they will be overriden by the values here.
             * Warning: This option is for advanced use only and is used internally
             * to control embed behavior in non-regular ways. We do not publish the
             * list of supported keys and values associated with each.
@@ -2628,7 +2665,7 @@ export interface ViewConfig {
             */
         enableV2Shell_experimental?: boolean;
         /**
-            * To set the initial state of the search bar in case of saved-answers.
+            * To set the initial state of the search bar in case of saved Answers.
             * @default true
             * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
             * @example
@@ -2641,7 +2678,7 @@ export interface ViewConfig {
         collapseSearchBar?: boolean;
         /**
             * This flag can be used to disable links inside the embedded app,
-            * and disables redirection of links in a new tab.
+            * and disable redirection of links in a new tab.
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -2653,7 +2690,7 @@ export interface ViewConfig {
         disableRedirectionLinksInNewTab?: boolean;
         /**
             * Flag to control Data panel experience
-            * @default true
+            * @default false
             * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
             * @example
             * ```js
@@ -2677,6 +2714,19 @@ export interface ViewConfig {
             * ```
             */
         enableCustomColumnGroups?: boolean;
+        /**
+            * View content for another org directly without having to use the org switcher
+            * This flag is honoured if orgPerUrl feature is enabled for the ThoughtSpot cluster
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed', {
+            *   ... // other options
+            *   overrideOrgId: 142536
+            * });
+            * ```
+            * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
+            */
+        overrideOrgId?: number;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2722,7 +2772,7 @@ export type MessageCallbackObj = {
 };
 export type GenericCallbackFn = (...args: any[]) => any;
 export type QueryParams = {
-        [key: string]: string;
+        [key: string]: string | boolean | number;
 };
 /**
     * A map of the supported runtime filter operations
@@ -3761,22 +3811,26 @@ export declare enum EmbedEvent {
             */
         Rename = "rename",
         /**
-            * Emitted if the user wants to intercept the search execution
-            * and implement logic to decide whether to run the search or not
             *
-            * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
+            * This event can be emitted to intercept search execution initiated by
+            * the users and implement the logic to allow or restrict search execution.
+            * You can can also show custom error text if the search query must be
+            * restricted due to your application or business requirements.
+
+            * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
             * for this embed event to get emitted.
             * @param: payload
             * @param: responder
             * Contains elements that lets developers define whether ThoughtSpot
-            * will run the search or not, and if not, which error message to provide.
+            * should run the search, and if not, what error message
+            * should be shown to the user.
             *
-            * execute: When execute returns true, the search will be run.
-            * When execute returns false, the search will not be executed.
+            * execute: When execute returns `true`, the search will be run.
+            * When execute returns `false`, the search will not be executed.
             *
-            * error: Developers can customize the user facing message when execute is
-            * set to false using the error parameter in responder
-            * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+            * error: Developers can customize the error message text when `execute`
+            * returns `false` using the error parameter in responder.
+            * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
             * @example
             *```js
             * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -3816,15 +3870,15 @@ export declare enum EmbedEvent {
             */
         OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
         /**
-            * Emitted when parameter changes in an answer
-            * or liveboard
+            * Emitted when parameter changes in an Answer
+            * or Liveboard
             *
             * ```js
             * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
             *     console.log('payload', payload);
             * })
             *```
-            * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+            * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
             */
         ParameterChanged = "parameterChanged"
 }
@@ -4553,11 +4607,13 @@ export declare enum HostEvent {
             *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
             *
             * `values` - An array of one or several values. The value definition on the
-            *  data type you choose to filter on. For a complete list of supported data types, see
-            *  link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types]
+            *  data type you choose to filter on. For a complete list of supported data types,
+            *  see
+            *  link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported
+            *  data types].
+            *
             * `type`  - To update filters for date time, specify the date format type.
             * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
-            *
             * @example
             * ```js
             *
@@ -4842,7 +4898,9 @@ export declare enum Param {
         ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
         ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
         LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled",
-        SpotterEnabled = "isSpotterExperienceEnabled"
+        SpotterEnabled = "isSpotterExperienceEnabled",
+        IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled",
+        OverrideOrgId = "orgId"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -5812,7 +5870,7 @@ export declare enum Action {
             */
         AIHighlights = "AIHighlights",
         /**
-            * Action ID for edit schedule action on schedule on homepage
+            * Action ID for edit the schedule action on schedule on homepage
             * @example
             * ```js
             * disabledActions: [Action.EditScheduleHomepage]
@@ -5873,7 +5931,16 @@ export declare enum Action {
             * ```
             *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
             */
-        KPIAnalysisCTA = "kpiAnalysisCTA"
+        KPIAnalysisCTA = "kpiAnalysisCTA",
+        /**
+            * Action ID for disabling chip reorder in Answer and Liveboard
+            * @example
+            * ```js
+            * const disabledActions = [Action.DisableChipReorder]
+            * ```
+            * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
+            */
+        DisableChipReorder = "disableChipReorder"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -6324,10 +6391,13 @@ export declare const handleAuth: () => Promise<boolean>;
     * to your app.
     * @param url The URL provided for prefetch
     * @param prefetchFeatures Specify features which needs to be prefetched.
+    * @param additionalFlags This can be used to add any URL flag.
     * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
     * @group Global methods
     */
-export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[]) => void;
+export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], additionalFlags?: {
+        [key: string]: string | number | boolean;
+}) => void;
 /**
     * Initializes the Visual Embed SDK globally and perform
     * authentication if applicable. This function needs to be called before any ThoughtSpot
@@ -6431,6 +6501,10 @@ export declare const exportTML: (data: exportTMLInput) => Promise<any>;
     */
 export declare function reset(): void;
 
+/**
+    * Configuration for bodyless conversation options.
+    * @group Embed components
+    */
 export interface BodylessConversationViewConfig extends ViewConfig {
         /**
             * The ID of the worksheet to use for the conversation.
@@ -6440,6 +6514,19 @@ export interface BodylessConversationViewConfig extends ViewConfig {
 /**
     * Create a conversation embed, which can be integrated inside
     * chatbots or other conversational interfaces.
+    * @example
+    * ```js
+    * import { BodylessConversation } from '@thoughtspot/visual-embed-sdk';
+    *
+    * const conversation = new BodylessConversation({
+    *  worksheetId: 'worksheetId',
+    * });
+    *
+    * const { container, error } = await conversation.sendMessage('show me sales by region');
+    *
+    * // append the container to the DOM
+    * document.body.appendChild(container); // or to any other element
+    * ```
     * @group Embed components
     * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
     */