ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/controllers/collections_controller.rb

@@ -0,0 +1,214 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # CollectionsController
+  class CollectionsController < BaseController
+    #  <span class="since-beta-tag">Version: 26.4.0.cl or later</span>
+    # Creates a new collection in ThoughtSpot.
+    # Collections allow you to organize and group related metadata objects such
+    # as Liveboards, Answers, worksheets, and other data objects. You can also
+    # create nested collections (sub-collections) to build a hierarchical
+    # structure.
+    # #### Supported operations
+    # The API endpoint lets you perform the following operations:
+    # * Create a new collection
+    # * Add metadata objects (Liveboards, Answers, Logical Tables) to the
+    # collection
+    # * Create nested collections by adding sub-collections
+    # #### Endpoint URL
+    # @param [CreateCollectionRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_collection(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/collections/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(Collection.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: 26.4.0.cl or later</span>
+    # Deletes one or more collections from ThoughtSpot.
+    # #### Delete options
+    # * **delete_children**: When set to `true`, deletes the child objects
+    # (metadata items) within the collection that the user has access to.
+    # Objects that the user does not have permission to delete will be skipped.
+    # * **dry_run**: When set to `true`, performs a preview of the deletion
+    # operation without actually deleting anything. The response shows what
+    # would be deleted, allowing you to review before committing the deletion.
+    # #### Response
+    # The response includes:
+    # * **metadata_deleted**: List of metadata objects that were successfully
+    # deleted
+    # * **metadata_skipped**: List of metadata objects that were skipped due to
+    # lack of permissions or other constraints
+    # #### Endpoint URL
+    # @param [DeleteCollectionRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_collection(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/collections/delete',
+                                     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(CollectionDeleteResponse.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',
+                                 'Resource not found.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    #  <span class="since-beta-tag">Version: 26.4.0.cl or later</span>
+    # Gets a list of collections available in ThoughtSpot.
+    # To get details of a specific collection, specify the collection GUID or
+    # name. You can also filter the API response based on the collection name
+    # pattern, author, and other criteria.
+    # #### Search options
+    # * **name_pattern**: Use '%' as a wildcard character to match collection
+    # names
+    # * **collection_identifiers**: Search for specific collections by their
+    # GUIDs or names
+    # * **include_metadata**: When set to `true`, includes the metadata objects
+    # within each collection in the response
+    # **NOTE**: If the API returns an empty list, consider increasing the value
+    # of the `record_size` parameter. To search across all available
+    # collections, set `record_size` to `-1`.
+    # #### Endpoint URL
+    # @param [SearchCollectionsRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_collections(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/collections/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(CollectionSearchResponse.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: 26.4.0.cl or later</span>
+    # Updates an existing collection in ThoughtSpot.
+    # #### Supported operations
+    # This API endpoint lets you perform the following operations:
+    # * Update collection name and description
+    # * Change visibility settings
+    # * Add metadata objects to the collection (operation: ADD)
+    # * Remove metadata objects from the collection (operation: REMOVE)
+    # * Replace all metadata objects in the collection (operation: REPLACE)
+    # #### Operation types
+    # * **ADD**: Adds the specified metadata objects to the existing collection
+    # without removing current items
+    # * **REMOVE**: Removes only the specified metadata objects from the
+    # collection
+    # * **REPLACE**: Replaces all existing metadata objects with the specified
+    # items (default behavior)
+    # #### Endpoint URL
+    # @param [String] collection_identifier Required parameter: Unique GUID of
+    # the collection. Note: Collection names cannot be used as identifiers since
+    # duplicate names are allowed.
+    # @param [UpdateCollectionRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_collection(collection_identifier,
+                          body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/collections/{collection_identifier}/update',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(collection_identifier, key: 'collection_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('404',
+                                 'Resource not found.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/controllers/connection_configurations_controller.rb

@@ -0,0 +1,227 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ConnectionConfigurationsController
+  class ConnectionConfigurationsController < BaseController
+    #  <span class="since-beta-tag">Version: 10.12.0.cl or later</span>
+    # Gets connection configuration objects.
+    # Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to
+    # the connection object, or `ADMINISTRATION` (**Can administer
+    # ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit
+    # Connections**) privilege is required.
+    # #### Usage guidelines
+    # * To get a list of all configurations available in the ThoughtSpot system,
+    # send the API request with only the connection name or GUID in the request
+    # body.
+    # * To fetch details of a configuration object, specify the configuration
+    # object name or GUID.
+    # #### Endpoint URL
+    # @param [ConnectionConfigurationSearchRequest] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def connection_configuration_search(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/connection-configurations/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(ConnectionConfigurationResponse.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: 10.12.0.cl or later</span>
+    # Creates an additional configuration to an existing connection to a data
+    # warehouse.
+    # Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can
+    # administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit
+    # Connections**) privilege is required.
+    # #### Usage guidelines
+    #  * A JSON map of configuration attributes in `configuration`. The
+    # following example shows the configuration attributes:
+    #   ```
+    #    {
+    #      "user":"DEV_USER",
+    #      "password":"TestConn123",
+    #      "role":"DEV",
+    #      "warehouse":"DEV_WH"
+    #     }
+    #   ```
+    # * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a
+    # required field.
+    # * If the `policy_type` is `PROCESSES`, then `policy_processes` is a
+    # required field.
+    # * If the `policy_type` is `NO_POLICY`, then `policy_principals` and
+    # `policy_processes` are not required fields.
+    # #### Parameterized Connection Support
+    # For parameterized connections that use OAuth authentication, only the
+    # same_as_parent and policy_process_options  attributes are allowed in the
+    # API request. These attributes are not applicable to connections that are
+    # not parameterized.
+    # #### Endpoint URL
+    # @param [CreateConnectionConfigurationRequest] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_connection_configuration(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/connection-configurations/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(ConnectionConfigurationResponse.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.12.0.cl or later</span>
+    # Deletes connection configuration objects.
+    # Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to
+    # the connection object, or `ADMINISTRATION` (**Can administer
+    # ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit
+    # Connections**) privilege is required.
+    # #### Endpoint URL
+    # @param [DeleteConnectionConfigurationRequest] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_connection_configuration(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/connection-configurations/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: 10.12.0.cl or later</span>
+    # Updates a connection configuration object.
+    # Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to
+    # the connection object, or `ADMINISTRATION` (**Can administer
+    # ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit
+    # Connections**) privilege is required.
+    # #### Supported operations
+    # This API endpoint lets you perform the following operations in a single
+    # API request:
+    #  * Edit the name or description of the configuration
+    #  * Edit the configuration properties
+    #  * Edit the `policy_type`
+    #  * Edit the type of authentication
+    #  * Enable or disable a configuration
+    # #### Parameterized Connection Support
+    # For parameterized oauth based connections, only the `same_as_parent` and
+    # `policy_process_options` attributes are allowed. These attributes are not
+    # applicable to connections that are not parameterized.
+    #  **NOTE**: When updating a configuration where `disabled` is `true`, you
+    # must reset `disabled` to `true` in your update request payload. If not
+    # explicitly set again, the API will default `disabled` to `false`.
+    # #### Endpoint URL
+    # @param [String] configuration_identifier Required parameter: Unique ID or
+    # name of the configuration.
+    # @param [UpdateConnectionConfigurationRequest] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_connection_configuration(configuration_identifier,
+                                        body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/connection-configurations/{configuration_identifier}/update',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(configuration_identifier, key: 'configuration_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