ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/send_agent_message_request.rb

@@ -0,0 +1,73 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SendAgentMessageRequest Model.
+  class SendAgentMessageRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # messages to be sent to the agent
+    # @return [Array[String]]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(messages:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @messages = messages
+      @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.
+      messages = hash.key?('messages') ? hash['messages'] : 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.
+      SendAgentMessageRequest.new(messages: messages,
+                                  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} messages: #{@messages}, 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} messages: #{@messages.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/send_agent_message_response.rb

@@ -0,0 +1,86 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SendAgentMessageResponse Model.
+  class SendAgentMessageResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        message
+      ]
+    end
+
+    def initialize(success:, message: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @success = success
+      @message = message unless message == 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.
+      success = hash.key?('success') ? hash['success'] : nil
+      message = hash.key?('message') ? hash['message'] : 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.
+      SendAgentMessageResponse.new(success: success,
+                                   message: message,
+                                   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} success: #{@success}, message: #{@message}, 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} success: #{@success.inspect}, message: #{@message.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/send_agent_message_streaming_request.rb

@@ -0,0 +1,84 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SendAgentMessageStreamingRequest Model.
+  class SendAgentMessageStreamingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the conversation (used to track context)
+    # @return [String]
+    attr_accessor :conversation_identifier
+
+    # messages to be sent to the agent
+    # @return [Array[String]]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['conversation_identifier'] = 'conversation_identifier'
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(conversation_identifier:, messages:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @conversation_identifier = conversation_identifier
+      @messages = messages
+      @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_identifier =
+        hash.key?('conversation_identifier') ? hash['conversation_identifier'] : nil
+      messages = hash.key?('messages') ? hash['messages'] : 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.
+      SendAgentMessageStreamingRequest.new(conversation_identifier: conversation_identifier,
+                                           messages: messages,
+                                           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_identifier: #{@conversation_identifier}, messages:"\
+      " #{@messages}, 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_identifier: #{@conversation_identifier.inspect}, messages:"\
+      " #{@messages.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/send_message_request.rb

@@ -0,0 +1,84 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SendMessageRequest Model.
+  class SendMessageRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the metadata object, such as a Worksheet or Model, to use as a data
+    # source for the conversation.
+    # @return [String]
+    attr_accessor :metadata_identifier
+
+    # A message string with the follow-up question to continue the conversation.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_identifier'] = 'metadata_identifier'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata_identifier:, message:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_identifier = metadata_identifier
+      @message = message
+      @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_identifier =
+        hash.key?('metadata_identifier') ? hash['metadata_identifier'] : nil
+      message = hash.key?('message') ? hash['message'] : 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.
+      SendMessageRequest.new(metadata_identifier: metadata_identifier,
+                             message: message,
+                             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_identifier: #{@metadata_identifier}, message: #{@message},"\
+      " 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_identifier: #{@metadata_identifier.inspect}, message:"\
+      " #{@message.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/set_nl_instructions_request.rb

@@ -0,0 +1,94 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SetNlInstructionsRequest Model.
+  class SetNlInstructionsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of the data-model for which to set NL instructions.
+    # @return [String]
+    attr_accessor :data_source_identifier
+
+    # List of NL instructions to set for the data-model.
+    # @return [Array[NlInstructionsInfoInput]]
+    attr_accessor :nl_instructions_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data_source_identifier'] = 'data_source_identifier'
+      @_hash['nl_instructions_info'] = 'nl_instructions_info'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data_source_identifier:, nl_instructions_info:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data_source_identifier = data_source_identifier
+      @nl_instructions_info = nl_instructions_info
+      @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.
+      data_source_identifier =
+        hash.key?('data_source_identifier') ? hash['data_source_identifier'] : nil
+      # Parameter is an array, so we need to iterate through it
+      nl_instructions_info = nil
+      unless hash['nl_instructions_info'].nil?
+        nl_instructions_info = []
+        hash['nl_instructions_info'].each do |structure|
+          nl_instructions_info << (NlInstructionsInfoInput.from_hash(structure) if structure)
+        end
+      end
+
+      nl_instructions_info = nil unless hash.key?('nl_instructions_info')
+
+      # 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.
+      SetNlInstructionsRequest.new(data_source_identifier: data_source_identifier,
+                                   nl_instructions_info: nl_instructions_info,
+                                   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} data_source_identifier: #{@data_source_identifier}, nl_instructions_info:"\
+      " #{@nl_instructions_info}, 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} data_source_identifier: #{@data_source_identifier.inspect},"\
+      " nl_instructions_info: #{@nl_instructions_info.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/share_metadata_request.rb

@@ -0,0 +1,207 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ShareMetadataRequest Model.
+  class ShareMetadataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of metadata. Required if identifier in metadata_identifies is a name.
+    # 1. Liveboard
+    # 2. Answers
+    # 3. LOGICAL_TABLE for any data object such as table, worksheet or view.
+    # 4. LOGICAL_COLUMN
+    # 5. Connection
+    # @return [MetadataType6]
+    attr_accessor :metadata_type
+
+    # Unique ID or name of metadata objects. Note: All the names should belong
+    # to same metadata_type
+    # @return [Array[String]]
+    attr_accessor :metadata_identifiers
+
+    # Metadata details for sharing objects.
+    # @return [Array[ShareMetadataTypeInput]]
+    attr_accessor :metadata
+
+    # Permission details for sharing the objects.
+    # @return [Array[SharePermissionsInput]]
+    attr_accessor :permissions
+
+    # Options to specify details of Liveboard. First Liveboard encountered in
+    # payload is considered to be the corresponding Liveboard.
+    # @return [Array[String]]
+    attr_accessor :visualization_identifiers
+
+    # Email IDs to which notifications will be sent.
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # Message to be included in notification.
+    # @return [String]
+    attr_accessor :message
+
+    # Sends object URLs in the customized format in email notifications.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_custom_url
+
+    # Flag to notify user when any object is shared.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :notify_on_share
+
+    # Flag to make the object discoverable.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_lenient_discoverability
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_type'] = 'metadata_type'
+      @_hash['metadata_identifiers'] = 'metadata_identifiers'
+      @_hash['metadata'] = 'metadata'
+      @_hash['permissions'] = 'permissions'
+      @_hash['visualization_identifiers'] = 'visualization_identifiers'
+      @_hash['emails'] = 'emails'
+      @_hash['message'] = 'message'
+      @_hash['enable_custom_url'] = 'enable_custom_url'
+      @_hash['notify_on_share'] = 'notify_on_share'
+      @_hash['has_lenient_discoverability'] = 'has_lenient_discoverability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata_type
+        metadata_identifiers
+        metadata
+        visualization_identifiers
+        emails
+        enable_custom_url
+        notify_on_share
+        has_lenient_discoverability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        enable_custom_url
+        notify_on_share
+        has_lenient_discoverability
+      ]
+    end
+
+    def initialize(permissions:, message:, metadata_type: SKIP,
+                   metadata_identifiers: SKIP, metadata: SKIP,
+                   visualization_identifiers: SKIP, emails:,
+                   enable_custom_url: false, notify_on_share: true,
+                   has_lenient_discoverability: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_type = metadata_type unless metadata_type == SKIP
+      @metadata_identifiers = metadata_identifiers unless metadata_identifiers == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @permissions = permissions
+      unless visualization_identifiers == SKIP
+        @visualization_identifiers =
+          visualization_identifiers
+      end
+      @emails = emails unless emails == SKIP
+      @message = message
+      @enable_custom_url = enable_custom_url unless enable_custom_url == SKIP
+      @notify_on_share = notify_on_share unless notify_on_share == SKIP
+      unless has_lenient_discoverability == SKIP
+        @has_lenient_discoverability =
+          has_lenient_discoverability
+      end
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      permissions = nil
+      unless hash['permissions'].nil?
+        permissions = []
+        hash['permissions'].each do |structure|
+          permissions << (SharePermissionsInput.from_hash(structure) if structure)
+        end
+      end
+
+      permissions = nil unless hash.key?('permissions')
+      message = hash.key?('message') ? hash['message'] : nil
+      metadata_type = hash.key?('metadata_type') ? hash['metadata_type'] : SKIP
+      metadata_identifiers =
+        hash.key?('metadata_identifiers') ? hash['metadata_identifiers'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (ShareMetadataTypeInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = SKIP unless hash.key?('metadata')
+      visualization_identifiers =
+        hash.key?('visualization_identifiers') ? hash['visualization_identifiers'] : SKIP
+      emails = hash['emails'] ||= 
+      enable_custom_url = hash['enable_custom_url'] ||= false
+      notify_on_share = hash['notify_on_share'] ||= true
+      has_lenient_discoverability =
+        hash['has_lenient_discoverability'] ||= false
+
+      # 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.
+      ShareMetadataRequest.new(permissions: permissions,
+                               message: message,
+                               metadata_type: metadata_type,
+                               metadata_identifiers: metadata_identifiers,
+                               metadata: metadata,
+                               visualization_identifiers: visualization_identifiers,
+                               emails: emails,
+                               enable_custom_url: enable_custom_url,
+                               notify_on_share: notify_on_share,
+                               has_lenient_discoverability: has_lenient_discoverability,
+                               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_type: #{@metadata_type}, metadata_identifiers:"\
+      " #{@metadata_identifiers}, metadata: #{@metadata}, permissions: #{@permissions},"\
+      " visualization_identifiers: #{@visualization_identifiers}, emails: #{@emails}, message:"\
+      " #{@message}, enable_custom_url: #{@enable_custom_url}, notify_on_share:"\
+      " #{@notify_on_share}, has_lenient_discoverability: #{@has_lenient_discoverability},"\
+      " 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_type: #{@metadata_type.inspect}, metadata_identifiers:"\
+      " #{@metadata_identifiers.inspect}, metadata: #{@metadata.inspect}, permissions:"\
+      " #{@permissions.inspect}, visualization_identifiers: #{@visualization_identifiers.inspect},"\
+      " emails: #{@emails.inspect}, message: #{@message.inspect}, enable_custom_url:"\
+      " #{@enable_custom_url.inspect}, notify_on_share: #{@notify_on_share.inspect},"\
+      " has_lenient_discoverability: #{@has_lenient_discoverability.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end