@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.2

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 (173) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/auth.d.ts +29 -4
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +29 -4
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/css-variables.d.ts +17 -17
  7. package/cjs/src/embed/app.d.ts +60 -32
  8. package/cjs/src/embed/app.d.ts.map +1 -1
  9. package/cjs/src/embed/app.js +10 -3
  10. package/cjs/src/embed/app.js.map +1 -1
  11. package/cjs/src/embed/app.spec.js +34 -1
  12. package/cjs/src/embed/app.spec.js.map +1 -1
  13. package/cjs/src/embed/base.d.ts +2 -2
  14. package/cjs/src/embed/base.js +2 -2
  15. package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
  16. package/cjs/src/embed/bodyless-conversation.js +4 -4
  17. package/cjs/src/embed/conversation.d.ts +43 -30
  18. package/cjs/src/embed/conversation.d.ts.map +1 -1
  19. package/cjs/src/embed/conversation.js +10 -11
  20. package/cjs/src/embed/conversation.js.map +1 -1
  21. package/cjs/src/embed/conversation.spec.js +27 -0
  22. package/cjs/src/embed/conversation.spec.js.map +1 -1
  23. package/cjs/src/embed/liveboard.d.ts +40 -34
  24. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  25. package/cjs/src/embed/liveboard.js +1 -1
  26. package/cjs/src/embed/liveboard.js.map +1 -1
  27. package/cjs/src/embed/liveboard.spec.js +1 -1
  28. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  29. package/cjs/src/embed/sage.d.ts +5 -5
  30. package/cjs/src/embed/sage.js +1 -1
  31. package/cjs/src/embed/search-bar.d.ts +7 -7
  32. package/cjs/src/embed/search-bar.js +1 -1
  33. package/cjs/src/embed/search.d.ts +13 -12
  34. package/cjs/src/embed/search.d.ts.map +1 -1
  35. package/cjs/src/embed/search.js.map +1 -1
  36. package/cjs/src/embed/ts-embed.d.ts +3 -3
  37. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  38. package/cjs/src/embed/ts-embed.js +12 -6
  39. package/cjs/src/embed/ts-embed.js.map +1 -1
  40. package/cjs/src/embed/ts-embed.spec.js +35 -0
  41. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  42. package/cjs/src/react/index.d.ts +15 -15
  43. package/cjs/src/react/index.js +12 -12
  44. package/cjs/src/tokenizedFetch.d.ts +1 -1
  45. package/cjs/src/tokenizedFetch.js +1 -1
  46. package/cjs/src/types.d.ts +294 -255
  47. package/cjs/src/types.d.ts.map +1 -1
  48. package/cjs/src/types.js +206 -200
  49. package/cjs/src/types.js.map +1 -1
  50. package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
  51. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  52. package/cjs/src/utils/graphql/answerService/answerService.js +6 -4
  53. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  54. package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
  55. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  56. package/cjs/src/utils.d.ts +9 -0
  57. package/cjs/src/utils.d.ts.map +1 -1
  58. package/cjs/src/utils.js +10 -1
  59. package/cjs/src/utils.js.map +1 -1
  60. package/dist/{index-Vyh6Ha5f.js → index-DkizS4xM.js} +1 -1
  61. package/dist/src/auth.d.ts +29 -4
  62. package/dist/src/auth.d.ts.map +1 -1
  63. package/dist/src/css-variables.d.ts +17 -17
  64. package/dist/src/embed/app.d.ts +60 -32
  65. package/dist/src/embed/app.d.ts.map +1 -1
  66. package/dist/src/embed/base.d.ts +2 -2
  67. package/dist/src/embed/bodyless-conversation.d.ts +5 -5
  68. package/dist/src/embed/conversation.d.ts +43 -30
  69. package/dist/src/embed/conversation.d.ts.map +1 -1
  70. package/dist/src/embed/liveboard.d.ts +40 -34
  71. package/dist/src/embed/liveboard.d.ts.map +1 -1
  72. package/dist/src/embed/sage.d.ts +5 -5
  73. package/dist/src/embed/search-bar.d.ts +7 -7
  74. package/dist/src/embed/search.d.ts +13 -12
  75. package/dist/src/embed/search.d.ts.map +1 -1
  76. package/dist/src/embed/ts-embed.d.ts +3 -3
  77. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  78. package/dist/src/react/index.d.ts +15 -15
  79. package/dist/src/tokenizedFetch.d.ts +1 -1
  80. package/dist/src/types.d.ts +294 -255
  81. package/dist/src/types.d.ts.map +1 -1
  82. package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
  83. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  84. package/dist/src/utils.d.ts +9 -0
  85. package/dist/src/utils.d.ts.map +1 -1
  86. package/dist/tsembed-react.es.js +307 -275
  87. package/dist/tsembed-react.js +306 -274
  88. package/dist/tsembed.es.js +299 -267
  89. package/dist/tsembed.js +298 -266
  90. package/dist/visual-embed-sdk-react-full.d.ts +520 -409
  91. package/dist/visual-embed-sdk-react.d.ts +518 -407
  92. package/dist/visual-embed-sdk.d.ts +519 -408
  93. package/lib/package.json +1 -1
  94. package/lib/src/auth.d.ts +29 -4
  95. package/lib/src/auth.d.ts.map +1 -1
  96. package/lib/src/auth.js +29 -4
  97. package/lib/src/auth.js.map +1 -1
  98. package/lib/src/css-variables.d.ts +17 -17
  99. package/lib/src/embed/app.d.ts +60 -32
  100. package/lib/src/embed/app.d.ts.map +1 -1
  101. package/lib/src/embed/app.js +11 -4
  102. package/lib/src/embed/app.js.map +1 -1
  103. package/lib/src/embed/app.spec.js +34 -1
  104. package/lib/src/embed/app.spec.js.map +1 -1
  105. package/lib/src/embed/base.d.ts +2 -2
  106. package/lib/src/embed/base.js +2 -2
  107. package/lib/src/embed/bodyless-conversation.d.ts +5 -5
  108. package/lib/src/embed/bodyless-conversation.js +4 -4
  109. package/lib/src/embed/conversation.d.ts +43 -30
  110. package/lib/src/embed/conversation.d.ts.map +1 -1
  111. package/lib/src/embed/conversation.js +11 -11
  112. package/lib/src/embed/conversation.js.map +1 -1
  113. package/lib/src/embed/conversation.spec.js +27 -0
  114. package/lib/src/embed/conversation.spec.js.map +1 -1
  115. package/lib/src/embed/liveboard.d.ts +40 -34
  116. package/lib/src/embed/liveboard.d.ts.map +1 -1
  117. package/lib/src/embed/liveboard.js +1 -1
  118. package/lib/src/embed/liveboard.js.map +1 -1
  119. package/lib/src/embed/liveboard.spec.js +1 -1
  120. package/lib/src/embed/liveboard.spec.js.map +1 -1
  121. package/lib/src/embed/sage.d.ts +5 -5
  122. package/lib/src/embed/sage.js +1 -1
  123. package/lib/src/embed/search-bar.d.ts +7 -7
  124. package/lib/src/embed/search-bar.js +1 -1
  125. package/lib/src/embed/search.d.ts +13 -12
  126. package/lib/src/embed/search.d.ts.map +1 -1
  127. package/lib/src/embed/search.js.map +1 -1
  128. package/lib/src/embed/ts-embed.d.ts +3 -3
  129. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  130. package/lib/src/embed/ts-embed.js +12 -6
  131. package/lib/src/embed/ts-embed.js.map +1 -1
  132. package/lib/src/embed/ts-embed.spec.js +35 -0
  133. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  134. package/lib/src/react/index.d.ts +15 -15
  135. package/lib/src/react/index.js +12 -12
  136. package/lib/src/tokenizedFetch.d.ts +1 -1
  137. package/lib/src/tokenizedFetch.js +1 -1
  138. package/lib/src/types.d.ts +294 -255
  139. package/lib/src/types.d.ts.map +1 -1
  140. package/lib/src/types.js +206 -200
  141. package/lib/src/types.js.map +1 -1
  142. package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
  143. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  144. package/lib/src/utils/graphql/answerService/answerService.js +5 -3
  145. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  146. package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
  147. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  148. package/lib/src/utils.d.ts +9 -0
  149. package/lib/src/utils.d.ts.map +1 -1
  150. package/lib/src/utils.js +8 -0
  151. package/lib/src/utils.js.map +1 -1
  152. package/package.json +1 -1
  153. package/src/auth.ts +29 -4
  154. package/src/css-variables.ts +17 -17
  155. package/src/embed/app.spec.ts +46 -1
  156. package/src/embed/app.ts +72 -35
  157. package/src/embed/base.ts +2 -2
  158. package/src/embed/bodyless-conversation.ts +5 -5
  159. package/src/embed/conversation.spec.ts +37 -0
  160. package/src/embed/conversation.ts +55 -38
  161. package/src/embed/liveboard.spec.ts +1 -1
  162. package/src/embed/liveboard.ts +40 -34
  163. package/src/embed/sage.ts +5 -5
  164. package/src/embed/search-bar.tsx +7 -7
  165. package/src/embed/search.ts +13 -12
  166. package/src/embed/ts-embed.spec.ts +42 -0
  167. package/src/embed/ts-embed.ts +11 -6
  168. package/src/react/index.tsx +15 -15
  169. package/src/tokenizedFetch.ts +1 -1
  170. package/src/types.ts +293 -254
  171. package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
  172. package/src/utils/graphql/answerService/answerService.ts +6 -3
  173. package/src/utils.ts +14 -0
