ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/liveboard_response_version.rb

@@ -0,0 +1,36 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Indicates the model version of Liveboard to be attached in metadata detail.
+  class LiveboardResponseVersion
+    LIVEBOARD_RESPONSE_VERSION = [
+      # TODO: Write general description for V1
+      V1 = 'V1'.freeze,
+
+      # TODO: Write general description for V2
+      V2 = 'V2'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = V1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'v1' then V1
+      when 'v2' then V2
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/log_response.rb

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

data/lib/thought_spot_public_rest_api/models/login_request.rb

@@ -0,0 +1,111 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # LoginRequest Model.
+  class LoginRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Username of the ThoughtSpot user
+    # @return [String]
+    attr_accessor :username
+
+    # Password of the user account
+    # @return [String]
+    attr_accessor :password
+
+    # ID of the Org context to log in to. If Org ID is not specified, the user
+    # will be logged in to the Org context of their previous login session.
+    # @return [String]
+    attr_accessor :org_identifier
+
+    # A flag to remember the user session. When set to true, a session cookie is
+    # created and used in subsequent API requests.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :remember_me
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash['org_identifier'] = 'org_identifier'
+      @_hash['remember_me'] = 'remember_me'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        username
+        password
+        org_identifier
+        remember_me
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        remember_me
+      ]
+    end
+
+    def initialize(username: SKIP, password: SKIP, org_identifier: SKIP,
+                   remember_me: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @username = username unless username == SKIP
+      @password = password unless password == SKIP
+      @org_identifier = org_identifier unless org_identifier == SKIP
+      @remember_me = remember_me unless remember_me == 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.
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+      org_identifier =
+        hash.key?('org_identifier') ? hash['org_identifier'] : SKIP
+      remember_me = hash['remember_me'] ||= 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.
+      LoginRequest.new(username: username,
+                       password: password,
+                       org_identifier: org_identifier,
+                       remember_me: remember_me,
+                       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} username: #{@username}, password: #{@password}, org_identifier:"\
+      " #{@org_identifier}, remember_me: #{@remember_me}, 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} username: #{@username.inspect}, password: #{@password.inspect},"\
+      " org_identifier: #{@org_identifier.inspect}, remember_me: #{@remember_me.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/manage_object_privilege_request.rb

@@ -0,0 +1,125 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ManageObjectPrivilegeRequest Model.
+  class ManageObjectPrivilegeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Operation to perform to manage object privileges. Available operations
+    # are: `ADD`, `REMOVE`.
+    # @return [Operation7]
+    attr_accessor :operation
+
+    # Type of metadata objects on which you want to perform the operation. For
+    # now only LOGICAL_TABLE is supported. It may be extended to other metadata
+    # types in the future.
+    # @return [String]
+    attr_reader :metadata_type
+
+    # List of object privilege types on which you want to perform the operation.
+    # @return [Array[ObjectPrivilegeType]]
+    attr_accessor :object_privilege_types
+
+    # List of metadata identifiers (GUID or name) on which you want to perform
+    # the operation.
+    # @return [Array[String]]
+    attr_accessor :metadata_identifiers
+
+    # User or group objects (GUID or name) to which you want to apply the given
+    # operation and given object privileges.
+    # @return [Array[PrincipalsInput]]
+    attr_accessor :principals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['operation'] = 'operation'
+      @_hash['metadata_type'] = 'metadata_type'
+      @_hash['object_privilege_types'] = 'object_privilege_types'
+      @_hash['metadata_identifiers'] = 'metadata_identifiers'
+      @_hash['principals'] = 'principals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(operation:, object_privilege_types:, metadata_identifiers:,
+                   principals:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @operation = operation
+      @metadata_type = 'LOGICAL_TABLE'
+      @object_privilege_types = object_privilege_types
+      @metadata_identifiers = metadata_identifiers
+      @principals = principals
+      @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.
+      operation = hash.key?('operation') ? hash['operation'] : nil
+      object_privilege_types =
+        hash.key?('object_privilege_types') ? hash['object_privilege_types'] : nil
+      metadata_identifiers =
+        hash.key?('metadata_identifiers') ? hash['metadata_identifiers'] : nil
+      # Parameter is an array, so we need to iterate through it
+      principals = nil
+      unless hash['principals'].nil?
+        principals = []
+        hash['principals'].each do |structure|
+          principals << (PrincipalsInput.from_hash(structure) if structure)
+        end
+      end
+
+      principals = nil unless hash.key?('principals')
+
+      # 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.
+      ManageObjectPrivilegeRequest.new(operation: operation,
+                                       object_privilege_types: object_privilege_types,
+                                       metadata_identifiers: metadata_identifiers,
+                                       principals: principals,
+                                       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} operation: #{@operation}, metadata_type: #{@metadata_type},"\
+      " object_privilege_types: #{@object_privilege_types}, metadata_identifiers:"\
+      " #{@metadata_identifiers}, principals: #{@principals}, 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} operation: #{@operation.inspect}, metadata_type: #{@metadata_type.inspect},"\
+      " object_privilege_types: #{@object_privilege_types.inspect}, metadata_identifiers:"\
+      " #{@metadata_identifiers.inspect}, principals: #{@principals.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/metadata_association_item.rb

@@ -0,0 +1,95 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # MetadataAssociationItem Model.
+  class MetadataAssociationItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specify that the association is enabled for the metadata object
+    # @return [ActionConfig]
+    attr_accessor :action_config
+
+    # Unique ID or name of the metadata.
+    # @return [String]
+    attr_accessor :identifier
+
+    # Type of metadata.
+    #   
+    # Required if the name of the object is set as the identifier. This
+    # attribute is optional when the object GUID is specified as the identifier.
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action_config'] = 'action_config'
+      @_hash['identifier'] = 'identifier'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action_config:, identifier:, type:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @action_config = action_config
+      @identifier = identifier
+      @type = type
+      @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.
+      action_config = ActionConfig.from_hash(hash['action_config']) if hash['action_config']
+      identifier = hash.key?('identifier') ? hash['identifier'] : nil
+      type = hash.key?('type') ? hash['type'] : 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.
+      MetadataAssociationItem.new(action_config: action_config,
+                                  identifier: identifier,
+                                  type: type,
+                                  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} action_config: #{@action_config}, identifier: #{@identifier}, type:"\
+      " #{@type}, 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} action_config: #{@action_config.inspect}, identifier:"\
+      " #{@identifier.inspect}, type: #{@type.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/metadata_context.rb

@@ -0,0 +1,121 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # MetadataContext Model.
+  class MetadataContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of data_source_identifiers to provide context for breaking down user
+    # query into analytical queries that can be run on them.
+    # @return [Array[String]]
+    attr_accessor :data_source_identifiers
+
+    # List of answer unique identifiers (GUIDs) whose data will be used to guide
+    # the response.
+    # @return [Array[String]]
+    attr_accessor :answer_identifiers
+
+    # Unique identifier to denote current conversation.
+    # @return [String]
+    attr_accessor :conversation_identifier
+
+    # List of liveboard unique identifiers (GUIDs) whose data will be used to
+    # guide the response.
+    # @return [Array[String]]
+    attr_accessor :liveboard_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data_source_identifiers'] = 'data_source_identifiers'
+      @_hash['answer_identifiers'] = 'answer_identifiers'
+      @_hash['conversation_identifier'] = 'conversation_identifier'
+      @_hash['liveboard_identifiers'] = 'liveboard_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data_source_identifiers
+        answer_identifiers
+        conversation_identifier
+        liveboard_identifiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        data_source_identifiers
+        answer_identifiers
+        conversation_identifier
+        liveboard_identifiers
+      ]
+    end
+
+    def initialize(data_source_identifiers: SKIP, answer_identifiers: SKIP,
+                   conversation_identifier: SKIP, liveboard_identifiers: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data_source_identifiers = data_source_identifiers unless data_source_identifiers == SKIP
+      @answer_identifiers = answer_identifiers unless answer_identifiers == SKIP
+      @conversation_identifier = conversation_identifier unless conversation_identifier == SKIP
+      @liveboard_identifiers = liveboard_identifiers unless liveboard_identifiers == 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.
+      data_source_identifiers =
+        hash.key?('data_source_identifiers') ? hash['data_source_identifiers'] : SKIP
+      answer_identifiers =
+        hash.key?('answer_identifiers') ? hash['answer_identifiers'] : SKIP
+      conversation_identifier =
+        hash.key?('conversation_identifier') ? hash['conversation_identifier'] : SKIP
+      liveboard_identifiers =
+        hash.key?('liveboard_identifiers') ? hash['liveboard_identifiers'] : 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.
+      MetadataContext.new(data_source_identifiers: data_source_identifiers,
+                          answer_identifiers: answer_identifiers,
+                          conversation_identifier: conversation_identifier,
+                          liveboard_identifiers: liveboard_identifiers,
+                          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_identifiers: #{@data_source_identifiers}, answer_identifiers:"\
+      " #{@answer_identifiers}, conversation_identifier: #{@conversation_identifier},"\
+      " liveboard_identifiers: #{@liveboard_identifiers}, 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_identifiers: #{@data_source_identifiers.inspect},"\
+      " answer_identifiers: #{@answer_identifiers.inspect}, conversation_identifier:"\
+      " #{@conversation_identifier.inspect}, liveboard_identifiers:"\
+      " #{@liveboard_identifiers.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/metadata_input.rb

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