ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/controllers/orgs_controller.rb

@@ -0,0 +1,183 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # OrgsController
+  class OrgsController < BaseController
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Creates an Org object.
+    # To use this API, the
+    # [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview) feature
+    # must be enabled in your cluster.
+    # Requires cluster administration (**Can administer Org**) privileges.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [CreateOrgRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_org(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/orgs/create',
+                                     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(OrgResponse.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>
+    # Deletes an Org object from the ThoughtSpot system.
+    # Requires cluster administration (**Can administer Org**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is
+    # required.
+    # When you delete an Org, all its users and objects created in that Org
+    # context are removed. However, if the users in the deleted Org also exists
+    # in other Orgs, they are removed only from the deleted Org.
+    # #### Endpoint URL
+    # @param [String] org_identifier Required parameter: ID or name of the Org
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_org(org_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/orgs/{org_identifier}/delete',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(org_identifier, key: 'org_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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 Orgs configured on the ThoughtSpot system. To get details
+    # of a specific Org, specify the Org ID or name. You can also pass
+    # parameters such as status, visibility, and user identifiers to get a
+    # specific list of Orgs.
+    # Requires cluster administration (**Can administer Org**) privileges.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [SearchOrgsRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_orgs(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/orgs/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(OrgResponse.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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Updates an Org object. You can modify Org properties such as name,
+    # description, and user associations.
+    # Requires cluster administration (**Can administer Org**) privileges.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [String] org_identifier Required parameter: ID or name of the Org
+    # @param [UpdateOrgRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_org(org_identifier,
+                   body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/orgs/{org_identifier}/update',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(org_identifier, key: 'org_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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

data/lib/thought_spot_public_rest_api/controllers/reports_controller.rb

@@ -0,0 +1,126 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ReportsController
+  class ReportsController < BaseController
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Exports an Answer in the given file format. You can download the Answer
+    # data as a PDF, PNG, CSV, or XLSX file.
+    # Requires at least view access to the Answer.
+    # #### Usage guidelines
+    # In the request body, the GUID or name of the Answer and set `file_format`.
+    # The default file format is CSV.
+    # **NOTE**:
+    # * The downloadable file returned in API response file is extensionless.
+    # Please rename the downloaded file by typing in the relevant extension.
+    # * HTML rendering is not supported for PDF exports of Answers with tables.
+    # Optionally, you can define [runtime
+    # overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-a
+    # pis#_runtime_overrides) to apply to the Answer data.
+    # #### Endpoint URL
+    # @param [ExportAnswerReportRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def export_answer_report(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/report/answer',
+                                     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_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 a Liveboard and its visualizations in PDF, PNG, CSV, or XLSX file
+    # format.
+    # The default `file_format` is CSV.
+    # Requires at least view access to the Liveboard.
+    # #### Usage guidelines
+    # In the request body, specify the GUID or name of the Liveboard. To
+    # generate a Liveboard report with specific visualizations, add GUIDs or
+    # names of the visualizations.
+    # **NOTE**:
+    # * The downloadable file returned in API response file is extensionless.
+    # Please rename the downloaded file by typing in the relevant extension.
+    # * Optionally, you can define [runtime
+    # overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-a
+    # pis#_runtime_overrides) to apply to the Answer data.
+    # * To include unsaved changes in the report, pass the
+    # `transient_pinboard_content` script generated from the
+    # `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon
+    # successful execution, the API returns the report with unsaved changes,
+    # including ad hoc changes to visualizations. For more information, see
+    # [Liveboard Report
+    # API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_l
+    # iveboard_report_api).
+    # * Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be
+    # exported in the PNG format in the resolution of your choice. To enable
+    # this on your instance, contact ThoughtSpot support. When this feature is
+    # enabled, the options `include_cover_page`,`include_filter_page` within the
+    # `png_options` will not be available for PNG exports.
+    # * Starting with the ThoughtSpot Cloud 26.2.0.cl release,
+    #   * Liveboards can be exported in CSV format.
+    #     * All visualizations within a Liveboard can be exported as individual
+    # CSV files.
+    #     * When exporting multiple visualizations or the entire Liveboard, the
+    # system returns the report as a compressed ZIP file containing the separate
+    # CSV files for each visualization.
+    #   * Liveboards can also be exported in XLSX format.
+    #     * All selected visualizations are consolidated into a single Excel
+    # workbook (.xlsx), with each visualization placed in its own worksheet
+    # (tab).
+    #     * XLSX exports are limited to a maximum of 255 worksheets (tabs) per
+    # workbook.
+    # #### Endpoint URL
+    # @param [ExportLiveboardReportRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def export_liveboard_report(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/report/liveboard',
+                                     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_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

data/lib/thought_spot_public_rest_api/controllers/roles_controller.rb

@@ -0,0 +1,176 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # RolesController
+  class RolesController < BaseController
+    #  <span class="since-beta-tag">Version: 9.5.0.cl or later</span>
+    # Creates a Role object in ThoughtSpot.
+    # Available only if [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance. To create a Role, the `ROLE_ADMINISTRATION` (**Can manage
+    # roles**) privilege is required.
+    # #### Endpoint URL
+    # @param [CreateRoleRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_role(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/roles/create',
+                                     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(RoleResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid parameters.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.5.0.cl or later</span>
+    # Deletes a Role object from the ThoughtSpot system.
+    # Available only if [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance. To delete a Role, the `ROLE_ADMINISTRATION` (**Can manage
+    # roles**) privilege is required.
+    # #### Endpoint URL
+    # @param [String] role_identifier Required parameter: Unique ID or name of
+    # the Role. ReadOnly roles cannot be deleted.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_role(role_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/roles/{role_identifier}/delete',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(role_identifier, key: 'role_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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',
+                                 'Internal error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.5.0.cl or later</span>
+    # Gets a list of Role objects from the ThoughtSpot system.
+    # Available if [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance. To search for Roles, the `ROLE_ADMINISTRATION` (**Can manage
+    # roles**) privilege is required.
+    # To get details of a specific Role object, specify the GUID or name. You
+    # can also filter the API response based on user group and Org identifiers,
+    # privileges assigned to the Role, and deprecation status.
+    # #### Endpoint URL
+    # @param [SearchRolesRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_roles(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/roles/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(SearchRoleResponse.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',
+                                 'Internal error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 9.5.0.cl or later</span>
+    # Updates the properties of a Role object.
+    # Available only if [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance. To update a Role, the `ROLE_ADMINISTRATION` (**Can manage
+    # roles**) privilege is required.
+    # #### Endpoint URL
+    # @param [String] role_identifier Required parameter: Unique ID or name of
+    # the Role.
+    # @param [UpdateRoleRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_role(role_identifier,
+                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/roles/{role_identifier}/update',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(role_identifier, key: 'role_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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(RoleResponse.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
+  end
+end