@@ -428,37 +428,37 @@ export interface CustomCssVariables {
428
428
  /**
429
429
  * Padding of the groups in the Liveboard.
430
430
  *
431
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
431
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
432
432
  */
433
433
  "--ts-var-liveboard-group-padding"?: string;
434
434
  /**
435
435
  * Font size of the title of the groups in the Liveboard.
436
436
  *
437
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
437
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
438
438
  */
439
439
  "--ts-var-liveboard-group-title-font-size"?: string;
440
440
  /**
441
441
  * Font weight of the title of the groups in the Liveboard.
442
442
  *
443
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
443
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
444
444
  */
445
445
  "--ts-var-liveboard-group-title-font-weight"?: string;
446
446
  /**
447
447
  * Font size of the title of the tiles inside the groups in the Liveboard.
448
448
  *
449
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
449
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
450
450
  */
451
451
  "--ts-var-liveboard-group-tile-title-font-size"?: string;
452
452
  /**
453
453
  * Font weight of the title of the tiles inside the groups in the Liveboard.
454
454
  *
455
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
455
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
456
456
  */
457
457
  "--ts-var-liveboard-group-tile-title-font-weight"?: string;
458
458
  /**
459
459
  * Padding of the group tiles in the Liveboard.
460
460
  *
461
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
461
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
462
462
  */
463
463
  "--ts-var-liveboard-group-tile-padding"?: string;
464
464
  /**
@@ -468,13 +468,13 @@ export interface CustomCssVariables {
468
468
  /**
469
469
  * Background color of the groups in the Liveboard.
470
470
  *
471
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
471
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
472
472
  */
473
473
  "--ts-var-liveboard-group-background"?: string;
474
474
  /**
475
475
  * Border color of the groups in the Liveboard.
476
476
  *
477
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
477
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
478
478
  */
479
479
  "--ts-var-liveboard-group-border-color"?: string;
480
480
  /**
@@ -488,55 +488,55 @@ export interface CustomCssVariables {
488
488
  /**
489
489
  * Font color of the title of the groups in the Liveboard.
490
490
  *
491
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
491
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
492
492
  */
493
493
  "--ts-var-liveboard-group-title-font-color"?: string;
494
494
  /**
495
495
  * Font color of the description of the groups in the Liveboard.
496
496
  *
497
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
497
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
498
498
  */
499
499
  "--ts-var-liveboard-group-description-font-color"?: string;
500
500
  /**
501
501
  * Font color of the title of the tiles inside the groups in the Liveboard.
502
502
  *
503
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
503
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
504
504
  */
505
505
  "--ts-var-liveboard-group-tile-title-font-color"?: string;
506
506
  /**
507
507
  * Font color of the description of the tiles inside the groups in the Liveboard.
508
508
  *
509
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
509
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
510
510
  */
511
511
  "--ts-var-liveboard-group-tile-description-font-color"?: string;
512
512
  /**
513
513
  * Background color of the tiles inside the groups in the Liveboard.
514
514
  *
515
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
515
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
516
516
  */
517
517
  "--ts-var-liveboard-group-tile-background"?: string;
518
518
  /**
519
519
  * Background color of the filter chips in the Liveboard.
520
520
  *
521
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
521
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
522
522
  */
523
523
  "--ts-var-liveboard-chip-background"?: string;
524
524
  /**
525
525
  * Font color of the filter chips in the Liveboard.
526
526
  *
527
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
527
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
528
528
  */
529
529
  "--ts-var-liveboard-chip-color"?: string;
530
530
  /**
531
531
  * Background color of the filter chips in the Liveboard on hover.
532
532
  *
533
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
533
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
534
534
  */
535
535
  "--ts-var-liveboard-chip--hover-background"?: string;
536
536
  /**
537
537
  * Background color of the filter chips in the Liveboard on active.
538
538
  *
539
- * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable.
539
+ * Please enable the Liveboard Masterpieces feature in your ThoughtSpot instance and then set the isLiveboardMasterpiecesEnabled SDK flag to true to start modifying this CSS variable.
540
540
  */
541
541
  "--ts-var-liveboard-chip--active-background"?: string;
542
542
  /**
@@ -809,6 +809,7 @@ declare class AnswerService {
809
809
  * ]);
810
810
  * console.log(await service.fetchData());
811
811
  * });
812
+ * ```
812
813
  */
813
814
  addColumnsByName(columnNames: string[]): Promise<any>;
814
815
  /**
@@ -880,7 +881,7 @@ declare class AnswerService {
880
881
  * const data = await underlying.fetchData(0, 100);
881
882
  * })
882
883
  * ```
883
- * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
884
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0.cl
884
885
  */
885
886
  getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
886
887
  /**
@@ -921,6 +922,7 @@ declare enum AuthType {
921
922
  * To use this:
922
923
  * Your SAML or OpenID provider must allow iframe redirects.
923
924
  * For example, if you are using Okta as IdP, you can enable iframe embedding.
925
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
924
926
  * @example
925
927
  * ```js
926
928
  * init({
@@ -928,18 +930,17 @@ declare enum AuthType {
928
930
  * authType: AuthType.EmbeddedSSO,
929
931
  * });
930
932
  * ```
931
- * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
932
933
  */
933
934
  EmbeddedSSO = "EmbeddedSSO",
934
935
  /**
935
- * SSO using SAML
936
- * @deprecated Use {@link SAMLRedirect} instead
936
+ * SSO using SAML, Use {@link SAMLRedirect} instead
937
+ * @deprecated This option is deprecated.
937
938
  * @hidden
938
939
  */
939
940
  SSO = "SSO_SAML",
940
941
  /**
941
- * SSO using SAML
942
- * @deprecated Use {@link SAMLRedirect} instead
942
+ * SSO using SAML, Use {@link SAMLRedirect} instead
943
+ * @deprecated This option is deprecated.
943
944
  * @hidden
944
945
  */
945
946
  SAML = "SSO_SAML",
@@ -990,8 +991,9 @@ declare enum AuthType {
990
991
  SAMLRedirect = "SSO_SAML",
991
992
  /**
992
993
  * SSO using OIDC
994
+ * SSO using OIDC, Use {@link OIDCRedirect} instead
995
+ * @deprecated This option is deprecated.
993
996
  * @hidden
994
- * @deprecated Use {@link OIDCRedirect} instead
995
997
  */
996
998
  OIDC = "SSO_OIDC",
997
999
  /**
@@ -1002,8 +1004,9 @@ declare enum AuthType {
1002
1004
  OIDCRedirect = "SSO_OIDC",
1003
1005
  /**
1004
1006
  * Trusted authentication server
1007
+ * Use {@link TrustedAuth} instead
1008
+ * @deprecated This option is deprecated.
1005
1009
  * @hidden
1006
- * @deprecated Use {@link TrustedAuth} instead
1007
1010
  */
1008
1011
  AuthServer = "AuthServer",
1009
1012
  /**
@@ -1030,6 +1033,7 @@ declare enum AuthType {
1030
1033
  * obtained from ThoughtSpot. This uses a cookieless authentication
1031
1034
  * approach, recommended to bypass the third-party cookie-blocking restriction
1032
1035
  * implemented by some browsers.
1036
+ * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1033
1037
  * @example
1034
1038
  * ```js
1035
1039
  * init({
@@ -1040,8 +1044,8 @@ declare enum AuthType {
1040
1044
  * .then((response) => response.json())
1041
1045
  * .then((data) => data.token);
1042
1046
  * }
1047
+ * });
1043
1048
  * ```
1044
- * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1045
1049
  */
1046
1050
  TrustedAuthTokenCookieless = "AuthServerCookieless",
1047
1051
  /**
@@ -1061,43 +1065,43 @@ export declare enum HomeLeftNavItem {
1061
1065
  /**
1062
1066
  * The *Search data* option in
1063
1067
  * the *Insights* left navigation panel.
1064
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1068
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1065
1069
  */
1066
1070
  SearchData = "search-data",
1067
1071
  /**
1068
1072
  * The *Home* menu option in
1069
1073
  * the *Insights* left navigation panel.
1070
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1074
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1071
1075
  */
1072
1076
  Home = "insights-home",
1073
1077
  /**
1074
1078
  * The *Liveboards* menu option in
1075
1079
  * the *Insights* left navigation panel.
1076
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1080
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1077
1081
  */
1078
1082
  Liveboards = "liveboards",
1079
1083
  /**
1080
1084
  * The *Answers* menu option in
1081
1085
  * the *Insights* left navigation panel.
1082
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1086
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1083
1087
  */
1084
1088
  Answers = "answers",
1085
1089
  /**
1086
1090
  * The *Monitor subscriptions* menu option in
1087
1091
  * the *Insights* left navigation panel.
1088
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1092
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1089
1093
  */
1090
1094
  MonitorSubscription = "monitor-alerts",
1091
1095
  /**
1092
1096
  * The *SpotIQ analysis* menu option in
1093
1097
  * the *Insights* left navigation panel.
1094
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1098
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
1095
1099
  */
1096
1100
  SpotIQAnalysis = "spotiq-analysis",
1097
1101
  /**
1098
1102
  * The *Liveboard schedules* menu option in
1099
1103
  * the *Insights* left navigation panel.
1100
- * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
1104
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
1101
1105
  */
1102
1106
  LiveboardSchedules = "liveboard-schedules",
1103
1107
  /**
@@ -1268,8 +1272,8 @@ export interface EmbedConfig {
1268
1272
  * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
1269
1273
  * open the SAML auth flow in a popup, instead of redirecting the browser in
1270
1274
  * place.
1275
+ * @deprecated This option is deprecated.
1271
1276
  * @default false
1272
- * @deprecated
1273
1277
  */
1274
1278
  noRedirect?: boolean;
1275
1279
  /**
@@ -1278,8 +1282,8 @@ export interface EmbedConfig {
1278
1282
  *
1279
1283
  * Need to use this with `authTriggerContainer`. Or manually trigger
1280
1284
  * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
1281
- * @default false
1282
1285
  * @version SDK: 1.18.0
1286
+ * @default false
1283
1287
  */
1284
1288
  inPopup?: boolean;
1285
1289
  /**
@@ -1288,7 +1292,7 @@ export interface EmbedConfig {
1288
1292
  * terminated.
1289
1293
  *
1290
1294
  * Eg: "/dashboard", "#/foo" [Do not include the host]
1291
- * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
1295
+ * @version SDK: 1.10.2 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
1292
1296
  */
1293
1297
  redirectPath?: string;
1294
1298
  /** @internal */
@@ -1361,7 +1365,7 @@ export interface EmbedConfig {
1361
1365
  detectCookieAccessSlow?: boolean;
1362
1366
  /**
1363
1367
  * Hide the `beta` alert warning message for SearchEmbed.
1364
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
1368
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
1365
1369
  */
1366
1370
  suppressSearchEmbedBetaWarning?: boolean;
1367
1371
  /**
@@ -1378,6 +1382,7 @@ export interface EmbedConfig {
1378
1382
  * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
1379
1383
  * button that the user can click to trigger the flow.
1380
1384
  * This attribute sets a containing element for that button.
1385
+ * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1381
1386
  * @example
1382
1387
  * ```js
1383
1388
  * init({
@@ -1386,7 +1391,6 @@ export interface EmbedConfig {
1386
1391
  * authTriggerContainer: '#auth-trigger-container'
1387
1392
  * })
1388
1393
  * ```
1389
- * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
1390
1394
  */
1391
1395
  authTriggerContainer?: string | HTMLElement;
1392
1396
  /**
@@ -1403,11 +1407,10 @@ export interface EmbedConfig {
1403
1407
  */
1404
1408
  authTriggerText?: string;
1405
1409
  /**
1406
- * Prevent users from accessing the full application or ThoughtSpot application pages
1407
- * access to the embedded application users
1408
- * outside of the iframe.
1409
- * @default true
1410
+ * Prevent embedded application users from accessing ThoughtSpot
1411
+ * application pages outside of the iframe.
1410
1412
  * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
1413
+ * @default true
1411
1414
  */
1412
1415
  blockNonEmbedFullAppAccess?: boolean;
1413
1416
  /**
@@ -1437,6 +1440,7 @@ export interface EmbedConfig {
1437
1440
  * other logs such as warnings, information alerts,
1438
1441
  * and debug messages in the console output.
1439
1442
  *
1443
+ * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
1440
1444
  * @default LogLevel.ERROR
1441
1445
  * @example
1442
1446
  * ```js
@@ -1445,7 +1449,6 @@ export interface EmbedConfig {
1445
1449
  * logLevel: LogLevel.SILENT
1446
1450
  * })
1447
1451
  * ```
1448
- * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
1449
1452
  */
1450
1453
  logLevel?: LogLevel;
1451
1454
  /**
@@ -1472,6 +1475,7 @@ export interface EmbedConfig {
1472
1475
  * This flag is used to disable the token verification in the SDK.
1473
1476
  * Enabling this flag will also disable the caching of the token.
1474
1477
  * @hidden
1478
+ * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
1475
1479
  * @example
1476
1480
  * ```js
1477
1481
  * init({
@@ -1479,12 +1483,11 @@ export interface EmbedConfig {
1479
1483
  * disableTokenVerification : true
1480
1484
  * })
1481
1485
  * ```
1482
- * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
1483
1486
  */
1484
1487
  disableTokenVerification?: boolean;
1485
1488
  /**
1486
1489
  * This flag is used to disable showing the login failure page in the embedded app.
1487
- * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
1490
+ * @version SDK: 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
1488
1491
  */
1489
1492
  disableLoginFailurePage?: boolean;
1490
1493
  /**
@@ -1494,6 +1497,7 @@ export interface EmbedConfig {
1494
1497
  * Warning: This option is for advanced use only and is used internally
1495
1498
  * to control embed behavior in non-regular ways. We do not publish the
1496
1499
  * list of supported keys and values associated with each.
1500
+ * @version SDK: 1.33.5 | ThoughtSpot: *
1497
1501
  * @example
1498
1502
  * ```js
1499
1503
  * const embed = new LiveboardEmbed('#embed', {
@@ -1504,7 +1508,6 @@ export interface EmbedConfig {
1504
1508
  * }
1505
1509
  * });
1506
1510
  * ```
1507
- * @version SDK: 1.33.5 | ThoughtSpot: *
1508
1511
  */
1509
1512
  additionalFlags?: {
1510
1513
  [key: string]: string | number | boolean;
@@ -1512,6 +1515,7 @@ export interface EmbedConfig {
1512
1515
  /**
1513
1516
  * This is an object (key/val) for customVariables being
1514
1517
  * used by the third party tool's script.
1518
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
1515
1519
  * @example
1516
1520
  * ```js
1517
1521
  * const embed = new LiveboardEmbed('#embed', {
@@ -1522,15 +1526,14 @@ export interface EmbedConfig {
1522
1526
  * }
1523
1527
  * });
1524
1528
  * ```
1525
- * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
1526
1529
  */
1527
1530
  customVariablesForThirdPartyTools?: Record<string, any>;
1528
1531
  disablePreauthCache?: boolean;
1529
1532
  /**
1530
1533
  * Disable fullscreen presentation mode functionality. When enabled, prevents entering
1531
1534
  * and exiting fullscreen mode for embedded visualizations during presentations.
1532
- * @default true (feature is disabled by default)
1533
1535
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1536
+ * @default true (feature is disabled by default)
1534
1537
  * @example
1535
1538
  * ```js
1536
1539
  * init({
@@ -1736,7 +1739,7 @@ export interface FrameParams {
1736
1739
  */
1737
1740
  loading?: "lazy" | "eager" | "auto";
1738
1741
  /**
1739
- * This parameters will be passed on the iframe
1742
+ * These parameters will be passed to the iframe
1740
1743
  * as is.
1741
1744
  */
1742
1745
  [key: string]: string | number | boolean | undefined;
@@ -1811,8 +1814,8 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1811
1814
  */
1812
1815
  disabledActionReason?: string;
1813
1816
  /**
1814
- * The list of actions to hide from the embedded.
1815
- * This actions will be hidden from the user.
1817
+ * The list of actions to hide from the embedded view.
1818
+ * These actions will be hidden from the user.
1816
1819
  * Use this to hide an action.
1817
1820
  *
1818
1821
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
@@ -1853,7 +1856,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1853
1856
  * The locale settings to apply to the embedded view.
1854
1857
  *
1855
1858
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1856
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
1859
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1857
1860
  * @example
1858
1861
  * ```js
1859
1862
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1868,12 +1871,13 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1868
1871
  * This is an object (key/val) of override flags which will be applied
1869
1872
  * to the internal embedded object. This can be used to add any
1870
1873
  * URL flag.
1871
- * If the same flags are passed in init, they will be overriden by the values here.
1874
+ * If the same flags are passed in init, they will be overridden by the values here.
1872
1875
  * Warning: This option is for advanced use only and is used internally
1873
1876
  * to control embed behavior in non-regular ways. We do not publish the
1874
1877
  * list of supported keys and values associated with each.
1875
1878
  *
1876
1879
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1880
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1877
1881
  * @example
1878
1882
  * ```js
1879
1883
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1885,7 +1889,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1885
1889
  * },
1886
1890
  * });
1887
1891
  * ```
1888
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
1889
1892
  */
1890
1893
  additionalFlags?: {
1891
1894
  [key: string]: string | number | boolean;
@@ -1928,6 +1931,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1928
1931
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
1929
1932
  *
1930
1933
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1934
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1931
1935
  * @example
1932
1936
  * ```js
1933
1937
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1937,7 +1941,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1937
1941
  * });
1938
1942
  * embed.showPreRender();
1939
1943
  * ```
1940
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
1941
1944
  */
1942
1945
  preRenderId?: string;
1943
1946
  /**
@@ -1947,7 +1950,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1947
1950
  * its dimensions based on changes to the size of the embedding element.
1948
1951
  * @type {boolean}
1949
1952
  * @default false
1950
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
1953
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
1951
1954
  * @example
1952
1955
  * ```js
1953
1956
  * // Disable tracking PreRender size in the configuration
@@ -1962,9 +1965,10 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1962
1965
  doNotTrackPreRenderSize?: boolean;
1963
1966
  /**
1964
1967
  * Enable the V2 shell. This can provide performance benefits
1965
- * due to a lighterweight shell.
1968
+ * due to a lighter-weight shell.
1966
1969
  *
1967
1970
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1971
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1968
1972
  * @example
1969
1973
  * ```js
1970
1974
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -1973,7 +1977,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1973
1977
  * enableV2Shell_experimental: true,
1974
1978
  * });
1975
1979
  * ```
1976
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
1977
1980
  */
1978
1981
  enableV2Shell_experimental?: boolean;
1979
1982
  /**
@@ -1992,6 +1995,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1992
1995
  * and disable redirection of links in a new tab.
1993
1996
  *
1994
1997
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
1998
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
1995
1999
  * @example
1996
2000
  * ```js
1997
2001
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2000,7 +2004,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2000
2004
  * disableRedirectionLinksInNewTab: true,
2001
2005
  * });
2002
2006
  * ```
2003
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
2004
2007
  */
2005
2008
  disableRedirectionLinksInNewTab?: boolean;
2006
2009
  /**
@@ -2011,6 +2014,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2011
2014
  * Per Org URL feature is enabled on your ThoughtSpot instance.
2012
2015
  *
2013
2016
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2017
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
2014
2018
  * @example
2015
2019
  * ```js
2016
2020
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2019,24 +2023,56 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2019
2023
  * overrideOrgId: 142536,
2020
2024
  * });
2021
2025
  * ```
2022
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
2023
2026
  */
2024
2027
  overrideOrgId?: number;
2025
2028
  /**
2026
- * Flag to override the *Open Link in New Tab* context menu option.
2029
+ * Flag to override the *Open Link in New Tab* context
2030
+ * menu option.
2027
2031
  *
2028
- * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2032
+ * For improved link override handling, use
2033
+ * {@link enableLinkOverridesV2} instead.
2034
+ *
2035
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2036
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2037
+ * `SpotterEmbed`, `SearchBarEmbed`
2029
2038
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2030
2039
  * @example
2031
2040
  * ```js
2032
- * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2033
- * const embed = new <EmbedComponent>('#tsEmbed', {
2041
+ * const embed = new LiveboardEmbed('#tsEmbed', {
2034
2042
  * ... // other embed view config
2035
- * linkOverride:false,
2043
+ * linkOverride: true,
2036
2044
  * })
2037
2045
  * ```
2038
2046
  */
2039
2047
  linkOverride?: boolean;
2048
+ /**
2049
+ * Enables the V2 link override mechanism with improved
2050
+ * handling. When enabled, navigation links within the
2051
+ * embedded ThoughtSpot app are intercepted and routed
2052
+ * through the SDK via the `EmbedEvent.DialogOpen`
2053
+ * event.
2054
+ *
2055
+ * The SDK automatically sends {@link linkOverride}
2056
+ * alongside this flag for backward compatibility with
2057
+ * older ThoughtSpot versions.
2058
+ *
2059
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`,
2060
+ * `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`,
2061
+ * `SpotterEmbed`, `SearchBarEmbed`
2062
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
2063
+ * @example
2064
+ * ```js
2065
+ * const embed = new LiveboardEmbed('#tsEmbed', {
2066
+ * ... // other embed view config
2067
+ * enableLinkOverridesV2: true,
2068
+ * });
2069
+ *
2070
+ * embed.on(EmbedEvent.DialogOpen, (payload) => {
2071
+ * console.log('Link clicked:', payload);
2072
+ * });
2073
+ * ```
2074
+ */
2075
+ enableLinkOverridesV2?: boolean;
2040
2076
  /**
2041
2077
  * The primary action to display on top of the viz for Liveboard and App Embed.
2042
2078
  * Use this to set the primary action.
@@ -2061,7 +2097,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
2061
2097
  insertInToSlide?: boolean;
2062
2098
  /**
2063
2099
  * Show alert messages and toast messages in the embed.
2064
- * Supported embed in all embed types.
2100
+ * Supported in all embed types.
2065
2101
  *
2066
2102
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2067
2103
  * @example
@@ -2345,7 +2381,7 @@ export interface HomePageConfig {
2345
2381
  * **Note**: This attribute is not supported in the classic (v1) homepage.
2346
2382
  *
2347
2383
  * Supported embed types: `AppEmbed`
2348
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2384
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2349
2385
  * @example
2350
2386
  * ```js
2351
2387
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
@@ -2366,6 +2402,7 @@ export interface HomePageConfig {
2366
2402
  * **Note**: This attribute is not supported in the classic (v1) homepage.
2367
2403
  *
2368
2404
  * Supported embed types: `AppEmbed`
2405
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2369
2406
  * @example
2370
2407
  * ```js
2371
2408
  * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
@@ -2376,7 +2413,6 @@ export interface HomePageConfig {
2376
2413
  * ... //other embed view configuration attributes
2377
2414
  * })
2378
2415
  * ```
2379
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2380
2416
  */
2381
2417
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
2382
2418
  }
@@ -2389,7 +2425,7 @@ export interface SearchLiveboardCommonViewConfig {
2389
2425
  * visualization, or Liveboard.
2390
2426
  *
2391
2427
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
2392
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2428
+ * @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2393
2429
  * @example
2394
2430
  * ```js
2395
2431
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2407,11 +2443,11 @@ export interface SearchLiveboardCommonViewConfig {
2407
2443
  */
2408
2444
  runtimeFilters?: RuntimeFilter[];
2409
2445
  /**
2410
- * The list of parameter override to apply to a search Answer,
2446
+ * The list of parameter overrides to apply to a search Answer,
2411
2447
  * visualization, or Liveboard.
2412
2448
  *
2413
2449
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
2414
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2450
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2415
2451
  * @example
2416
2452
  * ```js
2417
2453
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
@@ -2431,6 +2467,7 @@ export interface SearchLiveboardCommonViewConfig {
2431
2467
  * flag to set ContextMenu Trigger to either left or right click.
2432
2468
  *
2433
2469
  * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
2470
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2434
2471
  * @example
2435
2472
  * ```js
2436
2473
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
@@ -2439,7 +2476,6 @@ export interface SearchLiveboardCommonViewConfig {
2439
2476
  * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
2440
2477
  * })
2441
2478
  * ```
2442
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2443
2479
  */
2444
2480
  contextMenuTrigger?: ContextMenuTriggerOptions;
2445
2481
  /**
@@ -2462,7 +2498,7 @@ export interface SearchLiveboardCommonViewConfig {
2462
2498
  * when set to false, runtime parameters will be included in the URL
2463
2499
  * (default behavior before SDK 1.45.0).
2464
2500
  *
2465
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
2501
+ * Irrespective of this flag, runtime parameters (if passed) will be applied to the
2466
2502
  * embedded view.
2467
2503
  * @default true
2468
2504
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
@@ -2481,14 +2517,15 @@ export interface SearchLiveboardCommonViewConfig {
2481
2517
  * ... // other embed view config
2482
2518
  * collapseSearchBar: true,
2483
2519
  * });
2520
+ * ```
2484
2521
  */
2485
2522
  collapseSearchBar?: boolean;
2486
2523
  /**
2487
2524
  * Flag to control Data panel experience
2488
2525
  *
2489
2526
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2527
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
2490
2528
  * @default true
2491
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
2492
2529
  * @example
2493
2530
  * ```js
2494
2531
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -2521,6 +2558,7 @@ export interface SearchLiveboardCommonViewConfig {
2521
2558
  * the current time period in filter results.
2522
2559
  *
2523
2560
  * Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
2561
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
2524
2562
  * @example
2525
2563
  * ```js
2526
2564
  * const embed = new <EmbedComponent>('#tsEmbed', {
@@ -2528,7 +2566,6 @@ export interface SearchLiveboardCommonViewConfig {
2528
2566
  * isThisPeriodInDateFiltersEnabled: true,
2529
2567
  * })
2530
2568
  * ```
2531
- * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
2532
2569
  */
2533
2570
  isThisPeriodInDateFiltersEnabled?: boolean;
2534
2571
  }
@@ -2588,6 +2625,7 @@ export interface LiveboardAppEmbedViewConfig {
2588
2625
  * Boolean to control if Liveboard header is sticky or not.
2589
2626
  *
2590
2627
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2628
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2591
2629
  * @example
2592
2630
  * ```js
2593
2631
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2596,7 +2634,6 @@ export interface LiveboardAppEmbedViewConfig {
2596
2634
  * isLiveboardHeaderSticky: true,
2597
2635
  * });
2598
2636
  * ```
2599
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
2600
2637
  */
2601
2638
  isLiveboardHeaderSticky?: boolean;
2602
2639
  /**
@@ -2604,8 +2641,8 @@ export interface LiveboardAppEmbedViewConfig {
2604
2641
  *
2605
2642
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2606
2643
  * @type {boolean}
2644
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl
2607
2645
  * @default false
2608
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
2609
2646
  * @example
2610
2647
  * ```js
2611
2648
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2621,8 +2658,8 @@ export interface LiveboardAppEmbedViewConfig {
2621
2658
  *
2622
2659
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2623
2660
  * @type {boolean}
2661
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.3.0.cl
2624
2662
  * @default false
2625
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
2626
2663
  * @example
2627
2664
  * ```js
2628
2665
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2638,7 +2675,7 @@ export interface LiveboardAppEmbedViewConfig {
2638
2675
  * header.
2639
2676
  *
2640
2677
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2641
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
2678
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2642
2679
  * @default true
2643
2680
  * @example
2644
2681
  * ```js
@@ -2656,7 +2693,7 @@ export interface LiveboardAppEmbedViewConfig {
2656
2693
  * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute.
2657
2694
  *
2658
2695
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2659
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
2696
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
2660
2697
  * @default false
2661
2698
  * @example
2662
2699
  * ```js
@@ -2674,7 +2711,7 @@ export interface LiveboardAppEmbedViewConfig {
2674
2711
  * compact header
2675
2712
  *
2676
2713
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2677
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
2714
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
2678
2715
  * @default true
2679
2716
  * @example
2680
2717
  * ```js
@@ -2707,7 +2744,7 @@ export interface LiveboardAppEmbedViewConfig {
2707
2744
  * the cover and filters pages in the Liveboard PDF.
2708
2745
  *
2709
2746
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2710
- * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
2747
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.8.0.cl
2711
2748
  * @example
2712
2749
  * ```js
2713
2750
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -2911,7 +2948,7 @@ export declare enum HomepageModule {
2911
2948
  */
2912
2949
  Search = "SEARCH",
2913
2950
  /**
2914
- * kPI watchlist module
2951
+ * KPI watchlist module
2915
2952
  */
2916
2953
  Watchlist = "WATCHLIST",
2917
2954
  /**
@@ -2942,7 +2979,8 @@ export declare enum ListPageColumns {
2942
2979
  */
2943
2980
  Favorites = "FAVOURITE",
2944
2981
  /**
2945
- * @deprecated Use {@link ListPageColumns.Favorites} instead.
2982
+ * Favourite Use {@link ListPageColumns.Favorites} instead.
2983
+ * @deprecated This option is deprecated.
2946
2984
  */
2947
2985
  Favourite = "FAVOURITE",
2948
2986
  /**
@@ -3043,13 +3081,13 @@ export declare enum EmbedEvent {
3043
3081
  /**
3044
3082
  * Rendering has initialized.
3045
3083
  * @example
3046
- *```js
3084
+ * ```js
3047
3085
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
3048
3086
  * //show a loader
3049
3087
  * function showLoader() {
3050
3088
  * document.getElementById("loader");
3051
3089
  * }
3052
- *```
3090
+ * ```
3053
3091
  * @returns timestamp - The timestamp when the event was generated.
3054
3092
  */
3055
3093
  Init = "init",
@@ -3057,11 +3095,11 @@ export declare enum EmbedEvent {
3057
3095
  * Authentication has either succeeded or failed.
3058
3096
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3059
3097
  * @example
3060
- *```js
3098
+ * ```js
3061
3099
  * appEmbed.on(EmbedEvent.AuthInit, payload => {
3062
3100
  * console.log('AuthInit', payload);
3063
3101
  * })
3064
- *```
3102
+ * ```
3065
3103
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
3066
3104
  */
3067
3105
  AuthInit = "authInit",
@@ -3070,13 +3108,13 @@ export declare enum EmbedEvent {
3070
3108
  * @returns timestamp - The timestamp when the event was generated.
3071
3109
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3072
3110
  * @example
3073
- *```js
3111
+ * ```js
3074
3112
  * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
3075
3113
  * //hide loader
3076
3114
  * function hideLoader() {
3077
3115
  * document.getElementById("loader");
3078
3116
  * }
3079
- *```
3117
+ * ```
3080
3118
  */
3081
3119
  Load = "load",
3082
3120
  /**
@@ -3085,11 +3123,11 @@ export declare enum EmbedEvent {
3085
3123
  * @return data - Answer of Liveboard data
3086
3124
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3087
3125
  * @example
3088
- *```js
3126
+ * ```js
3089
3127
  * liveboardEmbed.on(EmbedEvent.Data, payload => {
3090
3128
  * console.log('data', payload);
3091
3129
  * })
3092
- *```
3130
+ * ```
3093
3131
  * @important
3094
3132
  */
3095
3133
  Data = "data",
@@ -3097,9 +3135,9 @@ export declare enum EmbedEvent {
3097
3135
  * Search query has been updated by the user.
3098
3136
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
3099
3137
  * @example
3100
- *```js
3138
+ * ```js
3101
3139
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
3102
- *```
3140
+ * ```
3103
3141
  */
3104
3142
  QueryChanged = "queryChanged",
3105
3143
  /**
@@ -3109,7 +3147,7 @@ export declare enum EmbedEvent {
3109
3147
  * @returns drillDownColumns - The columns on which drill down was performed
3110
3148
  * @returns nonFilteredColumns - The columns that were not filtered
3111
3149
  * @example
3112
- *```js
3150
+ * ```js
3113
3151
  * searchEmbed.on(EmbedEvent.DrillDown, {
3114
3152
  * points: {
3115
3153
  * clickedPoint,
@@ -3117,12 +3155,12 @@ export declare enum EmbedEvent {
3117
3155
  * },
3118
3156
  * autoDrillDown: true,
3119
3157
  * })
3120
- *```
3158
+ * ```
3121
3159
  * In this example, `VizPointDoubleClick` event is used for
3122
3160
  * triggering the `DrillDown` event when an area or specific
3123
3161
  * data point on a table or chart is double-clicked.
3124
3162
  * @example
3125
- *```js
3163
+ * ```js
3126
3164
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
3127
3165
  * console.log(payload);
3128
3166
  * const clickedPoint = payload.data.clickedPoint;
@@ -3136,7 +3174,7 @@ export declare enum EmbedEvent {
3136
3174
  * autoDrillDown: true,
3137
3175
  * })
3138
3176
  * })
3139
- *```
3177
+ * ```
3140
3178
  */
3141
3179
  Drilldown = "drillDown",
3142
3180
  /**
@@ -3261,13 +3299,13 @@ export declare enum EmbedEvent {
3261
3299
  * The ThoughtSpot authentication session has expired.
3262
3300
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
3263
3301
  * @example
3264
- *```js
3302
+ * ```js
3265
3303
  * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
3266
3304
  * //show auth expired banner
3267
3305
  * function showAuthExpired() {
3268
3306
  * document.getElementById("authExpiredBanner");
3269
3307
  * }
3270
- *```
3308
+ * ```
3271
3309
  */
3272
3310
  AuthExpire = "ThoughtspotAuthExpired",
3273
3311
  /**
@@ -3302,22 +3340,22 @@ export declare enum EmbedEvent {
3302
3340
  * Applicable to `SearchBarEmbed` only.
3303
3341
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
3304
3342
  * @example
3305
- *```js
3343
+ * ```js
3306
3344
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
3307
3345
  * .then(data => {
3308
3346
  * console.log('Answer Data:', data);
3309
3347
  * })
3310
- *```
3348
+ * ```
3311
3349
  */
3312
3350
  GetDataClick = "getDataClick",
3313
3351
  /**
3314
3352
  * Detects the route change.
3315
3353
  * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
3316
3354
  * @example
3317
- *```js
3355
+ * ```js
3318
3356
  * searchEmbed.on(EmbedEvent.RouteChange, payload =>
3319
3357
  * console.log('data', payload))
3320
- *```
3358
+ * ```
3321
3359
  */
3322
3360
  RouteChange = "ROUTE_CHANGE",
3323
3361
  /**
@@ -3327,12 +3365,12 @@ export declare enum EmbedEvent {
3327
3365
  V1Data = "exportVizDataToParent",
3328
3366
  /**
3329
3367
  * Emitted when the embed does not have cookie access. This happens
3330
- * when Safari and other Web browsers block third-party cookies
3331
- * are blocked by default. `NoCookieAccess` can trigger.
3368
+ * when third-party cookies are blocked by Safari or other
3369
+ * web browsers. `NoCookieAccess` can trigger.
3332
3370
  * @example
3333
- *```js
3371
+ * ```js
3334
3372
  * appEmbed.on(EmbedEvent.NoCookieAccess)
3335
- *```
3373
+ * ```
3336
3374
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
3337
3375
  */
3338
3376
  NoCookieAccess = "noCookieAccess",
@@ -3346,22 +3384,22 @@ export declare enum EmbedEvent {
3346
3384
  * Emitted when any modal is opened in the app
3347
3385
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
3348
3386
  * @example
3349
- *```js
3387
+ * ```js
3350
3388
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
3351
3389
  * console.log('dialog open', payload);
3352
3390
  * })
3353
- *```
3391
+ * ```
3354
3392
  */
3355
3393
  DialogOpen = "dialog-open",
3356
3394
  /**
3357
3395
  * Emitted when any modal is closed in the app
3358
3396
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
3359
3397
  * @example
3360
- *```js
3398
+ * ```js
3361
3399
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
3362
3400
  * console.log('dialog close', payload);
3363
3401
  * })
3364
- *```
3402
+ * ```
3365
3403
  */
3366
3404
  DialogClose = "dialog-close",
3367
3405
  /**
@@ -3370,39 +3408,39 @@ export declare enum EmbedEvent {
3370
3408
  * other events on the rendered Liveboard.
3371
3409
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3372
3410
  * @example
3373
- *```js
3411
+ * ```js
3374
3412
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
3375
3413
  console.log('Liveboard is rendered', payload);
3376
3414
  })
3377
- *```
3415
+ * ```
3378
3416
  * The following example shows how to trigger
3379
3417
  * `SetVisibleVizs` event using LiveboardRendered embed event:
3380
3418
  * @example
3381
- *```js
3419
+ * ```js
3382
3420
  * const embedRef = useEmbedRef();
3383
3421
  * const onLiveboardRendered = () => {
3384
3422
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
3385
3423
  * };
3386
- *```
3424
+ * ```
3387
3425
  */
3388
3426
  LiveboardRendered = "PinboardRendered",
3389
3427
  /**
3390
3428
  * Emits all events.
3391
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
3429
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
3392
3430
  * @example
3393
- *```js
3431
+ * ```js
3394
3432
  * appEmbed.on(EmbedEvent.ALL, payload => {
3395
3433
  * console.log('Embed Events', payload)
3396
3434
  * })
3397
- *```
3435
+ * ```
3398
3436
  */
3399
3437
  ALL = "*",
3400
3438
  /**
3401
3439
  * Emitted when an Answer is saved in the app.
3402
3440
  * Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
3403
- * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3441
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3404
3442
  * @example
3405
- *```js
3443
+ * ```js
3406
3444
  * //Emit when action starts
3407
3445
  * searchEmbed.on(EmbedEvent.Save, payload => {
3408
3446
  * console.log('Save', payload)
@@ -3413,7 +3451,7 @@ export declare enum EmbedEvent {
3413
3451
  * searchEmbed.on(EmbedEvent.Save, payload => {
3414
3452
  * console.log('Save', payload)
3415
3453
  * })
3416
- *```
3454
+ * ```
3417
3455
  */
3418
3456
  Save = "save",
3419
3457
  /**
@@ -3425,11 +3463,11 @@ export declare enum EmbedEvent {
3425
3463
  * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
3426
3464
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3427
3465
  * @example
3428
- *```js
3466
+ * ```js
3429
3467
  * liveboardEmbed.on(EmbedEvent.Download, {
3430
3468
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
3431
3469
  * })
3432
- *```
3470
+ * ```
3433
3471
  */
3434
3472
  Download = "download",
3435
3473
  /**
@@ -3437,14 +3475,14 @@ export declare enum EmbedEvent {
3437
3475
  * Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
3438
3476
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
3439
3477
  * @example
3440
- *```js
3478
+ * ```js
3441
3479
  * //emit when action starts
3442
3480
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
3443
3481
  * console.log('download PNG', payload)}, {start: true })
3444
3482
  * //emit when action ends
3445
3483
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
3446
3484
  * console.log('download PNG', payload)})
3447
- *```
3485
+ * ```
3448
3486
  */
3449
3487
  DownloadAsPng = "downloadAsPng",
3450
3488
  /**
@@ -3452,14 +3490,14 @@ export declare enum EmbedEvent {
3452
3490
  * Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.
3453
3491
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3454
3492
  * @example
3455
- *```js
3493
+ * ```js
3456
3494
  * //emit when action starts
3457
3495
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
3458
3496
  * console.log('download PDF', payload)}, {start: true })
3459
3497
  * //emit when action ends
3460
3498
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
3461
3499
  * console.log('download PDF', payload)})
3462
- *```
3500
+ * ```
3463
3501
  */
3464
3502
  DownloadAsPdf = "downloadAsPdf",
3465
3503
  /**
@@ -3467,14 +3505,14 @@ export declare enum EmbedEvent {
3467
3505
  * Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.
3468
3506
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3469
3507
  * @example
3470
- *```js
3508
+ * ```js
3471
3509
  * //emit when action starts
3472
3510
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
3473
3511
  * console.log('download CSV', payload)}, {start: true })
3474
3512
  * //emit when action ends
3475
3513
  * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
3476
3514
  * console.log('download CSV', payload)})
3477
- *```
3515
+ * ```
3478
3516
  */
3479
3517
  DownloadAsCsv = "downloadAsCsv",
3480
3518
  /**
@@ -3482,14 +3520,14 @@ export declare enum EmbedEvent {
3482
3520
  * Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.
3483
3521
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3484
3522
  * @example
3485
- *```js
3523
+ * ```js
3486
3524
  * //emit when action starts
3487
3525
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
3488
3526
  * console.log('download Xlsx', payload)}, { start: true })
3489
3527
  * //emit when action ends
3490
3528
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
3491
3529
  * console.log('download Xlsx', payload)})
3492
- *```
3530
+ * ```
3493
3531
  */
3494
3532
  DownloadAsXlsx = "downloadAsXlsx",
3495
3533
  /**
@@ -3497,25 +3535,25 @@ export declare enum EmbedEvent {
3497
3535
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
3498
3536
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3499
3537
  * @example
3500
- *```js
3538
+ * ```js
3501
3539
  * //emit when action starts
3502
3540
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3503
3541
  * console.log('delete answer', payload)}, {start: true })
3504
3542
  * //trigger when action is completed
3505
3543
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3506
3544
  * console.log('delete answer', payload)})
3507
- *```
3545
+ * ```
3508
3546
  */
3509
3547
  AnswerDelete = "answerDelete",
3510
3548
  /**
3511
3549
  * Emitted when the AI Highlights action is triggered on a Liveboard
3512
3550
  * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
3513
3551
  * @example
3514
- *```js
3552
+ * ```js
3515
3553
  * liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
3516
3554
  * console.log('AI Highlights', payload);
3517
3555
  * })
3518
- *```
3556
+ * ```
3519
3557
  */
3520
3558
  AIHighlights = "AIHighlights",
3521
3559
  /**
@@ -3524,7 +3562,7 @@ export declare enum EmbedEvent {
3524
3562
  * Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
3525
3563
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3526
3564
  * @example
3527
- *```js
3565
+ * ```js
3528
3566
  * //emit when action starts
3529
3567
  * searchEmbed.on(EmbedEvent.Pin, payload => {
3530
3568
  * console.log('pin', payload)
@@ -3535,14 +3573,14 @@ export declare enum EmbedEvent {
3535
3573
  * searchEmbed.on(EmbedEvent.Pin, payload => {
3536
3574
  * console.log('pin', payload)
3537
3575
  * })
3538
- *```
3576
+ * ```
3539
3577
  */
3540
3578
  Pin = "pin",
3541
3579
  /**
3542
3580
  * Emitted when SpotIQ analysis is triggered
3543
3581
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3544
3582
  * @example
3545
- *```js
3583
+ * ```js
3546
3584
  * //emit when action starts
3547
3585
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
3548
3586
  * console.log('SpotIQAnalyze', payload)
@@ -3553,14 +3591,14 @@ export declare enum EmbedEvent {
3553
3591
  * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
3554
3592
  * console.log('SpotIQ analyze', payload)
3555
3593
  * })
3556
- *```
3594
+ * ```
3557
3595
  */
3558
3596
  SpotIQAnalyze = "spotIQAnalyze",
3559
3597
  /**
3560
3598
  * Emitted when a user shares an object with another user or group
3561
3599
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3562
3600
  * @example
3563
- *```js
3601
+ * ```js
3564
3602
  * //emit when action starts
3565
3603
  * searchEmbed.on(EmbedEvent.Share, payload => {
3566
3604
  * console.log('Share', payload)
@@ -3571,7 +3609,7 @@ export declare enum EmbedEvent {
3571
3609
  * searchEmbed.on(EmbedEvent.Share, payload => {
3572
3610
  * console.log('Share', payload)
3573
3611
  * })
3574
- *```
3612
+ * ```
3575
3613
  */
3576
3614
  Share = "share",
3577
3615
  /**
@@ -3579,11 +3617,11 @@ export declare enum EmbedEvent {
3579
3617
  * data on a chart or table.
3580
3618
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3581
3619
  * @example
3582
- *```js
3620
+ * ```js
3583
3621
  * appEmbed.on(EmbedEvent.DrillInclude, payload => {
3584
3622
  * console.log('Drill include', payload);
3585
3623
  * })
3586
- *```
3624
+ * ```
3587
3625
  */
3588
3626
  DrillInclude = "context-menu-item-include",
3589
3627
  /**
@@ -3591,22 +3629,22 @@ export declare enum EmbedEvent {
3591
3629
  * data on a chart or table
3592
3630
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3593
3631
  * @example
3594
- *```js
3632
+ * ```js
3595
3633
  * appEmbed.on(EmbedEvent.DrillExclude, payload => {
3596
3634
  * console.log('Drill exclude', payload);
3597
3635
  * })
3598
- *```
3636
+ * ```
3599
3637
  */
3600
3638
  DrillExclude = "context-menu-item-exclude",
3601
3639
  /**
3602
3640
  * Emitted when a column value is copied in the embedded app.
3603
3641
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3604
3642
  * @example
3605
- *```js
3606
- * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
3643
+ * ```js
3644
+ * searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
3607
3645
  * console.log('copy to clipboard', payload);
3608
3646
  * })
3609
- *```
3647
+ * ```
3610
3648
  */
3611
3649
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
3612
3650
  /**
@@ -3614,10 +3652,10 @@ export declare enum EmbedEvent {
3614
3652
  * embedded Liveboard.
3615
3653
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3616
3654
  * @example
3617
- *```js
3655
+ * ```js
3618
3656
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
3619
3657
  * })
3620
- *```
3658
+ * ```
3621
3659
  */
3622
3660
  UpdateTML = "updateTSL",
3623
3661
  /**
@@ -3625,11 +3663,11 @@ export declare enum EmbedEvent {
3625
3663
  * on an embedded Liveboard.
3626
3664
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3627
3665
  * @example
3628
- *```js
3666
+ * ```js
3629
3667
  * appEmbed.on(EmbedEvent.EditTML, payload => {
3630
3668
  * console.log('Edit TML', payload);
3631
3669
  * })
3632
- *```
3670
+ * ```
3633
3671
  */
3634
3672
  EditTML = "editTSL",
3635
3673
  /**
@@ -3638,25 +3676,25 @@ export declare enum EmbedEvent {
3638
3676
  * Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
3639
3677
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3640
3678
  * @example
3641
- *```js
3679
+ * ```js
3642
3680
  * //emit when action starts
3643
3681
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
3644
3682
  * console.log('Export TML', payload)}, { start: true })
3645
3683
  * //emit when action ends
3646
3684
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
3647
3685
  * console.log('Export TML', payload)})
3648
- *```
3686
+ * ```
3649
3687
  */
3650
3688
  ExportTML = "exportTSL",
3651
3689
  /**
3652
3690
  * Emitted when an Answer is saved as a View.
3653
3691
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3654
3692
  * @example
3655
- *```js
3693
+ * ```js
3656
3694
  * appEmbed.on(EmbedEvent.SaveAsView, payload => {
3657
3695
  * console.log('View', payload);
3658
3696
  * })
3659
- *```
3697
+ * ```
3660
3698
  */
3661
3699
  SaveAsView = "saveAsView",
3662
3700
  /**
@@ -3664,36 +3702,36 @@ export declare enum EmbedEvent {
3664
3702
  * Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.
3665
3703
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3666
3704
  * @example
3667
- *```js
3705
+ * ```js
3668
3706
  * //emit when action starts
3669
3707
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
3670
3708
  * console.log('Copy and edit', payload)}, {start: true })
3671
3709
  * //emit when action ends
3672
3710
  * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
3673
3711
  * console.log('Copy and edit', payload)})
3674
- *```
3712
+ * ```
3675
3713
  */
3676
3714
  CopyAEdit = "copyAEdit",
3677
3715
  /**
3678
3716
  * Emitted when a user clicks *Show underlying data* on an Answer.
3679
3717
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3680
3718
  * @example
3681
- *```js
3719
+ * ```js
3682
3720
  * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
3683
3721
  * console.log('show data', payload);
3684
3722
  * })
3685
- *```
3723
+ * ```
3686
3724
  */
3687
3725
  ShowUnderlyingData = "showUnderlyingData",
3688
3726
  /**
3689
3727
  * Emitted when an Answer is switched to a chart or table view.
3690
3728
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3691
3729
  * @example
3692
- *```js
3730
+ * ```js
3693
3731
  * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
3694
3732
  * console.log('switch view', payload);
3695
3733
  * })
3696
- *```
3734
+ * ```
3697
3735
  */
3698
3736
  AnswerChartSwitcher = "answerChartSwitcher",
3699
3737
  /**
@@ -3710,118 +3748,118 @@ export declare enum EmbedEvent {
3710
3748
  * Emitted when a user clicks **Show Liveboard details** on a Liveboard
3711
3749
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3712
3750
  * @example
3713
- *```js
3751
+ * ```js
3714
3752
  * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
3715
3753
  * console.log('Liveboard details', payload);
3716
3754
  * })
3717
- *```
3755
+ * ```
3718
3756
  */
3719
3757
  LiveboardInfo = "pinboardInfo",
3720
3758
  /**
3721
3759
  * Emitted when a user clicks on the Favorite icon on a Liveboard
3722
3760
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3723
3761
  * @example
3724
- *```js
3762
+ * ```js
3725
3763
  * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
3726
3764
  * console.log('favorites', payload);
3727
3765
  * })
3728
- *```
3766
+ * ```
3729
3767
  */
3730
3768
  AddToFavorites = "addToFavorites",
3731
3769
  /**
3732
3770
  * Emitted when a user clicks **Schedule** on a Liveboard
3733
3771
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3734
3772
  * @example
3735
- *```js
3773
+ * ```js
3736
3774
  * liveboardEmbed.on(EmbedEvent.Schedule, payload => {
3737
- * console.log(`Liveboard schedule', payload);
3775
+ * console.log('Liveboard schedule', payload);
3738
3776
  * })
3739
- *```
3777
+ * ```
3740
3778
  */
3741
3779
  Schedule = "subscription",
3742
3780
  /**
3743
3781
  * Emitted when a user clicks **Edit** on a Liveboard or visualization
3744
3782
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3745
3783
  * @example
3746
- *```js
3784
+ * ```js
3747
3785
  * liveboardEmbed.on(EmbedEvent.Edit, payload => {
3748
- * console.log(`Liveboard edit', payload);
3786
+ * console.log('Liveboard edit', payload);
3749
3787
  * })
3750
- *```
3788
+ * ```
3751
3789
  */
3752
3790
  Edit = "edit",
3753
3791
  /**
3754
3792
  * Emitted when a user clicks *Make a copy* on a Liveboard
3755
3793
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3756
3794
  * @example
3757
- *```js
3795
+ * ```js
3758
3796
  * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
3759
- * console.log(`Copy', payload);
3797
+ * console.log('Copy', payload);
3760
3798
  * })
3761
- *```
3799
+ * ```
3762
3800
  */
3763
3801
  MakeACopy = "makeACopy",
3764
3802
  /**
3765
3803
  * Emitted when a user clicks **Present** on a Liveboard or visualization
3766
3804
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3767
3805
  * @example
3768
- *```js
3806
+ * ```js
3769
3807
  * liveboardEmbed.on(EmbedEvent.Present)
3770
- *```
3808
+ * ```
3771
3809
  * @example
3772
- *```js
3810
+ * ```js
3773
3811
  * liveboardEmbed.on(EmbedEvent.Present, {
3774
3812
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3775
3813
  * })
3776
- *```
3814
+ * ```
3777
3815
  */
3778
3816
  Present = "present",
3779
3817
  /**
3780
3818
  * Emitted when a user clicks **Delete** on a visualization
3781
3819
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3782
3820
  * @example
3783
- *```js
3821
+ * ```js
3784
3822
  * liveboardEmbed.on(EmbedEvent.Delete,
3785
3823
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3786
- *```
3824
+ * ```
3787
3825
  */
3788
3826
  Delete = "delete",
3789
3827
  /**
3790
3828
  * Emitted when a user clicks Manage schedules on a Liveboard
3791
3829
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3792
3830
  * @example
3793
- *```js
3831
+ * ```js
3794
3832
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
3795
- *```
3833
+ * ```
3796
3834
  */
3797
3835
  SchedulesList = "schedule-list",
3798
3836
  /**
3799
3837
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
3800
3838
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3801
3839
  * @example
3802
- *```js
3840
+ * ```js
3803
3841
  * liveboardEmbed.on(EmbedEvent.Cancel)
3804
- *```
3842
+ * ```
3805
3843
  */
3806
3844
  Cancel = "cancel",
3807
3845
  /**
3808
3846
  * Emitted when a user clicks **Explore** on a visualization
3809
3847
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3810
3848
  * @example
3811
- *```js
3849
+ * ```js
3812
3850
  * liveboardEmbed.on(EmbedEvent.Explore, {
3813
3851
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3814
- *```
3852
+ * ```
3815
3853
  */
3816
3854
  Explore = "explore",
3817
3855
  /**
3818
3856
  * Emitted when a user clicks **Copy link** action on a visualization.
3819
3857
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3820
3858
  * @example
3821
- *```js
3859
+ * ```js
3822
3860
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
3823
3861
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3824
- *```
3862
+ * ```
3825
3863
  */
3826
3864
  CopyLink = "embedDocument",
3827
3865
  /**
@@ -3829,21 +3867,21 @@ export declare enum EmbedEvent {
3829
3867
  * visualization or Liveboard.
3830
3868
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3831
3869
  * @example
3832
- *```js
3870
+ * ```js
3833
3871
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
3834
3872
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3835
- *```
3873
+ * ```
3836
3874
  */
3837
3875
  CrossFilterChanged = "cross-filter-changed",
3838
3876
  /**
3839
3877
  * Emitted when a user right clicks on a visualization (chart or table)
3840
3878
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3841
3879
  * @example
3842
- *```js
3880
+ * ```js
3843
3881
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
3844
3882
  * console.log('VizPointClick', payload)
3845
3883
  * })
3846
- *```
3884
+ * ```
3847
3885
  */
3848
3886
  VizPointRightClick = "vizPointRightClick",
3849
3887
  /**
@@ -3857,35 +3895,35 @@ export declare enum EmbedEvent {
3857
3895
  * filter details.
3858
3896
  * @example
3859
3897
  *
3860
- *```js
3898
+ * ```js
3861
3899
  * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3862
3900
  * console.log('payload', payload);
3863
3901
  * })
3864
- *
3902
+ * ```
3865
3903
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3866
3904
  */
3867
3905
  FilterChanged = "filterChanged",
3868
3906
  /**
3869
3907
  * Emitted when a user clicks the **Go** button to initiate
3870
3908
  * a Natural Language Search query
3871
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3909
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3872
3910
  */
3873
3911
  SageEmbedQuery = "sageEmbedQuery",
3874
3912
  /**
3875
3913
  * Emitted when a user selects a data source on the embedded
3876
3914
  * Natural Language Search interface.
3877
3915
  *
3878
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3916
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3879
3917
  */
3880
3918
  SageWorksheetUpdated = "sageWorksheetUpdated",
3881
3919
  /**
3882
3920
  * Emitted when a user updates a connection on the **Data** page
3883
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3921
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3884
3922
  */
3885
3923
  UpdateConnection = "updateConnection",
3886
3924
  /**
3887
3925
  * Emitted when a user updates a connection on the **Data** page
3888
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3926
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3889
3927
  */
3890
3928
  CreateConnection = "createConnection",
3891
3929
  /**
@@ -3895,7 +3933,7 @@ export declare enum EmbedEvent {
3895
3933
  * @returns viewId: string
3896
3934
  * @returns liveboardId: string
3897
3935
  * @returns isPublic: boolean
3898
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3936
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3899
3937
  */
3900
3938
  UpdatePersonalisedView = "updatePersonalisedView",
3901
3939
  /**
@@ -3904,7 +3942,7 @@ export declare enum EmbedEvent {
3904
3942
  * @returns viewId: string
3905
3943
  * @returns liveboardId: string
3906
3944
  * @returns isPublic: boolean
3907
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3945
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3908
3946
  */
3909
3947
  SavePersonalisedView = "savePersonalisedView",
3910
3948
  /**
@@ -3913,19 +3951,19 @@ export declare enum EmbedEvent {
3913
3951
  * @returns viewId: string
3914
3952
  * @returns liveboardId: string
3915
3953
  * @returns isPublic: boolean
3916
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3954
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3917
3955
  */
3918
3956
  ResetLiveboard = "resetLiveboard",
3919
3957
  /**
3920
3958
  * Emitted when a PersonalisedView is deleted.
3921
3959
  * @returns views: string[]
3922
3960
  * @returns liveboardId: string
3923
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3961
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3924
3962
  */
3925
3963
  DeletePersonalisedView = "deletePersonalisedView",
3926
3964
  /**
3927
3965
  * Emitted when a user creates a Worksheet.
3928
- * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3966
+ * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
3929
3967
  */
3930
3968
  CreateWorksheet = "createWorksheet",
3931
3969
  /**
@@ -3934,12 +3972,12 @@ export declare enum EmbedEvent {
3934
3972
  * @returns viewId: string
3935
3973
  * @returns liveboardId: string
3936
3974
  * @returns isPublic: boolean
3937
- * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3975
+ * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
3938
3976
  */
3939
3977
  AskSageInit = "AskSageInit",
3940
3978
  /**
3941
3979
  * Emitted when a Liveboard or visualization is renamed.
3942
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3980
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
3943
3981
  */
3944
3982
  Rename = "rename",
3945
3983
  /**
@@ -3962,7 +4000,7 @@ export declare enum EmbedEvent {
3962
4000
  * - `error` - Developers can customize the user-facing error message when `execute`
3963
4001
  * is `false` by using the `error` parameters in `responder`.
3964
4002
  * - `errorText` - The error message text shown to the user.
3965
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
4003
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
3966
4004
  * @example
3967
4005
  *
3968
4006
  * This example blocks search operation and returns a custom error message:
@@ -4014,8 +4052,8 @@ export declare enum EmbedEvent {
4014
4052
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
4015
4053
  * console.log('payload', payload);
4016
4054
  * })
4017
- *```
4018
- * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
4055
+ * ```
4056
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
4019
4057
  */
4020
4058
  ParameterChanged = "parameterChanged",
4021
4059
  /**
@@ -4070,24 +4108,24 @@ export declare enum EmbedEvent {
4070
4108
  * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
4071
4109
  * console.log('payload', payload);
4072
4110
  * })
4073
- *```
4074
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
4111
+ * ```
4112
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
4075
4113
  */
4076
4114
  CreateLiveboard = "createLiveboard",
4077
4115
  /**
4078
4116
  * Emitted when a user creates a Model.
4079
- * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
4117
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
4080
4118
  */
4081
4119
  CreateModel = "createModel",
4082
4120
  /**
4083
4121
  * @hidden
4084
4122
  * Emitted when a user exits present mode.
4085
- * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
4123
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4086
4124
  */
4087
4125
  ExitPresentMode = "exitPresentMode",
4088
4126
  /**
4089
4127
  * Emitted when a user requests the full height lazy load data.
4090
- * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
4128
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4091
4129
  * @hidden
4092
4130
  */
4093
4131
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
@@ -4098,7 +4136,7 @@ export declare enum EmbedEvent {
4098
4136
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
4099
4137
  * console.log('payload', payload);
4100
4138
  * })
4101
- *```
4139
+ * ```
4102
4140
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4103
4141
  */
4104
4142
  SpotterData = "SpotterData",
@@ -4109,7 +4147,7 @@ export declare enum EmbedEvent {
4109
4147
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
4110
4148
  * console.log('payload', payload);
4111
4149
  * })
4112
- *```
4150
+ * ```
4113
4151
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4114
4152
  */
4115
4153
  PreviewSpotterData = "PreviewSpotterData",
@@ -4120,7 +4158,7 @@ export declare enum EmbedEvent {
4120
4158
  * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
4121
4159
  * console.log('payload', payload);
4122
4160
  * })
4123
- *```
4161
+ * ```
4124
4162
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
4125
4163
  */
4126
4164
  AddToCoaching = "addToCoaching",
@@ -4142,7 +4180,7 @@ export declare enum EmbedEvent {
4142
4180
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
4143
4181
  * console.log('payload', payload);
4144
4182
  * })
4145
- *```
4183
+ * ```
4146
4184
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4147
4185
  */
4148
4186
  SpotterQueryTriggered = "SpotterQueryTriggered",
@@ -4153,7 +4191,7 @@ export declare enum EmbedEvent {
4153
4191
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
4154
4192
  * console.log('payload', payload);
4155
4193
  * })
4156
- *```
4194
+ * ```
4157
4195
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4158
4196
  */
4159
4197
  LastPromptEdited = "LastPromptEdited",
@@ -4164,18 +4202,18 @@ export declare enum EmbedEvent {
4164
4202
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
4165
4203
  * console.log('payload', payload);
4166
4204
  * })
4167
- *```
4205
+ * ```
4168
4206
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4169
4207
  */
4170
4208
  LastPromptDeleted = "LastPromptDeleted",
4171
4209
  /**
4172
- * Emitted when the coversation is reset in spotter embed.
4210
+ * Emitted when the conversation is reset in Spotter embed.
4173
4211
  * @example
4174
4212
  * ```js
4175
4213
  * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
4176
4214
  * console.log('payload', payload);
4177
4215
  * })
4178
- *```
4216
+ * ```
4179
4217
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4180
4218
  */
4181
4219
  ResetSpotterConversation = "ResetSpotterConversation",
@@ -4186,7 +4224,7 @@ export declare enum EmbedEvent {
4186
4224
  * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
4187
4225
  * console.log('payload', payload);
4188
4226
  * })
4189
- *```
4227
+ * ```
4190
4228
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4191
4229
  */
4192
4230
  SpotterInit = "spotterInit",
@@ -4197,7 +4235,7 @@ export declare enum EmbedEvent {
4197
4235
  * spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
4198
4236
  * console.log('payload', payload);
4199
4237
  * })
4200
- *```
4238
+ * ```
4201
4239
  * @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
4202
4240
  */
4203
4241
  SpotterLoadComplete = "spotterLoadComplete",
@@ -4551,7 +4589,7 @@ export declare enum HostEvent {
4551
4589
  * ```js
4552
4590
  * appEmbed.navigateToPage(-1)
4553
4591
  * ```
4554
- * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
4592
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
4555
4593
  */
4556
4594
  Navigate = "Navigate",
4557
4595
  /**
@@ -4684,9 +4722,9 @@ export declare enum HostEvent {
4684
4722
  * Trigger the **Show Liveboard details** action
4685
4723
  * on an embedded Liveboard.
4686
4724
  * @example
4687
- *```js
4725
+ * ```js
4688
4726
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
4689
- *```
4727
+ * ```
4690
4728
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4691
4729
  */
4692
4730
  LiveboardInfo = "pinboardInfo",
@@ -4814,7 +4852,7 @@ export declare enum HostEvent {
4814
4852
  * appEmbed.trigger(HostEvent.Remove)
4815
4853
  * ```
4816
4854
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4817
- * * @example
4855
+ * @example
4818
4856
  * ```js
4819
4857
  * liveboardEmbed.trigger(HostEvent.Remove)
4820
4858
  * ```
@@ -4905,7 +4943,7 @@ export declare enum HostEvent {
4905
4943
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4906
4944
  * ```
4907
4945
  * ```js
4908
- * vizEmbed.trigger((HostEvent.CopyLink)
4946
+ * vizEmbed.trigger(HostEvent.CopyLink)
4909
4947
  * ```
4910
4948
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4911
4949
  */
@@ -4922,7 +4960,7 @@ export declare enum HostEvent {
4922
4960
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4923
4961
  * ```
4924
4962
  * ```js
4925
- * vizEmbed.trigger((HostEvent.Present)
4963
+ * vizEmbed.trigger(HostEvent.Present)
4926
4964
  * ```
4927
4965
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4928
4966
  */
@@ -4937,23 +4975,22 @@ export declare enum HostEvent {
4937
4975
  * );
4938
4976
  * })
4939
4977
  * ```
4940
- * * @example
4978
+ * @example
4941
4979
  * ```js
4942
-
4943
- * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.
4944
- * let latestSpotterVizId = '';
4945
- * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4946
- * latestSpotterVizId = payload.data.id;
4947
- * });
4948
- *
4949
- * spotterEmbed.trigger(HostEvent.GetTML, {
4980
+ * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
4981
+ * let latestSpotterVizId = '';
4982
+ * spotterEmbed.on(EmbedEvent.Data, (payload) => {
4983
+ * latestSpotterVizId = payload.data.id;
4984
+ * });
4985
+ *
4986
+ * spotterEmbed.trigger(HostEvent.GetTML, {
4950
4987
  * vizId: latestSpotterVizId
4951
4988
  * }).then((tml) => {
4952
4989
  * console.log(
4953
4990
  * tml.answer.search_query // TML representation of the search query
4954
4991
  * );
4955
4992
  * })
4956
- * ```
4993
+ * ```
4957
4994
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4958
4995
  * @important
4959
4996
  */
@@ -5017,6 +5054,11 @@ export declare enum HostEvent {
5017
5054
  /**
5018
5055
  * Trigger the **Download** action on charts in
5019
5056
  * the embedded view.
5057
+ * Use {@link HostEvent.DownloadAsPng} instead.
5058
+ *
5059
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5060
+ *
5061
+ * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
5020
5062
  * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
5021
5063
  * @example
5022
5064
  * ```js
@@ -5035,9 +5077,6 @@ export declare enum HostEvent {
5035
5077
  *
5036
5078
  * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
5037
5079
  * ```
5038
- * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
5039
- * Use {@link DownloadAsPng}
5040
- * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5041
5080
  */
5042
5081
  Download = "downloadAsPng",
5043
5082
  /**
@@ -5475,8 +5514,8 @@ export declare enum HostEvent {
5475
5514
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
5476
5515
  * console.log('parameters', parameter);
5477
5516
  * });
5478
- *```
5479
- *```js
5517
+ * ```
5518
+ * ```js
5480
5519
  * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
5481
5520
  * let latestSpotterVizId = '';
5482
5521
  * spotterEmbed.on(EmbedEvent.Data, (payload) => {
@@ -5484,7 +5523,7 @@ export declare enum HostEvent {
5484
5523
  * });
5485
5524
  *
5486
5525
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
5487
- *```
5526
+ * ```
5488
5527
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5489
5528
  */
5490
5529
  GetParameters = "GetParameters",
@@ -5501,7 +5540,7 @@ export declare enum HostEvent {
5501
5540
  * Notify when info call is completed successfully
5502
5541
  * ```js
5503
5542
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
5504
- *```
5543
+ * ```
5505
5544
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5506
5545
  */
5507
5546
  InfoSuccess = "InfoSuccess",
@@ -5604,7 +5643,7 @@ export declare enum HostEvent {
5604
5643
  * ```js
5605
5644
  * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
5606
5645
  *
5607
- *```
5646
+ * ```
5608
5647
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5609
5648
  */
5610
5649
  AddToCoaching = "addToCoaching",
@@ -5646,7 +5685,7 @@ export declare enum HostEvent {
5646
5685
  * });
5647
5686
  *
5648
5687
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
5649
- *```
5688
+ * ```
5650
5689
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5651
5690
  */
5652
5691
  AnswerChartSwitcher = "answerChartSwitcher",
@@ -5656,7 +5695,7 @@ export declare enum HostEvent {
5656
5695
  * This is automatically triggered by the SDK when fullscreen mode is exited.
5657
5696
  * ```js
5658
5697
  * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
5659
- *```
5698
+ * ```
5660
5699
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5661
5700
  */
5662
5701
  ExitPresentMode = "exitPresentMode",
@@ -5889,14 +5928,14 @@ export declare enum Action {
5889
5928
  * ```js
5890
5929
  * disabledActions: [Action.CollapseDataPanel]
5891
5930
  * ```
5892
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5931
+ * @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
5893
5932
  */
5894
5933
  CollapseDataSources = "collapseDataSources",
5895
5934
  /**
5896
5935
  * The **Collapse data panel** icon on the Search page.
5897
5936
  * Collapses the data panel view.
5898
5937
  *
5899
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5938
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5900
5939
  *
5901
5940
  * @example
5902
5941
  * ```js
@@ -6343,13 +6382,12 @@ export declare enum Action {
6343
6382
  */
6344
6383
  CreateMonitor = "createMonitor",
6345
6384
  /**
6346
- * @deprecated
6347
- * Reports errors
6385
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
6386
+ * @deprecated This action is deprecated. It was used for reporting errors.
6348
6387
  * @example
6349
6388
  * ```js
6350
6389
  * disabledActions: [Action.ReportError]
6351
6390
  * ```
6352
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
6353
6391
  */
6354
6392
  ReportError = "reportError",
6355
6393
  /**
@@ -6359,7 +6397,7 @@ export declare enum Action {
6359
6397
  * ```js
6360
6398
  * disabledActions: [Action.SyncToSheets]
6361
6399
  * ```
6362
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6400
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6363
6401
  */
6364
6402
  SyncToSheets = "sync-to-sheets",
6365
6403
  /**
@@ -6370,7 +6408,7 @@ export declare enum Action {
6370
6408
  * ```js
6371
6409
  * disabledActions: [Action.SyncToOtherApps]
6372
6410
  * ```
6373
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6411
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6374
6412
  */
6375
6413
  SyncToOtherApps = "sync-to-other-apps",
6376
6414
  /**
@@ -6380,7 +6418,7 @@ export declare enum Action {
6380
6418
  * ```js
6381
6419
  * disabledActions: [Action.ManagePipelines]
6382
6420
  * ```
6383
- * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6421
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6384
6422
  */
6385
6423
  ManagePipelines = "manage-pipeline",
6386
6424
  /**
@@ -6692,7 +6730,7 @@ export declare enum Action {
6692
6730
  * ```js
6693
6731
  * disabledActions: [Action.PersonalisedViewsDropdown]
6694
6732
  * ```
6695
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6733
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6696
6734
  */
6697
6735
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
6698
6736
  /**
@@ -6702,7 +6740,7 @@ export declare enum Action {
6702
6740
  * ```js
6703
6741
  * disabledActions: [Action.LiveboardUsers]
6704
6742
  * ```
6705
- * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6743
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6706
6744
  */
6707
6745
  LiveboardUsers = "liveboardUsers",
6708
6746
  /**
@@ -6720,7 +6758,7 @@ export declare enum Action {
6720
6758
  * hiddenAction: [Action.TML] // hide all TML actions
6721
6759
  * disabledActions: [Action.TML] // to disable all TML actions
6722
6760
  * ```
6723
- * @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6761
+ * @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
6724
6762
  */
6725
6763
  TML = "tml",
6726
6764
  /**
@@ -6766,7 +6804,7 @@ export declare enum Action {
6766
6804
  * ```js
6767
6805
  * disabledActions: [Action.AddToWatchlist]
6768
6806
  * ```
6769
- * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6807
+ * @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
6770
6808
  */
6771
6809
  AddToWatchlist = "addToWatchlist",
6772
6810
  /**
@@ -6776,7 +6814,7 @@ export declare enum Action {
6776
6814
  * ```js
6777
6815
  * disabledActions: [Action.RemoveFromWatchlist]
6778
6816
  * ```
6779
- * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
6817
+ * @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
6780
6818
  */
6781
6819
  RemoveFromWatchlist = "removeFromWatchlist",
6782
6820
  /**
@@ -6787,7 +6825,7 @@ export declare enum Action {
6787
6825
  * ```js
6788
6826
  * disabledActions: [Action.OrganiseFavourites]
6789
6827
  * ```
6790
- * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
6828
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
6791
6829
  */
6792
6830
  OrganiseFavourites = "organiseFavourites",
6793
6831
  /**
@@ -6848,7 +6886,7 @@ export declare enum Action {
6848
6886
  * ```js
6849
6887
  * disabledActions: [Action.ManageTags]
6850
6888
  * ```
6851
- * @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6889
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6852
6890
  */
6853
6891
  ManageTags = "manageTags",
6854
6892
  /**
@@ -7600,14 +7638,14 @@ export type ApiInterceptFlags = {
7600
7638
  /**
7601
7639
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
7602
7640
  *
7603
- * Can be used for Serach and App Embed from SDK 1.29.0
7641
+ * Can be used for Search and App Embed from SDK 1.29.0
7604
7642
  *
7605
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7643
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7606
7644
  */
7607
7645
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
7608
7646
  /**
7609
7647
  * This allows to intercept the urls passed, once intercepted the api will only
7610
- * run based on the reponse from the responder of ApiIntercept event.
7648
+ * run based on the response from the responder of ApiIntercept event.
7611
7649
  *
7612
7650
  * @example
7613
7651
  * ```js
@@ -7618,7 +7656,7 @@ export type ApiInterceptFlags = {
7618
7656
  * })
7619
7657
  * ```
7620
7658
  *
7621
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7659
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7622
7660
  */
7623
7661
  interceptUrls?: (string | InterceptedApiType)[];
7624
7662
  /**
@@ -7635,7 +7673,7 @@ export type ApiInterceptFlags = {
7635
7673
  * })
7636
7674
  * ```
7637
7675
  *
7638
- * @version SDK : 1.43.0 | ThoughtSpot: 10.15.0.cl
7676
+ * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
7639
7677
  */
7640
7678
  interceptTimeout?: number;
7641
7679
  };
@@ -7765,20 +7803,45 @@ declare enum AuthFailureType {
7765
7803
  }
7766
7804
  declare enum AuthStatus {
7767
7805
  /**
7768
- * Emits when the SDK fails to authenticate
7806
+ * Emits when the SDK fails to authenticate.
7769
7807
  */
7770
7808
  FAILURE = "FAILURE",
7771
7809
  /**
7772
- * Emits when the SDK authenticates successfully
7810
+ * Emits when the SDK authentication step completes
7811
+ * successfully (e.g., token exchange, cookie set).
7812
+ * This fires before any iframe is rendered. Use
7813
+ * this to know that auth passed and it is safe to
7814
+ * proceed with rendering. The callback receives no
7815
+ * arguments.
7816
+ * @example
7817
+ * ```js
7818
+ * const authEE = init({ ... });
7819
+ * authEE.on(AuthStatus.SDK_SUCCESS, () => {
7820
+ * // Auth done, iframe not loaded yet
7821
+ * });
7822
+ * ```
7773
7823
  */
7774
7824
  SDK_SUCCESS = "SDK_SUCCESS",
7775
7825
  /**
7776
7826
  * @hidden
7777
- * Emits when iframe is loaded and session info is available
7827
+ * Emits when iframe is loaded and session
7828
+ * information is available.
7778
7829
  */
7779
7830
  SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS",
7780
7831
  /**
7781
- * Emits when the app sends an authentication success message
7832
+ * Emits when the ThoughtSpot app inside the
7833
+ * embedded iframe confirms its session is active.
7834
+ * This fires after the iframe loads and sends back an `AuthInit` event.
7835
+ * @param sessionInfo Information about the user session, with details like `userGUID`.
7836
+ * @see EmbedEvent.AuthInit
7837
+ * @example
7838
+ * ```js
7839
+ * const authEE = init({ ... });
7840
+ * authEE.on(AuthStatus.SUCCESS, (sessionInfo) => {
7841
+ * // App is loaded and authenticated
7842
+ * console.log(sessionInfo.userGUID);
7843
+ * });
7844
+ * ```
7782
7845
  */
7783
7846
  SUCCESS = "SUCCESS",
7784
7847
  /**
@@ -8010,9 +8073,9 @@ declare class TsEmbed {
8010
8073
  */
8011
8074
  private isPreRendered;
8012
8075
  /**
8013
- * Should we encode URL Query Params using base64 encoding which thoughtspot
8076
+ * Should we encode URL Query Params using base64 encoding which ThoughtSpot
8014
8077
  * will generate for embedding. This provides additional security to
8015
- * thoughtspot clusters against Cross site scripting attacks.
8078
+ * ThoughtSpot clusters against Cross site scripting attacks.
8016
8079
  * @default false
8017
8080
  */
8018
8081
  private shouldEncodeUrlQueryParams;
@@ -8378,7 +8441,7 @@ declare class TsEmbed {
8378
8441
  * Returns the answerService which can be used to make arbitrary graphql calls on top
8379
8442
  * session.
8380
8443
  * @param vizId [Optional] to get for a specific viz in case of a Liveboard.
8381
- * @version SDK: 1.25.0 / ThoughtSpot 9.10.0
8444
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
8382
8445
  */
8383
8446
  getAnswerService(vizId?: string): Promise<AnswerService>;
8384
8447
  /**
@@ -8465,7 +8528,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8465
8528
  * but can be expanded manually.
8466
8529
  *
8467
8530
  * Supported embed types: `SearchEmbed`
8468
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8531
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8469
8532
  * @example
8470
8533
  * ```js
8471
8534
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8480,7 +8543,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8480
8543
  * but can be expanded manually.
8481
8544
  *
8482
8545
  * Supported embed types: `SearchEmbed`
8483
- * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
8546
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
8484
8547
  * @example
8485
8548
  * ```js
8486
8549
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8494,7 +8557,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8494
8557
  * Show or hide the data sources panel.
8495
8558
  *
8496
8559
  * Supported embed types: `SearchEmbed`
8497
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8560
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8498
8561
  * @example
8499
8562
  * ```js
8500
8563
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8510,7 +8573,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8510
8573
  * using raw answer data.
8511
8574
  *
8512
8575
  * Supported embed types: `SearchEmbed`
8513
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8576
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
8514
8577
  * @example
8515
8578
  * ```js
8516
8579
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8539,7 +8602,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8539
8602
  * format for presenting search data.
8540
8603
  *
8541
8604
  * Supported embed types: `SearchEmbed`
8542
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8605
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8543
8606
  * @example
8544
8607
  * ```js
8545
8608
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8552,6 +8615,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8552
8615
  /**
8553
8616
  * The array of data source GUIDs to set on load.
8554
8617
  * Only a single data source is supported currently.
8618
+ * Use {@link dataSource} instead.
8555
8619
  * @deprecated Use `dataSource` instead.
8556
8620
  *
8557
8621
  * Supported embed types: `SearchEmbed`
@@ -8565,10 +8629,10 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8565
8629
  */
8566
8630
  dataSources?: string[];
8567
8631
  /**
8568
- * The array of data source GUIDs to set on load.
8632
+ * The data source GUID to set on load.
8569
8633
  *
8570
8634
  * Supported embed types: `SearchEmbed`
8571
- * @version: SDK: 1.19.0
8635
+ * @version SDK: 1.19.0
8572
8636
  * @example
8573
8637
  * ```js
8574
8638
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8580,9 +8644,9 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8580
8644
  dataSource?: string;
8581
8645
  /**
8582
8646
  * The initial search query to load the answer with.
8647
+ * Use {@link searchOptions} instead.
8583
8648
  * @deprecated
8584
8649
  *
8585
- * Use {@link searchOptions} instead.
8586
8650
  */
8587
8651
  searchQuery?: string;
8588
8652
  /**
@@ -8611,7 +8675,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8611
8675
  * If set to true, the search token string is not appended to the URL.
8612
8676
  *
8613
8677
  * Supported embed types: `SearchEmbed`
8614
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8678
+ * @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8615
8679
  * @example
8616
8680
  * ```js
8617
8681
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8628,7 +8692,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8628
8692
  * The GUID of a saved answer to load initially.
8629
8693
  *
8630
8694
  * Supported embed types: `SearchEmbed`
8631
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8695
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
8632
8696
  * @example
8633
8697
  * ```js
8634
8698
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -8657,14 +8721,14 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
8657
8721
  * Flag to set if last selected dataSource should be used
8658
8722
  *
8659
8723
  * Supported embed types: `SearchEmbed`
8660
- * @version: SDK: 1.24.0
8724
+ * @version SDK: 1.24.0
8661
8725
  */
8662
8726
  useLastSelectedSources?: boolean;
8663
8727
  /**
8664
8728
  * To set the initial state of the search bar in case of saved-answers.
8665
- * @default false
8666
8729
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
8667
8730
  * @deprecated Use {@link collapseSearchBar} instead
8731
+ * @default false
8668
8732
  */
8669
8733
  collapseSearchBarInitially?: boolean;
8670
8734
  /**
@@ -8748,8 +8812,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8748
8812
  * Only a single data source is supported currently.
8749
8813
  *
8750
8814
  * Supported embed types: `SearchBarEmbed`
8815
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
8751
8816
  * @deprecated Use `dataSource` instead
8752
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
8753
8817
  * @example
8754
8818
  * ```js
8755
8819
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8763,7 +8827,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8763
8827
  * Pass the ID of the source to be selected.
8764
8828
  *
8765
8829
  * Supported embed types: `SearchBarEmbed`
8766
- * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
8830
+ * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
8767
8831
  * @example
8768
8832
  * ```js
8769
8833
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8777,7 +8841,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8777
8841
  * Boolean to define if the last selected data source should be used
8778
8842
  *
8779
8843
  * Supported embed types: `SearchBarEmbed`
8780
- * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
8844
+ * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
8781
8845
  * @example
8782
8846
  * ```js
8783
8847
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8799,7 +8863,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8799
8863
  * the token string in the search bar.
8800
8864
  *
8801
8865
  * Supported embed types: `SearchBarEmbed`
8802
- * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
8866
+ * @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
8803
8867
  * @example
8804
8868
  * ```js
8805
8869
  * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -8817,10 +8881,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
8817
8881
  * If set to true, the search token string is not appended to the URL.
8818
8882
  *
8819
8883
  * Supported embed types: `SearchBarEmbed`
8820
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8884
+ * @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
8821
8885
  * @example
8822
8886
  * ```js
8823
- * const embed = new SearchEmbed('#tsEmbed', {
8887
+ * const embed = new SearchBarEmbed('#tsEmbed', {
8824
8888
  * searchOptions: {
8825
8889
  * searchTokenString: '[quantity purchased] [region]',
8826
8890
  * executeSearch: true,
@@ -8873,7 +8937,7 @@ interface SearchOptions$1 {
8873
8937
  /**
8874
8938
  * The configuration attributes for the embedded Natural language search view. Based on
8875
8939
  * GPT and LLM.
8876
- * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8940
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8877
8941
  *
8878
8942
  * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
8879
8943
  * @group Embed components
@@ -8927,14 +8991,14 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8927
8991
  hideAutocompleteSuggestions?: boolean;
8928
8992
  /**
8929
8993
  * Show or hide autocomplete suggestions for the search query string.
8994
+ * You can use {@link hideAutocompleteSuggestions} instead.
8930
8995
  * @deprecated
8931
8996
  * Currently, the object suggestions will not be shown for Natural Language Search.
8932
- * You can use {@link hideAutocompleteSuggestions} instead.
8933
8997
  */
8934
8998
  showObjectSuggestions?: boolean;
8935
8999
  /**
8936
9000
  * Show or hide sample questions.
8937
- * The sample questions are autogenerated based on the data Model.
9001
+ * The sample questions are autogenerated based on the data model
8938
9002
  * selected for the search operation.
8939
9003
  *
8940
9004
  * Supported embed types: `SageEmbed`
@@ -8964,6 +9028,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8964
9028
  * the token string in the search bar.
8965
9029
  *
8966
9030
  * Supported embed types: `SageEmbed`
9031
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8967
9032
  * @example
8968
9033
  * ```js
8969
9034
  * searchOptions: {
@@ -8971,7 +9036,6 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
8971
9036
  * executeSearch: true,
8972
9037
  * }
8973
9038
  * ```
8974
- * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
8975
9039
  */
8976
9040
  searchOptions?: SearchOptions$1;
8977
9041
  }
@@ -9011,81 +9075,81 @@ interface SearchOptions$2 {
9011
9075
  * Configuration for the Spotter sidebar.
9012
9076
  * Can be used in SpotterEmbed and AppEmbed.
9013
9077
  * @group Embed components
9014
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9078
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9015
9079
  */
9016
9080
  export interface SpotterSidebarViewConfig {
9017
9081
  /**
9018
9082
  * Controls the visibility of the past conversations sidebar.
9019
9083
  * @default false
9020
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9084
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9021
9085
  */
9022
9086
  enablePastConversationsSidebar?: boolean;
9023
9087
  /**
9024
9088
  * Custom title text for the sidebar header.
9025
9089
  * Defaults to translated "Spotter" text.
9026
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9090
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9027
9091
  */
9028
9092
  spotterSidebarTitle?: string;
9029
9093
  /**
9030
9094
  * Boolean to set the default expanded state of the sidebar.
9031
9095
  * @default false
9032
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9096
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9033
9097
  */
9034
9098
  spotterSidebarDefaultExpanded?: boolean;
9035
9099
  /**
9036
9100
  * Custom label text for the rename action in the conversation edit menu.
9037
9101
  * Defaults to translated "Rename" text.
9038
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9102
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9039
9103
  */
9040
9104
  spotterChatRenameLabel?: string;
9041
9105
  /**
9042
9106
  * Custom label text for the delete action in the conversation edit menu.
9043
9107
  * Defaults to translated "DELETE" text.
9044
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9108
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9045
9109
  */
9046
9110
  spotterChatDeleteLabel?: string;
9047
9111
  /**
9048
9112
  * Custom title text for the delete conversation confirmation modal.
9049
9113
  * Defaults to translated "Delete chat" text.
9050
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9114
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9051
9115
  */
9052
9116
  spotterDeleteConversationModalTitle?: string;
9053
9117
  /**
9054
9118
  * Custom message text for the past conversation banner alert.
9055
9119
  * Defaults to translated alert message.
9056
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9120
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9057
9121
  */
9058
9122
  spotterPastConversationAlertMessage?: string;
9059
9123
  /**
9060
9124
  * Custom URL for the documentation/best practices link.
9061
9125
  * Defaults to ThoughtSpot docs URL based on release version.
9062
9126
  * Note: URL must include the protocol (e.g., `https://www.example.com`).
9063
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9127
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9064
9128
  */
9065
9129
  spotterDocumentationUrl?: string;
9066
9130
  /**
9067
9131
  * Custom label text for the best practices button in the footer.
9068
9132
  * Defaults to translated "Best Practices" text.
9069
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9133
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9070
9134
  */
9071
9135
  spotterBestPracticesLabel?: string;
9072
9136
  /**
9073
9137
  * Number of conversations to fetch per batch when loading conversation history.
9074
9138
  * @default 30
9075
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9139
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9076
9140
  */
9077
9141
  spotterConversationsBatchSize?: number;
9078
9142
  /**
9079
9143
  * Custom title text for the "New Chat" button in the sidebar.
9080
9144
  * Defaults to translated "New Chat" text.
9081
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9145
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9082
9146
  */
9083
9147
  spotterNewChatButtonTitle?: string;
9084
9148
  }
9085
9149
  /**
9086
9150
  * Configuration for customizing Spotter chat UI branding.
9087
- * @group Embed components
9088
9151
  * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9152
+ * @group Embed components
9089
9153
  */
9090
9154
  export interface SpotterChatViewConfig {
9091
9155
  /**
@@ -9124,6 +9188,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9124
9188
  * but still display the selected data source.
9125
9189
  *
9126
9190
  * Supported embed types: `SpotterEmbed`
9191
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9127
9192
  * @example
9128
9193
  * ```js
9129
9194
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9131,13 +9196,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9131
9196
  * disableSourceSelection : true,
9132
9197
  * })
9133
9198
  * ```
9134
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9135
9199
  */
9136
9200
  disableSourceSelection?: boolean;
9137
9201
  /**
9138
9202
  * hideSourceSelection : Hide data source selection
9139
9203
  *
9140
9204
  * Supported embed types: `SpotterEmbed`
9205
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9141
9206
  * @example
9142
9207
  * ```js
9143
9208
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9145,15 +9210,14 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9145
9210
  * hideSourceSelection : true,
9146
9211
  * })
9147
9212
  * ```
9148
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9149
9213
  */
9150
9214
  hideSourceSelection?: boolean;
9151
9215
  /**
9152
9216
  * Flag to control Data panel experience
9153
9217
  *
9154
9218
  * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
9219
+ * @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
9155
9220
  * @default true
9156
- * @deprecated from SDK 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
9157
9221
  * @example
9158
9222
  * ```js
9159
9223
  * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
@@ -9170,6 +9234,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9170
9234
  * default is false.
9171
9235
  *
9172
9236
  * Supported embed types: `SpotterEmbed`
9237
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
9173
9238
  * @example
9174
9239
  * ```js
9175
9240
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9177,7 +9242,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9177
9242
  * showSpotterLimitations : true,
9178
9243
  * })
9179
9244
  * ```
9180
- * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
9181
9245
  */
9182
9246
  showSpotterLimitations?: boolean;
9183
9247
  /**
@@ -9185,6 +9249,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9185
9249
  * the initial screen of the conversation.
9186
9250
  *
9187
9251
  * Supported embed types: `SpotterEmbed`
9252
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9188
9253
  * @example
9189
9254
  * ```js
9190
9255
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9192,7 +9257,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9192
9257
  * hideSampleQuestions : true,
9193
9258
  * })
9194
9259
  * ```
9195
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9196
9260
  */
9197
9261
  hideSampleQuestions?: boolean;
9198
9262
  /**
@@ -9200,6 +9264,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9200
9264
  * visualization, or Liveboard.
9201
9265
  *
9202
9266
  * Supported embed types: `SpotterEmbed`
9267
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9203
9268
  * @example
9204
9269
  * ```js
9205
9270
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9213,7 +9278,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9213
9278
  * ],
9214
9279
  * })
9215
9280
  * ```
9216
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9217
9281
  */
9218
9282
  runtimeFilters?: RuntimeFilter[];
9219
9283
  /**
@@ -9224,14 +9288,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9224
9288
  * (default behavior before SDK 1.45.0).
9225
9289
  *
9226
9290
  * Supported embed types: `SpotterEmbed`
9227
- * @default true
9228
9291
  * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9292
+ * @default true
9229
9293
  */
9230
9294
  excludeRuntimeFiltersfromURL?: boolean;
9231
9295
  /**
9232
9296
  * The list of runtime parameters to apply to the conversation.
9233
9297
  *
9234
9298
  * Supported embed types: `SpotterEmbed`
9299
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9235
9300
  * @example
9236
9301
  * ```js
9237
9302
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9244,7 +9309,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9244
9309
  * ],
9245
9310
  * })
9246
9311
  * ```
9247
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9248
9312
  */
9249
9313
  runtimeParameters?: RuntimeParameter[];
9250
9314
  /**
@@ -9255,14 +9319,15 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9255
9319
  * the iframe URL instead (default behavior before SDK 1.45.0).
9256
9320
  *
9257
9321
  * Supported embed types: `SpotterEmbed`
9258
- * @default true
9259
9322
  * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9323
+ * @default true
9260
9324
  */
9261
9325
  excludeRuntimeParametersfromURL?: boolean;
9262
9326
  /**
9263
9327
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
9264
9328
  *
9265
9329
  * Supported embed types: `SpotterEmbed`
9330
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9266
9331
  * @default false
9267
9332
  * @example
9268
9333
  * ```js
@@ -9271,17 +9336,30 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9271
9336
  * updatedSpotterChatPrompt : true,
9272
9337
  * })
9273
9338
  * ```
9274
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9275
9339
  */
9276
9340
  updatedSpotterChatPrompt?: boolean;
9341
+ /**
9342
+ * Controls the visibility of the past conversations sidebar.
9343
+ *
9344
+ * Supported embed types: `SpotterEmbed`
9345
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9346
+ * @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9347
+ * Use `spotterSidebarConfig.enablePastConversationsSidebar`.
9348
+ * @default false
9349
+ */
9350
+ enablePastConversationsSidebar?: boolean;
9277
9351
  /**
9278
9352
  * Configuration for the Spotter sidebar UI customization.
9279
9353
  *
9280
9354
  * Supported embed types: `SpotterEmbed`, `AppEmbed`
9355
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9281
9356
  * @example
9282
9357
  * ```js
9283
9358
  * const embed = new SpotterEmbed('#tsEmbed', {
9284
- * ... //other embed view config
9359
+ * worksheetId: 'worksheet-id',
9360
+ * // Deprecated standalone flag (backward compatibility)
9361
+ * enablePastConversationsSidebar: false,
9362
+ * // Recommended config; this value takes precedence
9285
9363
  * spotterSidebarConfig: {
9286
9364
  * enablePastConversationsSidebar: true,
9287
9365
  * spotterSidebarTitle: 'My Conversations',
@@ -9289,7 +9367,6 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9289
9367
  * },
9290
9368
  * })
9291
9369
  * ```
9292
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9293
9370
  */
9294
9371
  spotterSidebarConfig?: SpotterSidebarViewConfig;
9295
9372
  /**
@@ -9297,6 +9374,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9297
9374
  * branding in tool response cards.
9298
9375
  *
9299
9376
  * Supported embed types: `SpotterEmbed`
9377
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9300
9378
  * @example
9301
9379
  * ```js
9302
9380
  * const embed = new SpotterEmbed('#tsEmbed', {
@@ -9307,14 +9385,13 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
9307
9385
  * },
9308
9386
  * })
9309
9387
  * ```
9310
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9311
9388
  */
9312
9389
  spotterChatConfig?: SpotterChatViewConfig;
9313
9390
  }
9314
9391
  /**
9315
9392
  * The configuration for the embedded spotterEmbed options.
9316
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
9317
9393
  * Use {@link SpotterEmbedViewConfig} instead
9394
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
9318
9395
  * @group Embed components
9319
9396
  */
9320
9397
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
@@ -9423,7 +9500,7 @@ declare enum ListPage {
9423
9500
  */
9424
9501
  export interface DiscoveryExperience {
9425
9502
  /**
9426
- * primaryNavbarVersion determines the version of the navigation version.
9503
+ * primaryNavbarVersion determines the version of the primary navigation bar.
9427
9504
  */
9428
9505
  primaryNavbarVersion?: PrimaryNavbarVersion;
9429
9506
  /**
@@ -9446,8 +9523,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9446
9523
  * This flag also controls the homepage left navigation bar.
9447
9524
  *
9448
9525
  * Supported embed types: `AppEmbed`
9449
- * @default true
9450
9526
  * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
9527
+ * @default true
9451
9528
  * @example
9452
9529
  * ```js
9453
9530
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9468,8 +9545,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9468
9545
  * **Note**: This attribute is not supported in the classic (V1) experience.
9469
9546
  *
9470
9547
  * Supported embed types: `AppEmbed`
9471
- * @default false
9472
9548
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
9549
+ * @default false
9473
9550
  * @example
9474
9551
  * ```js
9475
9552
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9486,8 +9563,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9486
9563
  * navigation bar is not hidden via `showPrimaryNavbar`.
9487
9564
  *
9488
9565
  * Supported embed types: `AppEmbed`
9489
- * @default false
9490
9566
  * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
9567
+ * @default false
9491
9568
  * @example
9492
9569
  * ```js
9493
9570
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9498,12 +9575,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9498
9575
  */
9499
9576
  disableProfileAndHelp?: boolean;
9500
9577
  /**
9501
- * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
9502
- * @default true
9503
9578
  * Whether the help menu in the top navigation bar should be served
9504
9579
  * from Pendo or ThoughtSpot's internal help items.
9505
9580
  *
9506
9581
  * Supported embed types: `AppEmbed`
9582
+ * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
9583
+ * @default true
9507
9584
  * @example
9508
9585
  * ```js
9509
9586
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9518,8 +9595,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9518
9595
  * the top navigation bar in the V3 navigation experience.
9519
9596
  *
9520
9597
  * Supported embed types: `AppEmbed`
9521
- * @default false
9522
9598
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9599
+ * @default false
9523
9600
  * @example
9524
9601
  * ```js
9525
9602
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9538,8 +9615,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9538
9615
  * in the classic (V1) experience.
9539
9616
  *
9540
9617
  * Supported embed types: `AppEmbed`
9541
- * @default true
9542
9618
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9619
+ * @default true
9543
9620
  * @example
9544
9621
  * ```js
9545
9622
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9557,8 +9634,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9557
9634
  * in the classic (V1) and V2 experience modes.
9558
9635
  *
9559
9636
  * Supported embed types: `AppEmbed`
9560
- * @default true
9561
9637
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9638
+ * @default true
9562
9639
  * @example
9563
9640
  * ```js
9564
9641
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9574,7 +9651,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9574
9651
  * In the V3 experience, it shows or hides application selection
9575
9652
  * icons on the left navigation panel.
9576
9653
  * By default, the application selection menu and icons are
9577
- * shown in the UI
9654
+ * shown in the UI.
9578
9655
  *
9579
9656
  * **Note**: This attribute is not supported in the classic (V1) experience.
9580
9657
  *
@@ -9614,7 +9691,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9614
9691
  * takes precedence. This is the path post the `#/` in the URL of the standalone
9615
9692
  * ThoughtSpot app. Use this to open the embedded view to a specific path.
9616
9693
  *
9617
- * For eg, if you want the component to open to a specific Liveboard
9694
+ * For example, if you want the component to open to a specific Liveboard
9618
9695
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
9619
9696
  *
9620
9697
  * Supported embed types: `AppEmbed`
@@ -9632,7 +9709,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9632
9709
  * The application page to set as the start page
9633
9710
  * in the embedded view.
9634
9711
  *
9635
- * Use this to open to particular page in the app. To open to a specific
9712
+ * Use this to open to a particular page in the app. To open to a specific
9636
9713
  * path within the app, use the `path` attribute which is more flexible.
9637
9714
  *
9638
9715
  * Supported embed types: `AppEmbed`
@@ -9712,8 +9789,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9712
9789
  * If set to true, the Search Assist feature is enabled.
9713
9790
  *
9714
9791
  * Supported embed types: `AppEmbed`
9715
- * @default true
9716
9792
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
9793
+ * @default true
9717
9794
  * @example
9718
9795
  * ```js
9719
9796
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9751,8 +9828,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9751
9828
  * For more information,
9752
9829
  * see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
9753
9830
  * Supported embed types: `AppEmbed`
9754
- * @default false
9755
9831
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
9832
+ * @default false
9756
9833
  * @example
9757
9834
  * ```js
9758
9835
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9767,8 +9844,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9767
9844
  * For more information, see
9768
9845
  * link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
9769
9846
  * Supported embed types: `AppEmbed`
9770
- * @default false
9771
9847
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9848
+ * @default false
9772
9849
  * @example
9773
9850
  * ```js
9774
9851
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9783,10 +9860,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9783
9860
  */
9784
9861
  discoveryExperience?: DiscoveryExperience;
9785
9862
  /**
9786
- * To set the initial state of the search bar in case of saved-answers.
9863
+ * To set the initial state of the search bar in case of saved-answers. Use {@link collapseSearchBar} instead.
9787
9864
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
9865
+ * @deprecated This flag is deprecated.
9788
9866
  * @default false
9789
- * @deprecated Use {@link collapseSearchBar} instead
9790
9867
  */
9791
9868
  collapseSearchBarInitially?: boolean;
9792
9869
  /**
@@ -9814,14 +9891,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9814
9891
  * Flag to use home page search bar mode
9815
9892
  *
9816
9893
  * Supported embed types: `AppEmbed`
9817
- * @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl
9894
+ * @version SDK: 1.33.0 | ThoughtSpot: 10.3.0.cl
9818
9895
  */
9819
9896
  homePageSearchBarMode?: HomePageSearchBarMode;
9820
9897
  /**
9821
9898
  * This flag is used to enable unified search experience for full app embed.
9822
9899
  *
9823
9900
  * Supported embed types: `AppEmbed`
9824
- * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
9901
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.5.0.cl
9825
9902
  * @default true
9826
9903
  * @example
9827
9904
  * ```js
@@ -9833,7 +9910,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9833
9910
  */
9834
9911
  isUnifiedSearchExperienceEnabled?: boolean;
9835
9912
  /**
9836
- * This flag is used to enable/disable the styling and grouping in a Liveboard
9913
+ * This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
9914
+ * @deprecated This flag is deprecated.
9837
9915
  *
9838
9916
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
9839
9917
  * @type {boolean}
@@ -9899,6 +9977,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9899
9977
  /**
9900
9978
  * This flag is used to enable the full height lazy load data.
9901
9979
  *
9980
+ * @type {boolean}
9981
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
9982
+ * @default false
9902
9983
  * @example
9903
9984
  * ```js
9904
9985
  * const embed = new AppEmbed('#embed-container', {
@@ -9907,39 +9988,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9907
9988
  * lazyLoadingForFullHeight: true,
9908
9989
  * })
9909
9990
  * ```
9910
- *
9911
- * @type {boolean}
9912
- * @default false
9913
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
9914
9991
  */
9915
9992
  lazyLoadingForFullHeight?: boolean;
9916
9993
  /**
9917
9994
  * The margin to be used for lazy loading.
9918
9995
  *
9919
9996
  * For example, if the margin is set to '10px',
9920
- * the visualization will be loaded 10px before the its top edge is visible in the
9997
+ * the visualization will be loaded 10px before its top edge is visible in the
9921
9998
  * viewport.
9922
9999
  *
9923
10000
  * The format is similar to CSS margin.
9924
10001
  *
10002
+ * @type {string}
10003
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
9925
10004
  * @example
9926
10005
  * ```js
9927
10006
  * const embed = new AppEmbed('#embed-container', {
9928
10007
  * // ...other options
9929
10008
  * fullHeight: true,
9930
10009
  * lazyLoadingForFullHeight: true,
9931
- * // Using 0px, the visualization will be only loaded when its visible in the viewport.
10010
+ * // Using 0px, the visualization will be only loaded when it's visible in the viewport.
9932
10011
  * lazyLoadingMargin: '0px',
9933
10012
  * })
9934
10013
  * ```
9935
- * @type {string}
9936
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
9937
10014
  */
9938
10015
  lazyLoadingMargin?: string;
9939
10016
  /**
9940
10017
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
9941
10018
  *
9942
10019
  * Supported embed types: `AppEmbed`
10020
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9943
10021
  * @default false
9944
10022
  * @example
9945
10023
  * ```js
@@ -9948,25 +10026,36 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9948
10026
  * updatedSpotterChatPrompt : true,
9949
10027
  * })
9950
10028
  * ```
9951
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9952
10029
  */
9953
10030
  updatedSpotterChatPrompt?: boolean;
10031
+ /**
10032
+ * Controls the visibility of the past conversations sidebar.
10033
+ *
10034
+ * Supported embed types: `AppEmbed`
10035
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
10036
+ * @deprecated from SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
10037
+ * Use `spotterSidebarConfig.enablePastConversationsSidebar`.
10038
+ * @default false
10039
+ */
10040
+ enablePastConversationsSidebar?: boolean;
9954
10041
  /**
9955
10042
  * Configuration for the Spotter sidebar UI customization.
9956
10043
  * Only applicable when navigating to Spotter within the app.
9957
10044
  *
9958
10045
  * Supported embed types: `AppEmbed`
10046
+ * @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
9959
10047
  * @example
9960
10048
  * ```js
9961
10049
  * const embed = new AppEmbed('#tsEmbed', {
9962
- * ... //other embed view config
10050
+ * // Deprecated standalone flag (backward compatibility)
10051
+ * enablePastConversationsSidebar: false,
10052
+ * // Recommended config; this value takes precedence
9963
10053
  * spotterSidebarConfig: {
9964
10054
  * enablePastConversationsSidebar: true,
9965
10055
  * spotterSidebarTitle: 'My Conversations',
9966
10056
  * },
9967
10057
  * })
9968
10058
  * ```
9969
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9970
10059
  */
9971
10060
  spotterSidebarConfig?: SpotterSidebarViewConfig;
9972
10061
  /**
@@ -9974,6 +10063,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9974
10063
  * branding in tool response cards.
9975
10064
  *
9976
10065
  * Supported embed types: `AppEmbed`
10066
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9977
10067
  * @example
9978
10068
  * ```js
9979
10069
  * const embed = new AppEmbed('#tsEmbed', {
@@ -9984,7 +10074,6 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9984
10074
  * },
9985
10075
  * })
9986
10076
  * ```
9987
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9988
10077
  */
9989
10078
  spotterChatConfig?: SpotterChatViewConfig;
9990
10079
  /**
@@ -10004,6 +10093,22 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10004
10093
  * ```
10005
10094
  */
10006
10095
  minimumHeight?: number;
10096
+ /**
10097
+ * To enable the homepage announcement banner.
10098
+ * Controls the visibility of the announcement section
10099
+ * on the homepage.
10100
+ *
10101
+ * Supported embed types: `AppEmbed`
10102
+ * @example
10103
+ * ```js
10104
+ * const embed = new AppEmbed('#tsEmbed', {
10105
+ * ... // other embed view config
10106
+ * enableHomepageAnnouncement: true,
10107
+ * })
10108
+ * ```
10109
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
10110
+ */
10111
+ enableHomepageAnnouncement?: boolean;
10007
10112
  }
10008
10113
  declare class AppEmbed extends V1Embed {
10009
10114
  protected viewConfig: AppViewConfig;
@@ -10090,9 +10195,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10090
10195
  * Setting `fullHeight` to `false` fetches visualizations
10091
10196
  * incrementally as users scroll the page to view the charts and tables.
10092
10197
  *
10093
- * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
10094
10198
  *
10095
10199
  * Supported embed types: `LiveboardEmbed`
10200
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
10096
10201
  * @example
10097
10202
  * ```js
10098
10203
  * const embed = new LiveboardEmbed('#embed', {
@@ -10103,14 +10208,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10103
10208
  */
10104
10209
  fullHeight?: boolean;
10105
10210
  /**
10106
- * This is the minimum height(in pixels) for a full-height Liveboard.
10211
+ * This is the minimum height (in pixels) for a full-height Liveboard.
10107
10212
  * Setting this height helps resolve issues with empty Liveboards and
10108
10213
  * other screens navigable from a Liveboard.
10109
10214
  *
10110
10215
  * Supported embed types: `LiveboardEmbed`
10111
10216
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
10112
- * @default 500
10113
10217
  * @deprecated Use `minimumHeight` instead.
10218
+ * @default 500
10114
10219
  * @example
10115
10220
  * ```js
10116
10221
  * const embed = new LiveboardEmbed('#embed', {
@@ -10139,7 +10244,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10139
10244
  */
10140
10245
  minimumHeight?: number;
10141
10246
  /**
10142
- * @Deprecated If set to true, the context menu in visualizations will be enabled.
10247
+ * If set to true, the context menu in visualizations will be enabled.
10248
+ * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
10249
+ * @deprecated this option is deprecated.
10143
10250
  * @example
10144
10251
  * ```js
10145
10252
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10147,7 +10254,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10147
10254
  * enableVizTransformations:true,
10148
10255
  * })
10149
10256
  * ```
10150
- * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
10151
10257
  */
10152
10258
  enableVizTransformations?: boolean;
10153
10259
  /**
@@ -10160,8 +10266,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10160
10266
  * ```js
10161
10267
  * const embed = new LiveboardEmbed('#tsEmbed', {
10162
10268
  * ... //other embed view config
10163
- * liveboardId:id of liveboard,
10269
+ * liveboardId:'id of liveboard',
10164
10270
  * })
10271
+ * ```
10165
10272
  */
10166
10273
  liveboardId?: string;
10167
10274
  /**
@@ -10214,6 +10321,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10214
10321
  * 'f547ec54-2a37-4516-a222-2b06719af726'
10215
10322
  * ]
10216
10323
  * })
10324
+ * ```
10217
10325
  */
10218
10326
  visibleVizs?: string[];
10219
10327
  /**
@@ -10241,6 +10349,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10241
10349
  * Specify the tab ID.
10242
10350
  *
10243
10351
  * Supported embed types: `LiveboardEmbed`
10352
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
10244
10353
  * @example
10245
10354
  * ```js
10246
10355
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10248,7 +10357,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10248
10357
  * activeTabId:'id-1234',
10249
10358
  * })
10250
10359
  * ```
10251
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
10252
10360
  */
10253
10361
  activeTabId?: string;
10254
10362
  /**
@@ -10257,6 +10365,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10257
10365
  * that includes specific filter selections.
10258
10366
  *
10259
10367
  * Supported embed types: `LiveboardEmbed`
10368
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10260
10369
  * @example
10261
10370
  * ```js
10262
10371
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10265,7 +10374,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10265
10374
  * activeTabId: 'tab-guid',
10266
10375
  * })
10267
10376
  * ```
10268
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10269
10377
  */
10270
10378
  personalizedViewId?: string;
10271
10379
  /**
@@ -10286,13 +10394,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10286
10394
  * Show a preview image of the visualization before the visualization loads.
10287
10395
  * Only works for visualizations embeds with a viz id.
10288
10396
  *
10289
- * Also, viz snashot should be enabled in the ThoughtSpot instance.
10397
+ * Also, viz snapshot should be enabled in the ThoughtSpot instance.
10290
10398
  * Contact ThoughtSpot support to enable this feature.
10291
10399
  *
10292
- * Since, this will show preview images, be careful that it may show
10400
+ * Since this will show preview images, be careful that it may show
10293
10401
  * undesired data to the user when using row level security.
10294
10402
  *
10295
10403
  * Supported embed types: `LiveboardEmbed`
10404
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
10296
10405
  * @example
10297
10406
  * ```js
10298
10407
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10302,7 +10411,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10302
10411
  * });
10303
10412
  * embed.render();
10304
10413
  * ```
10305
- * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
10306
10414
  */
10307
10415
  showPreviewLoader?: boolean;
10308
10416
  /**
@@ -10310,13 +10418,14 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10310
10418
  *
10311
10419
  * Supported embed types: `LiveboardEmbed`
10312
10420
  * @hidden
10313
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10421
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10314
10422
  * @example
10315
10423
  * ```js
10316
10424
  * const embed = new LiveboardEmbed('#tsEmbed', {
10317
10425
  * ... //other embed view config
10318
- * oAuthPollingInterval: value in milliseconds,
10426
+ * oAuthPollingInterval: 30000,
10319
10427
  * })
10428
+ * ```
10320
10429
  */
10321
10430
  oAuthPollingInterval?: number;
10322
10431
  /**
@@ -10324,35 +10433,38 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10324
10433
  *
10325
10434
  * Supported embed types: `LiveboardEmbed`
10326
10435
  * @hidden
10327
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10436
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10328
10437
  * @example
10329
10438
  * ```js
10330
10439
  * const embed = new LiveboardEmbed('#tsEmbed', {
10331
10440
  * ... //other embed view config
10332
10441
  * isForceRedirect: false,
10333
10442
  * })
10443
+ * ```
10334
10444
  */
10335
10445
  isForceRedirect?: boolean;
10336
10446
  /**
10337
10447
  * The source connection ID for authentication.
10338
- * @hidden
10339
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
10340
10448
  *
10341
10449
  * Supported embed types: `LiveboardEmbed`
10450
+ * @hidden
10451
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.6.0.cl
10342
10452
  * @example
10343
10453
  * ```js
10344
10454
  * const embed = new LiveboardEmbed('#tsEmbed', {
10345
10455
  * ... //other embed view config
10346
10456
  * dataSourceId: '',
10347
10457
  * })
10458
+ * ```
10348
10459
  */
10349
10460
  dataSourceId?: string;
10350
10461
  /**
10351
- * The list of tab IDs to hide from the embedded.
10352
- * This Tabs will be hidden from their respective LBs.
10353
- * Use this to hide an tabID.
10462
+ * The list of tab IDs to hide from the embedded Liveboard.
10463
+ * These tabs will be hidden from their respective Liveboards.
10464
+ * Use this to hide a tab ID.
10354
10465
  *
10355
10466
  * Supported embed types: `LiveboardEmbed`
10467
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
10356
10468
  * @example
10357
10469
  * ```js
10358
10470
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10363,7 +10475,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10363
10475
  * ]
10364
10476
  * });
10365
10477
  * ```
10366
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
10367
10478
  */
10368
10479
  hiddenTabs?: string[];
10369
10480
  /**
@@ -10387,7 +10498,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10387
10498
  */
10388
10499
  visibleTabs?: string[];
10389
10500
  /**
10390
- * This flag is used to enable/disable the styling and grouping in a Liveboard
10501
+ * This flag is used to enable/disable the styling and grouping in a Liveboard. Use {@link isLiveboardMasterpiecesEnabled} instead.
10502
+ * @deprecated This flag is deprecated.
10391
10503
  *
10392
10504
  * Supported embed types: `LiveboardEmbed`, `AppEmbed`
10393
10505
  * @type {boolean}
@@ -10453,6 +10565,9 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10453
10565
  /**
10454
10566
  * This flag is used to enable the full height lazy load data.
10455
10567
  *
10568
+ * @type {boolean}
10569
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
10570
+ * @default false
10456
10571
  * @example
10457
10572
  * ```js
10458
10573
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -10461,33 +10576,29 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10461
10576
  * lazyLoadingForFullHeight: true,
10462
10577
  * })
10463
10578
  * ```
10464
- *
10465
- * @type {boolean}
10466
- * @default false
10467
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
10468
10579
  */
10469
10580
  lazyLoadingForFullHeight?: boolean;
10470
10581
  /**
10471
10582
  * The margin to be used for lazy loading.
10472
10583
  *
10473
10584
  * For example, if the margin is set to '10px',
10474
- * the visualization will be loaded 10px before the its top edge is visible in the
10585
+ * the visualization will be loaded 10px before its top edge is visible in the
10475
10586
  * viewport.
10476
10587
  *
10477
10588
  * The format is similar to CSS margin.
10478
10589
  *
10590
+ * @type {string}
10591
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
10479
10592
  * @example
10480
10593
  * ```js
10481
10594
  * const embed = new LiveboardEmbed('#embed-container', {
10482
10595
  * // ...other options
10483
10596
  * fullHeight: true,
10484
10597
  * lazyLoadingForFullHeight: true,
10485
- * // Using 0px, the visualization will be only loaded when its visible in the viewport.
10598
+ * // Using 0px, the visualization will be only loaded when it's visible in the viewport.
10486
10599
  * lazyLoadingMargin: '0px',
10487
10600
  * })
10488
10601
  * ```
10489
- * @type {string}
10490
- * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl
10491
10602
  */
10492
10603
  lazyLoadingMargin?: string;
10493
10604
  /**
@@ -10495,6 +10606,8 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10495
10606
  * of the spotter underneath the chat input.
10496
10607
  * default is false.
10497
10608
  *
10609
+ * @type {boolean}
10610
+ * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
10498
10611
  * @example
10499
10612
  * ```js
10500
10613
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -10502,14 +10615,13 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10502
10615
  * showSpotterLimitations: true,
10503
10616
  * })
10504
10617
  * ```
10505
- * @type {boolean}
10506
- * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl
10507
10618
  */
10508
10619
  showSpotterLimitations?: boolean;
10509
10620
  /**
10510
10621
  * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
10511
10622
  *
10512
10623
  * Supported embed types: `LiveboardEmbed`
10624
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
10513
10625
  * @default false
10514
10626
  * @example
10515
10627
  * ```js
@@ -10518,7 +10630,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10518
10630
  * updatedSpotterChatPrompt : true,
10519
10631
  * })
10520
10632
  * ```
10521
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
10522
10633
  */
10523
10634
  updatedSpotterChatPrompt?: boolean;
10524
10635
  /**
@@ -10526,6 +10637,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10526
10637
  * branding in tool response cards.
10527
10638
  *
10528
10639
  * Supported embed types: `LiveboardEmbed`
10640
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10529
10641
  * @example
10530
10642
  * ```js
10531
10643
  * const embed = new LiveboardEmbed('#tsEmbed', {
@@ -10536,7 +10648,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
10536
10648
  * },
10537
10649
  * })
10538
10650
  * ```
10539
- * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10540
10651
  */
10541
10652
  spotterChatConfig?: SpotterChatViewConfig;
10542
10653
  }
@@ -10681,6 +10792,9 @@ export interface PreRenderProps {
10681
10792
  * PreRender id to be used for PreRendering the embed.
10682
10793
  * Use PreRender to render the embed in the background and then
10683
10794
  * show or hide the rendered embed using showPreRender or hidePreRender respectively.
10795
+ *
10796
+ * Use PreRendered react component for pre rendering embed components.
10797
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
10684
10798
  * @example
10685
10799
  * ```js
10686
10800
  * const embed = new LiveboardEmbed('#embed', {
@@ -10689,8 +10803,6 @@ export interface PreRenderProps {
10689
10803
  * });
10690
10804
  * embed.showPreRender();
10691
10805
  * ```
10692
- *
10693
- * Use PreRendered react component for pre rendering embed components.
10694
10806
  * @example
10695
10807
  * ```tsx
10696
10808
  * function LandingPageComponent() {
@@ -10701,7 +10813,6 @@ export interface PreRenderProps {
10701
10813
  * return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
10702
10814
  * }
10703
10815
  * ```
10704
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
10705
10816
  */
10706
10817
  preRenderId: string;
10707
10818
  }
@@ -10725,7 +10836,7 @@ export interface AppProps extends EmbedProps, AppViewConfig {
10725
10836
  * React component for Full app Embed.
10726
10837
  * @example
10727
10838
  * ```tsx
10728
- * function Search() {
10839
+ * function App() {
10729
10840
  * return <AppEmbed
10730
10841
  * showPrimaryNavbar={false}
10731
10842
  * pageId={Page.Liveboards}
@@ -10736,9 +10847,9 @@ export interface AppProps extends EmbedProps, AppViewConfig {
10736
10847
  */
10737
10848
  declare const AppEmbed$1: React$1.ForwardRefExoticComponent<AppProps & React$1.RefAttributes<AppEmbed>>;
10738
10849
  /**
10739
- * React component for PreRendered Liveboard embed.
10850
+ * React component for PreRendered App embed.
10740
10851
  *
10741
- * PreRenderedAppEmbed will preRender the SearchBarEmbed and will be hidden by
10852
+ * PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
10742
10853
  * default.
10743
10854
  *
10744
10855
  * AppEmbed with preRenderId passed will call showPreRender on the embed.
@@ -10780,7 +10891,7 @@ export declare const PinboardEmbed: React$1.ForwardRefExoticComponent<LiveboardP
10780
10891
  * LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
10781
10892
  *
10782
10893
  * If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
10783
- * tries to preRender the LiveboardEmbed, so it is recommended to use pass the
10894
+ * tries to preRender the LiveboardEmbed, so it is recommended to pass the
10784
10895
  * liveboardId to both the components.
10785
10896
  * @example
10786
10897
  * ```tsx
@@ -10811,7 +10922,7 @@ export interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
10811
10922
  */
10812
10923
  declare const SearchBarEmbed$1: React$1.ForwardRefExoticComponent<SearchBarEmbedProps & React$1.RefAttributes<SearchBarEmbed>>;
10813
10924
  /**
10814
- * React component for PreRendered Liveboard embed.
10925
+ * React component for PreRendered SearchBar embed.
10815
10926
  *
10816
10927
  * PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
10817
10928
  * default.
@@ -10845,9 +10956,9 @@ export interface SageEmbedProps extends EmbedProps, SageViewConfig {
10845
10956
  */
10846
10957
  declare const SageEmbed$1: React$1.ForwardRefExoticComponent<SageEmbedProps & React$1.RefAttributes<SageEmbed>>;
10847
10958
  /**
10848
- * React component for PreRendered Liveboard embed.
10959
+ * React component for PreRendered Sage embed.
10849
10960
  *
10850
- * PreRenderedSageEmbed will preRender the SearchBarEmbed and will be hidden by
10961
+ * PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
10851
10962
  * default.
10852
10963
  *
10853
10964
  * SageEmbed with preRenderId passed will call showPreRender on the embed.
@@ -10885,8 +10996,8 @@ export interface ConversationEmbedProps extends EmbedProps, ConversationViewConf
10885
10996
  declare const SpotterEmbed$1: React$1.ForwardRefExoticComponent<SpotterEmbedProps & React$1.RefAttributes<SpotterEmbed>>;
10886
10997
  /**
10887
10998
  * React component for LLM based conversation BI.
10888
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
10889
10999
  * Use {@link SpotterEmbed} instead
11000
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
10890
11001
  * @example
10891
11002
  * ```tsx
10892
11003
  * function Sage() {
@@ -10915,6 +11026,7 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
10915
11026
  * This component renders a single message response from your ThoughtSpot conversation,
10916
11027
  * showing charts, visualizations, or text responses based on the user's query.
10917
11028
  *
11029
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
10918
11030
  * @example
10919
11031
  * ```tsx
10920
11032
  * const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
@@ -10931,7 +11043,6 @@ declare const ConversationMessage$1: React$1.ForwardRefExoticComponent<Conversat
10931
11043
  * />
10932
11044
  * }
10933
11045
  * ```
10934
- * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
10935
11046
  */
10936
11047
  export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
10937
11048
  message: SpotterAgentMessageViewConfig;
@@ -10943,7 +11054,7 @@ export declare const SpotterMessage: React$1.ForwardRefExoticComponent<{
10943
11054
  * PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
10944
11055
  * default.
10945
11056
  *
10946
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
11057
+ * SpotterEmbed with preRenderId passed will call showPreRender on the embed.
10947
11058
  * @example
10948
11059
  * ```tsx
10949
11060
  * function LandingPageComponent() {
@@ -10976,6 +11087,7 @@ export type EmbedComponent = typeof SearchEmbed$1 | typeof AppEmbed$1 | typeof L
10976
11087
  export declare function useEmbedRef<T extends EmbedComponent>(): React$1.MutableRefObject<React$1.ComponentRef<T>>;
10977
11088
  /**
10978
11089
  *
11090
+ * @version SDK: 1.36.2 | ThoughtSpot: *
10979
11091
  * @param config - EmbedConfig
10980
11092
  * @returns AuthEventEmitter
10981
11093
  * @example
@@ -10985,7 +11097,6 @@ export declare function useEmbedRef<T extends EmbedComponent>(): React$1.Mutable
10985
11097
  * return <LiveboardEmbed ref={ref} liveboardId={<id>} />
10986
11098
  * }
10987
11099
  * ```
10988
- * @version SDK: 1.36.2 | ThoughtSpot: *
10989
11100
  */
10990
11101
  export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<AuthEventEmitter>;
10991
11102
  /**
@@ -10994,6 +11105,7 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
10994
11105
  * This hook provides a sendMessage function that allows you to send natural language
10995
11106
  * queries to your data and get back AI-generated responses with visualizations.
10996
11107
  *
11108
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
10997
11109
  * @param config - Configuration object containing worksheetId and other options
10998
11110
  * @returns Object with sendMessage function that returns conversation results
10999
11111
  * @example
@@ -11011,7 +11123,6 @@ export declare function useInit(config: EmbedConfig): React$1.MutableRefObject<A
11011
11123
  * }
11012
11124
  * };
11013
11125
  * ```
11014
- * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
11015
11126
  */
11016
11127
  export declare function useSpotterAgent(config: SpotterAgentEmbedViewConfig): {
11017
11128
  sendMessage: (query: string) => Promise<{