ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/controllers/variable_controller.rb

@@ -0,0 +1,338 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # VariableController
+  class VariableController < BaseController
+    # Create a variable which can be used for parameterizing metadata objects
+    # <br/> <span class="since-beta-tag">Beta</span> <span
+    # class="since-beta-tag">Version: 10.14.0.cl or later</span>
+    # Allows creating a variable which can be used for parameterizing metadata
+    # objects in ThoughtSpot.
+    # Requires ADMINISTRATION role and TENANT scope.
+    # The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables
+    # in the current organization scope.
+    # The API endpoint supports the following types of variables:
+    # * CONNECTION_PROPERTY - For connection properties
+    # * TABLE_MAPPING - For table mappings
+    # * CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per
+    # principal. In order to use this please contact support to enable this.
+    # * FORMULA_VARIABLE - For Formula variables, introduced in 10.15.0.cl
+    # When creating a variable, you need to specify:
+    # * The variable type
+    # * A unique name for the variable
+    # * Whether the variable contains sensitive values (defaults to false)
+    # * The data type of the variable, only specify for formula variables
+    # (defaults to null)
+    # The operation will fail if:
+    # * The user lacks required permissions
+    # * The variable name already exists
+    # * The variable type is invalid
+    # #### Endpoint URL
+    # @param [CreateVariableRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_variable(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/template/variables/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(Variable.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
+
+    # Delete a variable <br/> <span class="since-beta-tag">Beta</span> <span
+    # class="since-beta-tag">Version: 10.14.0.cl or later</span>
+    # Allows deleting a variable from ThoughtSpot.
+    # Requires ADMINISTRATION role and TENANT scope.
+    # The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables
+    # in the current organization scope.
+    # The API endpoint requires:
+    # * The variable identifier (ID or name)
+    # The operation will fail if:
+    # * The user lacks required permissions
+    # * The variable doesn't exist
+    # * The variable is being used by other objects
+    # #### Endpoint URL
+    # @param [String] identifier Required parameter: Unique id or name of the
+    # variable
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_variable(identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/template/variables/{identifier}/delete',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(identifier, key: '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
+
+    # Delete variable(s) <br/> <span class="since-beta-tag">Beta</span> <span
+    # class="since-beta-tag">Version: 26.4.0.cl or later</span>
+    # #### Endpoint URL
+    # @param [DeleteVariablesRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_variables(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/template/variables/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
+
+    # Update values for a variable <br/> <span
+    # class="since-beta-tag">Beta</span> <span class="since-beta-tag">Version:
+    # 26.4.0.cl or later</span>
+    # #### Endpoint URL
+    # @param [String] identifier Required parameter: Unique ID or name of the
+    # variable
+    # @param [PutVariableValuesRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def put_variable_values(identifier,
+                            body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/template/variables/{identifier}/update-values',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(identifier, key: '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
+
+    # Search variables <br/> <span class="since-beta-tag">Beta</span> <span
+    # class="since-beta-tag">Version: 10.14.0.cl or later</span>
+    # Allows searching for variables in ThoughtSpot.
+    # Requires ADMINISTRATION role.
+    # The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables
+    # in the current organization scope.
+    # The API endpoint supports searching variables by:
+    # * Variable identifier (ID or name)
+    # * Variable type
+    # * Name pattern (case-insensitive, supports % for wildcard)
+    # The search results can be formatted in three ways:
+    # * METADATA - Returns only variable metadata (default)
+    # * METADATA_AND_VALUES - Returns variable metadata and values
+    # The values can be filtered by scope:
+    # * org_identifier
+    # * principal_identifier
+    # * model_identifier
+    # #### Endpoint URL
+    # @param [SearchVariablesRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_variables(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/template/variables/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(Variable.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
+
+    # Update a variable's name <br/> <span class="since-beta-tag">Beta</span>
+    # <span class="since-beta-tag">Version: 10.14.0.cl or later</span>
+    # Allows updating a variable's name in ThoughtSpot.
+    # Requires ADMINISTRATION role and TENANT scope.
+    # The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables
+    # in the current organization scope.
+    # The API endpoint allows updating:
+    # * The variable name
+    # #### Endpoint URL
+    # @param [String] identifier Required parameter: Unique id or name of the
+    # variable to update.
+    # @param [UpdateVariableRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_variable(identifier,
+                        body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/template/variables/{identifier}/update',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(identifier, key: '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
+
+    # Update values for multiple variables <br/> <span
+    # class="since-beta-tag">Beta</span> <span class="since-beta-tag">Version:
+    # 10.14.0.cl or later</span>
+    # Allows updating values for multiple variables in ThoughtSpot.
+    # Requires ADMINISTRATION role.
+    # The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables
+    # in the current organization scope.
+    # The API endpoint allows:
+    # * Adding new values to variables
+    # * Replacing existing values
+    # * Deleting values from variables
+    # When updating variable values, you need to specify:
+    # * The variable identifiers
+    # * The values to add/replace/remove for each variable
+    # * The operation to perform (ADD, REPLACE, REMOVE, RESET)
+    # Behaviour based on operation type:
+    # * ADD - Adds values to the variable if this is a list type variable, else
+    # same as replace.
+    # * REPLACE - Replaces all values of a given set of constraints with the
+    # current set of values.
+    # * REMOVE - Removes any values which match the set of conditions of the
+    # variables if this is a list type variable, else clears value.
+    # * RESET - Removes all constrains for a given variable, scope is ignored
+    # #### Endpoint URL
+    # @param [UpdateVariableValuesRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_variable_values(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/template/variables/update-values',
+                                     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