ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/export_metadata_type_input.rb

@@ -0,0 +1,119 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # MetadataType InputType used in Export MetadataType API
+  class ExportMetadataTypeInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 [Type17]
+    attr_accessor :type
+
+    # Unique ID or name of the metadata object. Not required if the metadata
+    # type is ANSWER when session_id and generation_number is set.
+    # @return [String]
+    attr_accessor :identifier
+
+    # Unique ID of the Answer session. Required if the metadata type is ANSWER
+    # and identifier is not set.
+    # @return [String]
+    attr_accessor :session_identifier
+
+    # Generation Number of the Answer session. Required if the metadata type is
+    # ANSWER and identifier is not set.
+    # @return [Integer]
+    attr_accessor :generation_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['identifier'] = 'identifier'
+      @_hash['session_identifier'] = 'session_identifier'
+      @_hash['generation_number'] = 'generation_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        identifier
+        session_identifier
+        generation_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        identifier
+        session_identifier
+        generation_number
+      ]
+    end
+
+    def initialize(type: SKIP, identifier: SKIP, session_identifier: SKIP,
+                   generation_number: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @identifier = identifier unless identifier == SKIP
+      @session_identifier = session_identifier unless session_identifier == SKIP
+      @generation_number = generation_number unless generation_number == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      session_identifier =
+        hash.key?('session_identifier') ? hash['session_identifier'] : SKIP
+      generation_number =
+        hash.key?('generation_number') ? hash['generation_number'] : 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.
+      ExportMetadataTypeInput.new(type: type,
+                                  identifier: identifier,
+                                  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} type: #{@type}, identifier: #{@identifier}, 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} type: #{@type.inspect}, identifier: #{@identifier.inspect},"\
+      " 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/export_options.rb

@@ -0,0 +1,168 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Flags to specify additional options for export. This will only be active
+  # when UserDefinedId in TML is enabled.
+  class ExportOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boolean Flag to export Object ID of referenced object. This flag will work
+    # only after the Object ID feature has been enabled. Please contact support
+    # to enable the feature.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_obj_id_ref
+
+    # Boolean flag to export guid of the object. This flag will work only after
+    # the Object ID feature has been enabled. Please contact support to enable
+    # the feature.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_guid
+
+    # Boolean flag to export Object ID of the object. This flag will work only
+    # after the Object ID feature has been enabled. Please contact support to
+    # enable the feature.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_obj_id
+
+    # Boolean flag indicating whether to export associated feedbacks of the
+    # object. This will only be respected when the object can have feedbacks.
+    # <br/>  <span class="since-beta-tag">Version: 10.7.0.cl or later</span>
+    # @return [TrueClass | FalseClass]
+    attr_accessor :export_with_associated_feedbacks
+
+    # Boolean flag indicating whether to export column security rules of the
+    # object. This will only be respected when the object can have column
+    # security rules and export_associated is true. <br/> <span
+    # class="since-beta-tag">Beta</span> <span class="since-beta-tag">Version:
+    # 10.12.0.cl or later</span>
+    # @return [TrueClass | FalseClass]
+    attr_accessor :export_column_security_rules
+
+    # Boolean flag indicating whether to export column aliases of the model.
+    # This will only be respected when the object can have column aliases. <br/>
+    # <span class="since-beta-tag">Beta</span> <span
+    # class="since-beta-tag">Version: 10.13.0.cl or later</span>
+    # @return [TrueClass | FalseClass]
+    attr_accessor :export_with_column_aliases
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['include_obj_id_ref'] = 'include_obj_id_ref'
+      @_hash['include_guid'] = 'include_guid'
+      @_hash['include_obj_id'] = 'include_obj_id'
+      @_hash['export_with_associated_feedbacks'] =
+        'export_with_associated_feedbacks'
+      @_hash['export_column_security_rules'] = 'export_column_security_rules'
+      @_hash['export_with_column_aliases'] = 'export_with_column_aliases'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        include_obj_id_ref
+        include_guid
+        include_obj_id
+        export_with_associated_feedbacks
+        export_column_security_rules
+        export_with_column_aliases
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        include_obj_id_ref
+        include_guid
+        include_obj_id
+        export_with_associated_feedbacks
+        export_column_security_rules
+        export_with_column_aliases
+      ]
+    end
+
+    def initialize(include_obj_id_ref: false, include_guid: true,
+                   include_obj_id: true,
+                   export_with_associated_feedbacks: false,
+                   export_column_security_rules: false,
+                   export_with_column_aliases: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @include_obj_id_ref = include_obj_id_ref unless include_obj_id_ref == SKIP
+      @include_guid = include_guid unless include_guid == SKIP
+      @include_obj_id = include_obj_id unless include_obj_id == SKIP
+      unless export_with_associated_feedbacks == SKIP
+        @export_with_associated_feedbacks =
+          export_with_associated_feedbacks
+      end
+      unless export_column_security_rules == SKIP
+        @export_column_security_rules =
+          export_column_security_rules
+      end
+      unless export_with_column_aliases == SKIP
+        @export_with_column_aliases =
+          export_with_column_aliases
+      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.
+      include_obj_id_ref = hash['include_obj_id_ref'] ||= false
+      include_guid = hash['include_guid'] ||= true
+      include_obj_id = hash['include_obj_id'] ||= true
+      export_with_associated_feedbacks =
+        hash['export_with_associated_feedbacks'] ||= false
+      export_column_security_rules =
+        hash['export_column_security_rules'] ||= false
+      export_with_column_aliases = hash['export_with_column_aliases'] ||= 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.
+      ExportOptions.new(include_obj_id_ref: include_obj_id_ref,
+                        include_guid: include_guid,
+                        include_obj_id: include_obj_id,
+                        export_with_associated_feedbacks: export_with_associated_feedbacks,
+                        export_column_security_rules: export_column_security_rules,
+                        export_with_column_aliases: export_with_column_aliases,
+                        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} include_obj_id_ref: #{@include_obj_id_ref}, include_guid: #{@include_guid},"\
+      " include_obj_id: #{@include_obj_id}, export_with_associated_feedbacks:"\
+      " #{@export_with_associated_feedbacks}, export_column_security_rules:"\
+      " #{@export_column_security_rules}, export_with_column_aliases:"\
+      " #{@export_with_column_aliases}, 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} include_obj_id_ref: #{@include_obj_id_ref.inspect}, include_guid:"\
+      " #{@include_guid.inspect}, include_obj_id: #{@include_obj_id.inspect},"\
+      " export_with_associated_feedbacks: #{@export_with_associated_feedbacks.inspect},"\
+      " export_column_security_rules: #{@export_column_security_rules.inspect},"\
+      " export_with_column_aliases: #{@export_with_column_aliases.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/export_schema_version.rb

@@ -0,0 +1,40 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Indicates whether to export worksheet TML in DEFAULT or V1 or V2 version.
+  class ExportSchemaVersion
+    EXPORT_SCHEMA_VERSION = [
+      # TODO: Write general description for DEFAULT
+      DEFAULT = 'DEFAULT'.freeze,
+
+      # 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 = DEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'default' then DEFAULT
+      when 'v1' then V1
+      when 'v2' then V2
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/external_table_input.rb

@@ -0,0 +1,109 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ExternalTableInput Model.
+  class ExternalTableInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of the connection.
+    # @return [String]
+    attr_accessor :connection_identifier
+
+    # Name of the database.
+    # @return [String]
+    attr_accessor :database_name
+
+    # Name of the schema.
+    # @return [String]
+    attr_accessor :schema_name
+
+    # Name of the table. Table names may be case-sensitive depending on the
+    # database system.
+    # @return [String]
+    attr_accessor :table_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['connection_identifier'] = 'connection_identifier'
+      @_hash['database_name'] = 'database_name'
+      @_hash['schema_name'] = 'schema_name'
+      @_hash['table_name'] = 'table_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        database_name
+        schema_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        database_name
+        schema_name
+      ]
+    end
+
+    def initialize(connection_identifier:, table_name:, database_name: SKIP,
+                   schema_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @connection_identifier = connection_identifier
+      @database_name = database_name unless database_name == SKIP
+      @schema_name = schema_name unless schema_name == SKIP
+      @table_name = table_name
+      @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.
+      connection_identifier =
+        hash.key?('connection_identifier') ? hash['connection_identifier'] : nil
+      table_name = hash.key?('table_name') ? hash['table_name'] : nil
+      database_name = hash.key?('database_name') ? hash['database_name'] : SKIP
+      schema_name = hash.key?('schema_name') ? hash['schema_name'] : 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.
+      ExternalTableInput.new(connection_identifier: connection_identifier,
+                             table_name: table_name,
+                             database_name: database_name,
+                             schema_name: schema_name,
+                             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} connection_identifier: #{@connection_identifier}, database_name:"\
+      " #{@database_name}, schema_name: #{@schema_name}, table_name: #{@table_name},"\
+      " 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} connection_identifier: #{@connection_identifier.inspect}, database_name:"\
+      " #{@database_name.inspect}, schema_name: #{@schema_name.inspect}, table_name:"\
+      " #{@table_name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/favorite_metadata_input.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
+  # FavoriteMetadataInput Model.
+  class FavoriteMetadataInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of the metadata object.
+    # @return [String]
+    attr_accessor :identifier
+
+    # Type of metadata object.
+    #   
+    # 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 [Type1]
+    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.
+      FavoriteMetadataInput.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

data/lib/thought_spot_public_rest_api/models/favorite_metadata_item.rb

@@ -0,0 +1,93 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # FavoriteMetadataItem Model.
+  class FavoriteMetadataItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of the metadata object.
+    # @return [String]
+    attr_accessor :id
+
+    # name of the metadata object.
+    # @return [String]
+    attr_accessor :name
+
+    # Type of metadata object.
+    #   
+    # 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 [Type]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_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(id:, name:, type:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @name = name
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : 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.
+      FavoriteMetadataItem.new(id: id,
+                               name: name,
+                               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} id: #{@id}, name: #{@name}, 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} id: #{@id.inspect}, name: #{@name.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end