ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/action_details_input_create.rb

@@ -0,0 +1,87 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Action details includes Type and Configuration for Custom Actions, either
+  # Callback or URL is required. When both callback and url are provided,
+  # callback would be considered
+  class ActionDetailsInputCreate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # CALLBACK Custom Action Type
+    # @return [CallbackInputMandatory]
+    attr_accessor :callback
+
+    # URL Custom Action Type
+    # @return [UrlInputMandatory]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['callback'] = 'CALLBACK'
+      @_hash['url'] = 'URL'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        callback
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(callback: SKIP, url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @callback = callback unless callback == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      callback = CallbackInputMandatory.from_hash(hash['CALLBACK']) if hash['CALLBACK']
+      url = UrlInputMandatory.from_hash(hash['URL']) if hash['URL']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ActionDetailsInputCreate.new(callback: callback,
+                                   url: url,
+                                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} callback: #{@callback}, url: #{@url}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} callback: #{@callback.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/activate_user_request.rb

@@ -0,0 +1,104 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ActivateUserRequest Model.
+  class ActivateUserRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of the user.
+    # @return [String]
+    attr_accessor :user_identifier
+
+    # Auth token for the user.
+    # @return [String]
+    attr_accessor :auth_token
+
+    # New password for the user to access the account.
+    # @return [String]
+    attr_accessor :password
+
+    # Properties of the user.
+    # @return [String]
+    attr_accessor :properties
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_identifier'] = 'user_identifier'
+      @_hash['auth_token'] = 'auth_token'
+      @_hash['password'] = 'password'
+      @_hash['properties'] = 'properties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        properties
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_identifier:, auth_token:, password:, properties: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_identifier = user_identifier
+      @auth_token = auth_token
+      @password = password
+      @properties = properties unless properties == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      user_identifier =
+        hash.key?('user_identifier') ? hash['user_identifier'] : nil
+      auth_token = hash.key?('auth_token') ? hash['auth_token'] : nil
+      password = hash.key?('password') ? hash['password'] : nil
+      properties = hash.key?('properties') ? hash['properties'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ActivateUserRequest.new(user_identifier: user_identifier,
+                              auth_token: auth_token,
+                              password: password,
+                              properties: properties,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user_identifier: #{@user_identifier}, auth_token: #{@auth_token}, password:"\
+      " #{@password}, properties: #{@properties}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user_identifier: #{@user_identifier.inspect}, auth_token:"\
+      " #{@auth_token.inspect}, password: #{@password.inspect}, properties:"\
+      " #{@properties.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/agent_conversation.rb

@@ -0,0 +1,75 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # AgentConversation Model.
+  class AgentConversation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the conversation.
+    # @return [String]
+    attr_accessor :conversation_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['conversation_id'] = 'conversation_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(conversation_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @conversation_id = conversation_id
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      conversation_id =
+        hash.key?('conversation_id') ? hash['conversation_id'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AgentConversation.new(conversation_id: conversation_id,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} conversation_id: #{@conversation_id}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} conversation_id: #{@conversation_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/ai_context.rb

@@ -0,0 +1,91 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # AiContext Model.
+  class AiContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User specific text instructions sent to AI system for processing the
+    # query.
+    # @return [Array[String]]
+    attr_accessor :instructions
+
+    # User provided content like text data, csv data as a string message to
+    # provide context & potentially improve the quality of the response.
+    # @return [Array[String]]
+    attr_accessor :content
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['instructions'] = 'instructions'
+      @_hash['content'] = 'content'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        instructions
+        content
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        instructions
+        content
+      ]
+    end
+
+    def initialize(instructions: SKIP, content: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @instructions = instructions unless instructions == SKIP
+      @content = content unless content == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      instructions = hash.key?('instructions') ? hash['instructions'] : SKIP
+      content = hash.key?('content') ? hash['content'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AiContext.new(instructions: instructions,
+                    content: content,
+                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} instructions: #{@instructions}, content: #{@content},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} instructions: #{@instructions.inspect}, content: #{@content.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/answer_content.rb

@@ -0,0 +1,135 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # AnswerContent Model.
+  class AnswerContent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total available data row count.
+    # @return [Integer]
+    attr_accessor :available_data_row_count
+
+    # Name of the columns.
+    # @return [Array[String]]
+    attr_accessor :column_names
+
+    # Rows of data set.
+    # @return [Array[Object]]
+    attr_accessor :data_rows
+
+    # The starting record number from where the records should be included.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records that should be included.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # Total returned data row count.
+    # @return [Integer]
+    attr_accessor :returned_data_row_count
+
+    # Sampling ratio (0 to 1). If the query was sampled, it is the ratio of keys
+    # returned in the data set to the total number of keys expected in the
+    # query. If the value is 1.0, this means that the complete result is
+    # returned.
+    # @return [Float]
+    attr_accessor :sampling_ratio
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available_data_row_count'] = 'available_data_row_count'
+      @_hash['column_names'] = 'column_names'
+      @_hash['data_rows'] = 'data_rows'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['returned_data_row_count'] = 'returned_data_row_count'
+      @_hash['sampling_ratio'] = 'sampling_ratio'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(available_data_row_count:, column_names:, data_rows:,
+                   record_offset:, record_size:, returned_data_row_count:,
+                   sampling_ratio:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @available_data_row_count = available_data_row_count
+      @column_names = column_names
+      @data_rows = data_rows
+      @record_offset = record_offset
+      @record_size = record_size
+      @returned_data_row_count = returned_data_row_count
+      @sampling_ratio = sampling_ratio
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      available_data_row_count =
+        hash.key?('available_data_row_count') ? hash['available_data_row_count'] : nil
+      column_names = hash.key?('column_names') ? hash['column_names'] : nil
+      data_rows = hash.key?('data_rows') ? hash['data_rows'] : nil
+      record_offset = hash.key?('record_offset') ? hash['record_offset'] : nil
+      record_size = hash.key?('record_size') ? hash['record_size'] : nil
+      returned_data_row_count =
+        hash.key?('returned_data_row_count') ? hash['returned_data_row_count'] : nil
+      sampling_ratio =
+        hash.key?('sampling_ratio') ? hash['sampling_ratio'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AnswerContent.new(available_data_row_count: available_data_row_count,
+                        column_names: column_names,
+                        data_rows: data_rows,
+                        record_offset: record_offset,
+                        record_size: record_size,
+                        returned_data_row_count: returned_data_row_count,
+                        sampling_ratio: sampling_ratio,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} available_data_row_count: #{@available_data_row_count}, column_names:"\
+      " #{@column_names}, data_rows: #{@data_rows}, record_offset: #{@record_offset}, record_size:"\
+      " #{@record_size}, returned_data_row_count: #{@returned_data_row_count}, sampling_ratio:"\
+      " #{@sampling_ratio}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} available_data_row_count: #{@available_data_row_count.inspect},"\
+      " column_names: #{@column_names.inspect}, data_rows: #{@data_rows.inspect}, record_offset:"\
+      " #{@record_offset.inspect}, record_size: #{@record_size.inspect}, returned_data_row_count:"\
+      " #{@returned_data_row_count.inspect}, sampling_ratio: #{@sampling_ratio.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/answer_context_input.rb

@@ -0,0 +1,85 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # AnswerContextInput Model.
+  class AnswerContextInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the answer session.
+    # @return [String]
+    attr_accessor :session_identifier
+
+    # Generation number of the answer.
+    # @return [Integer]
+    attr_accessor :generation_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['session_identifier'] = 'session_identifier'
+      @_hash['generation_number'] = 'generation_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(session_identifier:, generation_number:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @session_identifier = session_identifier
+      @generation_number = generation_number
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      session_identifier =
+        hash.key?('session_identifier') ? hash['session_identifier'] : nil
+      generation_number =
+        hash.key?('generation_number') ? hash['generation_number'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AnswerContextInput.new(session_identifier: session_identifier,
+                             generation_number: generation_number,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} session_identifier: #{@session_identifier}, generation_number:"\
+      " #{@generation_number}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} session_identifier: #{@session_identifier.inspect}, generation_number:"\
+      " #{@generation_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/answer_data_response.rb

@@ -0,0 +1,101 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Response format associated with fetch data api
+  class AnswerDataResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier of the object
+    # @return [String]
+    attr_accessor :metadata_id
+
+    # Name of the metadata object
+    # @return [String]
+    attr_accessor :metadata_name
+
+    # Data content of metadata objects
+    # @return [Array[AnswerContent]]
+    attr_accessor :contents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_id'] = 'metadata_id'
+      @_hash['metadata_name'] = 'metadata_name'
+      @_hash['contents'] = 'contents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata_id:, metadata_name:, contents:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_id = metadata_id
+      @metadata_name = metadata_name
+      @contents = contents
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      metadata_id = hash.key?('metadata_id') ? hash['metadata_id'] : nil
+      metadata_name = hash.key?('metadata_name') ? hash['metadata_name'] : nil
+      # Parameter is an array, so we need to iterate through it
+      contents = nil
+      unless hash['contents'].nil?
+        contents = []
+        hash['contents'].each do |structure|
+          contents << (AnswerContent.from_hash(structure) if structure)
+        end
+      end
+
+      contents = nil unless hash.key?('contents')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AnswerDataResponse.new(metadata_id: metadata_id,
+                             metadata_name: metadata_name,
+                             contents: contents,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata_id: #{@metadata_id}, metadata_name: #{@metadata_name}, contents:"\
+      " #{@contents}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata_id: #{@metadata_id.inspect}, metadata_name:"\
+      " #{@metadata_name.inspect}, contents: #{@contents.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end