Docs update (#21)

Author: adityamittal3107

src/embed/base.ts

@@ -259,21 +259,22 @@ export const renderInQueue = (fn: (next?: (val?: any) => void) => Promise<any>):
 /**
  * Imports TML representation of the metadata objects into ThoughtSpot.
  * @param data
+ * @returns imports TML data into ThoughtSpot
  * @example
  * ```js
- *   executeTML({
- * //Array of metadata Tmls
-        metadata_tmls: [
-            "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
-            \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
-        ],
-        import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
-        create_new: false, // If selected, creates TML objects with new GUIDs.
-    }).then(result => {
-        console.log(result);
-    }).catch(error => {
-        console.error(error);
-    });
+ *  executeTML({
+ * //Array of metadata Tmls in string format
+ *      metadata_tmls: [
+ *          "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
+ *          \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
+ *      ],
+ *      import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
+ *      create_new: false, // If selected, creates TML objects with new GUIDs.
+ *  }).then(result => {
+ *      console.log(result);
+ *  }).catch(error => {
+ *      console.error(error);
+ *  });
  *```
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
  * @group Global methods
@@ -319,27 +320,28 @@ export const executeTML = async (data: executeTMLInput): Promise<any> => {
  * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
  * format.
  * @param data
+ * @returns exports TML data
  * @example
  * ```js
-  exportTML({
-    metadata: [
-      {
-        type: "LIVEBOARD", //Metadata Type
-        identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
-      }
-    ],
-    export_associated: false,//indicates whether to export associated metadata objects
-    export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
-                       //exporting a Liveboard and its associated objects, the API
-                       //returns the Liveboard TML data with the FQNs of the referenced
-                       //worksheet. If the exported TML data includes FQNs, you don't need
-                       //to manually add FQNs of the referenced objects during TML import.
-    edoc_format: "JSON" //It takes JSON or YAML value
-  }).then(result => {
-    console.log(result);
-  }).catch(error => {
-    console.error(error);
-  });
+ * exportTML({
+ *   metadata: [
+ *     {
+ *       type: "LIVEBOARD", //Metadata Type
+ *       identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
+ *     }
+ *   ],
+ *   export_associated: false,//indicates whether to export associated metadata objects
+ *   export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
+ *                      //exporting a Liveboard and its associated objects, the API
+ *                      //returns the Liveboard TML data with the FQNs of the referenced
+ *                      //worksheet. If the exported TML data includes FQNs, you don't need
+ *                      //to manually add FQNs of the referenced objects during TML import.
+ *   edoc_format: "JSON" //It takes JSON or YAML value
+ * }).then(result => {
+ *   console.log(result);
+ * }).catch(error => {
+ *   console.error(error);
+ * });
  * ```
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
  * @group Global methods

src/types.ts

@@ -2139,8 +2139,8 @@ export enum EmbedEvent {
      * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
      * for this embed event to get emitted.
      *
-     * Parameter: payload
-     * Parameter: responder
+     * @param: payload
+     * @param: responder
      * Contains elements that lets developers define whether ThoughtSpot
      * will run the search or not, and if not, which error message to provide.
      *
@@ -2152,6 +2152,7 @@ export enum EmbedEvent {
      *
      * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
      *
+     * @example
      *```js
      * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
      * (payload, responder) => {
@@ -2187,7 +2188,6 @@ export enum EmbedEvent {
      *  }})
      * })
      *```
-     *
      */
     OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
     /**