ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/controllers/metadata_controller.rb

@@ -0,0 +1,1074 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # MetadataController
+  class MetadataController < BaseController
+    # Convert worksheets to models <br/>  <span class="since-beta-tag">Version:
+    # 10.6.0.cl or later</span>
+    # ## Prerequisites
+    # - **Privileges Required:**
+    #   - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer
+    # ThoughtSpot).
+    # - **Additional Privileges (if RBAC is enabled):**
+    #   - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (Can manage data models).
+    # ---
+    # ## Usage Guidelines
+    # ### Parameters
+    # 1. **worksheet_ids**
+    #    - **Description:** A comma-separated list of GUIDs (Globally Unique
+    # Identifiers) specifying the Worksheets to be converted.
+    #    - **Usage:**
+    #      - Used only when `convert_all` is set to `false`.
+    #      - Leave empty or omit when `convert_all` is set to `true`.
+    # 2. **exclude_worksheet_ids**
+    #    - **Description:** A comma-separated list of GUIDs specifying
+    # Worksheets to be excluded from conversion.
+    #    - **Usage:**
+    #      - Useful when `convert_all` is set to `true` and specific Worksheets
+    # should not be converted.
+    # 3. **convert_all**
+    #    - **Description:** Sets the scope of conversion.
+    #    - **Options:**
+    #      - `true`: Converts all Worksheets in the system, except those
+    # specified in `exclude_worksheet_ids`.
+    #      - `false`: Converts only the Worksheets listed in `worksheet_ids`.
+    # 4. **apply_changes**
+    #    - **Description:** Specifies whether to apply changes directly to
+    # ThoughtSpot or to generate a preview before applying any changes.Used for
+    # validation of conversion.
+    #    - **Options:**
+    #      - `true`: Applies conversion changes directly to ThoughtSpot.
+    #      - `false`: Generates only a preview of the changes and does not apply
+    # any changes to ThoughtSpot
+    # ---
+    # ## Best Practices
+    # 1. **Backup Before Conversion:**
+    #    Always export metadata as a backup before initiating the conversion
+    # process
+    # 2. **Partial Conversion for Testing:**
+    #    Test the conversion process by setting `convert_all` to `false` and
+    # specifying a small number of `worksheet_ids`.
+    # 3. **Verify Dependencies:**
+    #    Check for dependent objects, such as Tables and Connections, to avoid
+    # invalid references.
+    # 4. **Review Changes:**
+    #    Use `apply_changes: false` to preview the impact of the conversion
+    # before applying changes.
+    # ---
+    # ## Examples
+    # ### Convert Specific Worksheets
+    # ```json
+    # {
+    #   "worksheet_ids": ["guid1", "guid2", "guid3"],
+    #   "exclude_worksheet_ids": [],
+    #   "convert_all": false,
+    #   "apply_changes": true
+    # }
+    # ```
+    # ### Convert All Accessible Worksheets
+    # ```json
+    # {
+    #   "worksheet_ids": [],
+    #   "exclude_worksheet_ids": [],
+    #   "convert_all": true,
+    #   "apply_changes": true
+    # }
+    # ```
+    # ### Exclude Specific Worksheets While Converting All Accessible Worksheets
+    # ```json
+    # {
+    #   "worksheet_ids": [],
+    #   "exclude_worksheet_ids": ["abc"],
+    #   "convert_all": true,
+    #   "apply_changes": true
+    # }
+    # ```
+    # #### Endpoint URL
+    # @param [ConvertWorksheetToModelRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def convert_worksheet_to_model(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/worksheets/convert',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseWorksheetToModelConversion.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Makes a copy of an Answer or Liveboard <br/>  <span
+    # class="since-beta-tag">Version: 10.3.0.cl or later</span>
+    # Creates a copy of a metadata object.
+    # Requires at least view access to the metadata object being copied.
+    # Upon successful execution, the API creates a copy of the metadata object
+    # specified in the API request and returns the ID of the new object.
+    # #### Endpoint URL
+    # @param [CopyObjectRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def copy_object(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/copyobject',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseCopyObject.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('404',
+                                 'Object not found',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Removes the specified metadata object from the ThoughtSpot system.
+    # Requires edit access to the metadata object.
+    # #### Endpoint URL
+    # @param [DeleteMetadataRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_metadata(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/delete',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Exports the [TML](https://docs.thoughtspot.com/cloud/latest/tml)
+    # representation of metadata objects in JSON or YAML format.
+    # Requires `DATADOWNLOADING` (**Can download Data**) and at least view
+    # access to the metadata object.
+    # #### Usage guidelines
+    # * You can export one or several objects by passing metadata object GUIDs
+    # in the `metadata` array.
+    # * When exporting TML content for a Liveboard or Answer object, you can set
+    # `export_associated` to `true` to retrieve TML content for underlying
+    # Worksheets, Tables, or Views, including the GUID of each object within the
+    # headers. When   `export_associated` is set to `true`, consider retrieving
+    # one metadata object at a time.
+    # * Set `export_fqns` to `true` to add FQNs of the referenced objects in the
+    # TML content. For example, if you send an API request to retrieve TML for a
+    # Liveboard and its associated objects, the API returns the TML content with
+    # FQNs of the referenced Worksheet. Exporting TML with FQNs is useful if
+    # ThoughtSpot has multiple objects with the same name and you want to
+    # eliminate ambiguity when importing TML files into ThoughtSpot. It
+    # eliminates the need for adding FQNs of the referenced objects manually
+    # during the import operation.
+    # * To export only the TML of feedbacks associated with an object, set the
+    # GUID of the object as `identifier`, and set the `type` as `FEEDBACK` in
+    # the `metadata` array.
+    # * To export the TML of an object along with the feedbacks associated with
+    # it, set the GUID of the object as `identifier`, set the `type` as
+    # `LOGIAL_TABLE` in the `metadata` array, and set
+    # `export_with_associated_feedbacks` in `export_options` to true.
+    # For more information, see [TML
+    # Documentation](https://developers.thoughtspot.com/docs/tml#_export_a_tml).
+    # For more information on feedbacks, see [Feedback
+    # Documentation](https://docs.thoughtspot.com/cloud/latest/sage-feedback).
+    # #### Endpoint URL
+    # @param [ExportMetadataTmlRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def export_metadata_tml(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/tml/export',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 10.1.0.cl or later</span>
+    # Exports the [TML](https://docs.thoughtspot.com/cloud/latest/tml)
+    # representation of metadata objects in JSON or YAML format.
+    # ### **Permissions Required**
+    # Requires `DATAMANAGEMENT` (**Can manage data**) and `USERMANAGEMENT`
+    # (**Can manage users**) privileges.
+    # #### **Usage Guidelines**
+    # This API is only applicable for `USER`, `GROUP`, and `ROLES` metadata
+    # types.
+    # - `batch_offset` Indicates the starting position within the complete
+    # dataset from which the API should begin returning objects. Useful for
+    # paginating results efficiently.
+    # - `batch_size` Specifies the number of objects or items to retrieve in a
+    # single request. Helps control response size for better performance.
+    # - `edoc_format` Defines the format of the TML content. The exported
+    # metadata can be in JSON or YAML format.
+    # - `export_dependent` Specifies whether to include dependent metadata
+    # objects in the export. Ensures related objects are also retrieved if
+    # needed.
+    # - `all_orgs_override` Indicates whether the export operation applies
+    # across all organizations. Useful for multi-tenant environments where
+    # cross-org exports are required.
+    # #### Endpoint URL
+    # @param [ExportMetadataTmlBatchedRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def export_metadata_tml_batched(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/tml/export/batch',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Fetches the underlying SQL query data for an Answer object.
+    # Requires at least view access to the Answer object.
+    # Upon successful execution, the API returns the SQL queries for the
+    # specified object as shown in this example:
+    # ```
+    # {
+    #    "metadata_id":"8fbe44a8-46ad-4b16-8d39-184b2fada490",
+    #    "metadata_name":"Total sales",
+    #    "metadata_type":"ANSWER",
+    #    "sql_queries":[
+    #       {
+    #          "metadata_id":"8fbe44a8-46ad-4b16-8d39-184b2fada490",
+    #          "metadata_name":"Total sales -test",
+    #          "sql_query":"SELECT \n  \"ta_1\".\"REGION\" \"ca_1\", \n
+    # \"ta_2\".\"PRODUCTNAME\" \"ca_2\", \n  \"ta_1\".\"STORENAME\" \"ca_3\", \n
+    #  CASE\n    WHEN sum(\"ta_3\".\"SALES\") IS NOT NULL THEN
+    # sum(\"ta_3\".\"SALES\")\n    ELSE 0\n  END \"ca_4\", \n  CASE\n    WHEN
+    # sum(\"ta_3\".\"QUANTITYPURCHASED\") IS NOT NULL THEN
+    # sum(\"ta_3\".\"QUANTITYPURCHASED\")\n    ELSE 0\n  END \"ca_5\"\nFROM
+    # \"RETAILAPPAREL\".\"PUBLIC\".\"FACT_RETAPP_SALES\" \"ta_3\"\n  JOIN
+    # \"RETAILAPPAREL\".\"PUBLIC\".\"DIM_RETAPP_STORES\" \"ta_1\"\n    ON
+    # \"ta_3\".\"STOREID\" = \"ta_1\".\"STOREID\"\n  JOIN
+    # \"RETAILAPPAREL\".\"PUBLIC\".\"DIM_RETAPP_PRODUCTS\" \"ta_2\"\n    ON
+    # \"ta_3\".\"PRODUCTID\" = \"ta_2\".\"PRODUCTID\"\nGROUP BY \n  \"ca_1\", \n
+    #  \"ca_2\", \n  \"ca_3\"\n"
+    #       }
+    #    ]
+    # }
+    # ```
+    # #### Endpoint URL
+    # @param [FetchAnswerSqlQueryRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_answer_sql_query(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/answer/sql',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SqlQueryResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 10.4.0.cl or later</span>
+    # Gets information about the status of the TML async import task scheduled
+    # using the `/api/rest/2.0/metadata/tml/async/import` API call.
+    # To fetch the task details, specify the ID of the TML async import task.
+    # Requires access to the task ID. The API allows users who initiated the
+    # asynchronous TML import via `/api/rest/2.0/metadata/tml/async/import` to
+    # view the status of their tasks.  Users with administration privilege can
+    # view the status of all import tasks initiated by the users in their Org.
+    # #### Usage guidelines
+    # See [TML API
+    # Documentation](https://developers.thoughtspot.com/docs/tml#_fetch_status_o
+    # f_the_tml_import_task) for usage guidelines.
+    # #### Endpoint URL
+    # @param [FetchAsyncImportTaskStatusRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_async_import_task_status(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/tml/async/status',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetAsyncImportStatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Fetches the underlying SQL query data for a Liveboard object and its
+    # visualizations.
+    # Requires at least view access to the Liveboard object.
+    # To get SQL query data for a Liveboard, specify the GUID of the Liveboard.
+    # Optionally, you can add an array of visualization GUIDs to retrieve the
+    # SQL query data for visualizations in the Liveboard.
+    # Upon successful execution, the API returns the SQL queries for the
+    # specified object as shown in this example:
+    # ```
+    # {
+    #   "metadata_id": "fa68ae91-7588-4136-bacd-d71fb12dda69",
+    #   "metadata_name": "Total Sales",
+    #   "metadata_type": "LIVEBOARD",
+    #   "sql_queries": [
+    #     {
+    #       "metadata_id": "b3b6d2b9-089a-490c-8e16-b144650b7843",
+    #       "metadata_name": "Total quantity purchased, Total sales by region",
+    #       "sql_query": "SELECT \n  \"ta_1\".\"REGION\" \"ca_1\", \n  CASE\n
+    # WHEN sum(\"ta_2\".\"QUANTITYPURCHASED\") IS NOT NULL THEN
+    # sum(\"ta_2\".\"QUANTITYPURCHASED\")\n    ELSE 0\n  END \"ca_2\", \n
+    # CASE\n    WHEN sum(\"ta_2\".\"SALES\") IS NOT NULL THEN
+    # sum(\"ta_2\".\"SALES\")\n    ELSE 0\n  END \"ca_3\"\nFROM
+    # \"RETAILAPPAREL\".\"PUBLIC\".\"FACT_RETAPP_SALES\" \"ta_2\"\n  JOIN
+    # \"RETAILAPPAREL\".\"PUBLIC\".\"DIM_RETAPP_STORES\" \"ta_1\"\n    ON
+    # \"ta_2\".\"STOREID\" = \"ta_1\".\"STOREID\"\nGROUP BY \"ca_1\""
+    #     }
+    #   ]
+    # }
+    # ```
+    # #### Endpoint URL
+    # @param [FetchLiveboardSqlQueryRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_liveboard_sql_query(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/liveboard/sql',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SqlQueryResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Imports [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into
+    # ThoughtSpot.
+    # Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can
+    # administer ThoughtsSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the following Data control privileges may be required:
+    # - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)
+    # - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)
+    # #### Usage guidelines
+    # *  Import all related objects in a single TML Import API call. For
+    # example, Tables that use the same Connection object and Worksheets
+    # connected to these Tables.
+    # * Include the `fqn` property to distinguish objects that have the same
+    # name.
+    #   For example, if you have multiple Connections or Worksheets with the
+    # same name on ThoughtSpot and the Connection or Worksheet referenced in
+    # your TML file does not have a unique name to distinguish, it may result in
+    # invalid object references.
+    #   Adding `fqn` helps ThoughtSpot differentiate a Table from another with
+    # the same name.
+    #   We recommend [exporting TML with
+    # FQNs](#/http/api-endpoints/metadata/export-metadata-tml) and using these
+    # during the import operation.
+    # * You can upload multiple TML files at a time.
+    #   If you import a Worksheet along with Liveboards, Answers, and other
+    # dependent objects in a single API call, the imported objects will be
+    # immediately available for use.
+    #   When you import only a Worksheet object, it may take some time for the
+    # Worksheet to become available in the ThoughtSpot system. Please wait for a
+    # few minutes, and then proceed to create an Answer and Liveboard from the
+    # newly imported Worksheet.
+    # For more information, see [TML
+    # Documentation](https://developers.thoughtspot.com/docs/tml#_import_a_tml).
+    # #### Endpoint URL
+    # @param [ImportMetadataTmlRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def import_metadata_tml(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/tml/import',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 10.4.0.cl or later</span>
+    # Schedules a task to import
+    # [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into
+    # ThoughtSpot. You can use this API endpoint to process TML objects
+    # asynchronously when importing TMLs of large and complex metadata objects
+    # into ThoughtSpot. Unlike the synchronous import TML operation, the API
+    # processes TML data in the background and returns a task ID, which can be
+    # used to check the status of the import task via
+    # `/api/rest/2.0/metadata/tml/async/status` API endpoint.
+    # Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can
+    # administer ThoughtsSpot**) privilege, and edit access to the TML objects.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the following Data control privileges may be required:
+    # - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)
+    # - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)
+    # #### Usage guidelines
+    # See [Async TML API
+    # Documentation](https://developers.thoughtspot.com/docs/tml#_import_tml_obj
+    # ects_asynchronously) for usage guidelines.
+    # #### Endpoint URL
+    # @param [ImportMetadataTmlAsyncRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def import_metadata_tml_async(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/tml/async/import',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ImportEPackAsyncTaskStatus.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Parameterize fields in metadata objects. <br/> <span
+    # class="since-beta-tag">Beta</span> <span class="since-beta-tag">Version:
+    # 10.9.0.cl or later</span>
+    # Allows parameterizing fields in metadata objects in ThoughtSpot.
+    # Requires appropriate permissions to modify the metadata object.
+    # The API endpoint allows parameterizing the following types of metadata
+    # objects:
+    # * Logical Tables
+    # * Connections
+    # * Connection Configs
+    # For a Logical Table the field type must be `ATTRIBUTE` and field name can
+    # be one of:
+    # * databaseName
+    # * schemaName
+    # * tableName
+    # For a Connection or Connection Config, the field type is always
+    # `CONNECTION_PROPERTY`. In this case, field_name specifies the exact
+    # property of the Connection or Connection Config that needs to be
+    # parameterized.
+    # For Connection Config, the only supported field name is:
+    # * impersonate_user
+    # #### Endpoint URL
+    # @param [ParameterizeMetadataRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def parameterize_metadata(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/parameterize',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Gets a list of metadata objects available on the ThoughtSpot system.
+    # This API endpoint is available to all users who have view access to the
+    # object. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**)
+    # privileges can view data for all metadata objects, including users and
+    # groups.
+    # #### Usage guidelines
+    # - To get all metadata objects, send the API request without any
+    # attributes.
+    # - To get metadata objects of a specific type, set the `type` attribute.
+    # For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE`.
+    # - To filter metadata objects within type `LOGICAL_TABLE`, set the
+    # `subtypes` attribute. For example, to fetch a Worksheet, set the type as
+    # `LOGICAL_TABLE` & subtypes as `[WORKSHEET]`.
+    # - To get a specific metadata object, specify the GUID.
+    # - To customize your search and filter the API response, you can use
+    # several parameters.
+    #   You can search for objects created or modified by specific users, by
+    # tags applied to the objects, or by using the include parameters like
+    # `include_auto_created_objects`, `include_dependent_objects`,
+    # `include_headers`, `include_incomplete_objects`, and so on.
+    #   You can also define sorting options to sort the data retrieved in the
+    # API response.
+    # - To get discoverable objects when linientmodel is enabled you can use
+    # `include_discoverable_objects` as true else false. Default value is true.
+    # - For liveboard metadata type, to get the newer format, set the
+    # `liveboard_response_format` as V2. Default value is V1.
+    # - To retrieve only objects that are published, set the
+    # `include_only_published_objects` as true. Default value is false.
+    # **NOTE**: The following parameters support pagination of metadata records:
+    # - `tag_identifiers`
+    # - `type`
+    # - `subtypes`
+    # - `created_by_user_identifiers`
+    # - `modified_by_user_identifiers`
+    # - `owned_by_user_identifiers`
+    # - `exclude_objects`
+    # - `include_auto_created_objects`
+    # - `favorite_object_options`
+    # - `include_only_published_objects`
+    # If you are using other parameters to search metadata, set `record_size` to
+    # `-1` and `record_offset` to `0`.
+    # #### Endpoint URL
+    # @param [SearchMetadataRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_metadata(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MetadataSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Remove parameterization from fields in metadata objects. <br/> <span
+    # class="since-beta-tag">Beta</span> <span class="since-beta-tag">Version:
+    # 10.9.0.cl or later</span>
+    # Allows removing parameterization from fields in metadata objects in
+    # ThoughtSpot.
+    # Requires appropriate permissions to modify the metadata object.
+    # The API endpoint allows unparameterizing the following types of metadata
+    # objects:
+    # * Logical Tables
+    # * Connections
+    # * Connection Configs
+    # For a Logical Table the field type must be `ATTRIBUTE` and field name can
+    # be one of:
+    # * databaseName
+    # * schemaName
+    # * tableName
+    # For a Connection or Connection Config, the field type is always
+    # `CONNECTION_PROPERTY`. In this case, field_name specifies the exact
+    # property of the Connection or Connection Config that needs to be
+    # unparameterized.
+    # For Connection Config, the only supported field name is:
+    # * impersonate_user
+    # #### Endpoint URL
+    # @param [UnparameterizeMetadataRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def unparameterize_metadata(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/unparameterize',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Update header attributes for a given list of header objects. <br/> <span
+    # class="since-beta-tag">Beta</span> <span class="since-beta-tag">Version:
+    # 10.6.0.cl or later</span>
+    # ## Prerequisites
+    # - **Privileges Required:**
+    #   - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer
+    # ThoughtSpot).
+    # - **Additional Privileges (if RBAC is enabled):**
+    #   - `ORG_ADMINISTRATION` (Can manage orgs).
+    # ---
+    # ## Usage Guidelines
+    # ### Parameters
+    # 1. **headers_update**
+    #    - **Description:** List of header objects with their attributes to be
+    # updated. Each object contains a list of attributes to be updated in the
+    # header.
+    #    - **Usage:**
+    #       - You must provide either `identifier` or `obj_identifier`, but not
+    # both. Both fields cannot be empty.
+    #       - When `org_identifier` is set to `-1`, only the `identifier` value
+    # is accepted; `obj_identifier` is not allowed.
+    # 2. **org_identifier**
+    #    - **Description:** GUID (Globally Unique Identifier) or name of the
+    # organization.
+    #    - **Usage:**
+    #      - Leaving this field empty assumes that the changes should be applied
+    # to the current organization
+    #      - Provide `org_guid` or `org_name` to uniquely identify the
+    # organization where changes need to be applied. .
+    #      - Provide `-1` if changes have to be applied across all the org.
+    # ---
+    # ## Note
+    # Currently, this API is enabled only for updating the `obj_identifier`
+    # attribute. Only `text` will be allowed in attribute's value.
+    # ## Best Practices
+    # 1. **Backup Before Conversion:**
+    #    Always export metadata as a backup before initiating the update process
+    # ---
+    # ## Examples
+    # ### Only `identifier` is given
+    # ```json
+    # {
+    #   "headers_update":
+    #   [
+    #     {
+    #       "identifier": "guid_1",
+    #       "obj_identifier": "",
+    #       "type": "LOGICAL_COLUMN",
+    #       "attributes":
+    #       [
+    #         {
+    #           "name": "obj_id",
+    #           "value": "custom_object_id"
+    #         }
+    #       ]
+    #     }
+    #   ],
+    #   "org_identifier": "orgGuid"
+    # }
+    # ```
+    # ### Only `obj_identifier` is given
+    # ```json
+    # {
+    #   "headers_update":
+    #   [
+    #     {
+    #       "obj_identifier": "custom_object_id",
+    #       "type": "ANSWER",
+    #       "attributes":
+    #       [
+    #         {
+    #           "name": "obj_id",
+    #           "value": "custom_object_id"
+    #         }
+    #       ]
+    #     }
+    #   ],
+    #   "org_identifier": "orgName"
+    # }
+    # ```
+    # ### Executing update for all org `-1`
+    # ```json
+    # {
+    #   "headers_update":
+    #   [
+    #     {
+    #       "identifier": "guid_1",
+    #       "type": "ANSWER",
+    #       "attributes":
+    #       [
+    #         {
+    #           "name": "obj_id",
+    #           "value": "custom_object_id"
+    #         }
+    #       ]
+    #     }
+    #   ],
+    #   "org_identifier": -1
+    # }
+    # ```
+    # ### Optional `type` is not provided
+    # ```json
+    # {
+    #   "headers_update":
+    #   [
+    #     {
+    #       "identifier": "guid_1",
+    #       "attributes":
+    #       [
+    #         {
+    #           "name": "obj_id",
+    #           "value": "custom_object_id"
+    #         }
+    #       ]
+    #     }
+    #   ],
+    #   "org_identifier": -1
+    # }
+    # ```
+    # #### Endpoint URL
+    # @param [UpdateMetadataHeaderRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_metadata_header(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/headers/update',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Update object IDs for given metadata objects. <br/> <span
+    # class="since-beta-tag">Beta</span> <span class="since-beta-tag">Version:
+    # 10.8.0.cl or later</span>
+    # ## Prerequisites
+    # - **Privileges Required:**
+    #   - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer
+    # ThoughtSpot).
+    # - **Additional Privileges (if RBAC is enabled):**
+    #   - `ORG_ADMINISTRATION` (Can manage orgs).
+    # ---
+    # ## Usage Guidelines
+    # ### Parameters
+    # 1. **metadata**
+    #    - **Description:** List of metadata objects to update their object IDs.
+    #    - **Usage:**
+    #       - Use either `current_obj_id` alone OR use `metadata_identifier`
+    # with `type` (when needed).
+    #       - When using `metadata_identifier`, the `type` field is required if
+    # using a name instead of a GUID.
+    #       - The `new_obj_id` field is always required.
+    # ---
+    # ## Note
+    # This API is specifically designed for updating object IDs of metadata
+    # objects. It internally uses the header update mechanism to perform the
+    # changes.
+    # ## Best Practices
+    # 1. **Backup Before Update:**
+    #    Always export metadata as a backup before initiating the update
+    # process.
+    # 2. **Validation:**
+    #    - When using `current_obj_id`, ensure it matches the existing object ID
+    # exactly.
+    #    - When using `metadata_identifier` with a name, ensure the `type` is
+    # specified correctly.
+    #    - Verify that the `new_obj_id` follows your naming conventions and is
+    # unique within your system.
+    # ---
+    # ## Examples
+    # ### Using current_obj_id
+    # ```json
+    # {
+    #   "metadata": [
+    #     {
+    #       "current_obj_id": "existing_object_id",
+    #       "new_obj_id": "new_object_id"
+    #     }
+    #   ]
+    # }
+    # ```
+    # ### Using metadata_identifier with GUID
+    # ```json
+    # {
+    #   "metadata": [
+    #     {
+    #       "metadata_identifier": "01234567-89ab-cdef-0123-456789abcdef",
+    #       "new_obj_id": "new_object_id"
+    #     }
+    #   ]
+    # }
+    # ```
+    # ### Using metadata_identifier with name and type
+    # ```json
+    # {
+    #   "metadata": [
+    #     {
+    #       "metadata_identifier": "My Answer",
+    #       "type": "ANSWER",
+    #       "new_obj_id": "new_object_id"
+    #     }
+    #   ]
+    # }
+    # ```
+    # ### Multiple objects update
+    # ```json
+    # {
+    #   "metadata": [
+    #     {
+    #       "current_obj_id": "existing_object_id_1",
+    #       "new_obj_id": "new_object_id_1"
+    #     },
+    #     {
+    #       "metadata_identifier": "My Worksheet",
+    #       "type": "LOGICAL_TABLE",
+    #       "new_obj_id": "new_object_id_2"
+    #     }
+    #   ]
+    # }
+    # ```
+    # #### Endpoint URL
+    # @param [UpdateMetadataObjIdRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_metadata_obj_id(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/metadata/update-obj-id',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+  end
+end