ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/metadata_list_item_input.rb

@@ -0,0 +1,146 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # MetadataListItemInput Model.
+  class MetadataListItemInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of the metadata.
+    # @return [String]
+    attr_accessor :identifier
+
+    # CustomObjectId of the metadata.
+    # @return [String]
+    attr_accessor :obj_identifier
+
+    # A pattern to match the case-insensitive name of the metadata object. User
+    # % for a wildcard match.
+    # @return [String]
+    attr_accessor :name_pattern
+
+    # Type of metadata. Required if the name of the object is set as identifier.
+    # This attribute is optional when the object GUID is specified as
+    # identifier.
+    # 1. Liveboard
+    # 2. Answers
+    # 3. LOGICAL_TABLE for any data object such as table, worksheet or view.
+    # 4. LOGICAL_COLUMN for a column of any data object such as table, worksheet
+    # or view.
+    # 5. CONNECTION for creating or modify data connections.
+    # 6. TAG for tag objects.
+    # 7. USER for user objects.
+    # 8. USER_GROUP for group objects.
+    # 9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from
+    # one or several data object by using matching values
+    # 10. INSIGHT_SPEC for SpotIQ objects
+    # @return [Type3]
+    attr_accessor :type
+
+    # List of subtype of metadata. Applies for LOGICAL_TABLE type with the
+    # following valid values.
+    # 1. ONE_TO_ONE_LOGICAL
+    # 2. WORKSHEET
+    # 3. PRIVATE_WORKSHEET.
+    # 4. USER_DEFINED.
+    # 5. AGGR_WORKSHEET.
+    # 6. SQL_VIEW <br/>  <span class="since-beta-tag">Version: 10.11.0.cl or
+    # later</span>
+    # @return [Array[Subtype]]
+    attr_accessor :subtypes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identifier'] = 'identifier'
+      @_hash['obj_identifier'] = 'obj_identifier'
+      @_hash['name_pattern'] = 'name_pattern'
+      @_hash['type'] = 'type'
+      @_hash['subtypes'] = 'subtypes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        identifier
+        obj_identifier
+        name_pattern
+        type
+        subtypes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        identifier
+        obj_identifier
+        name_pattern
+        type
+        subtypes
+      ]
+    end
+
+    def initialize(identifier: SKIP, obj_identifier: SKIP, name_pattern: SKIP,
+                   type: SKIP, subtypes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @identifier = identifier unless identifier == SKIP
+      @obj_identifier = obj_identifier unless obj_identifier == SKIP
+      @name_pattern = name_pattern unless name_pattern == SKIP
+      @type = type unless type == SKIP
+      @subtypes = subtypes unless subtypes == 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
+      obj_identifier =
+        hash.key?('obj_identifier') ? hash['obj_identifier'] : SKIP
+      name_pattern = hash.key?('name_pattern') ? hash['name_pattern'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      subtypes = hash.key?('subtypes') ? hash['subtypes'] : 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.
+      MetadataListItemInput.new(identifier: identifier,
+                                obj_identifier: obj_identifier,
+                                name_pattern: name_pattern,
+                                type: type,
+                                subtypes: subtypes,
+                                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}, obj_identifier: #{@obj_identifier},"\
+      " name_pattern: #{@name_pattern}, type: #{@type}, subtypes: #{@subtypes},"\
+      " 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}, obj_identifier:"\
+      " #{@obj_identifier.inspect}, name_pattern: #{@name_pattern.inspect}, type:"\
+      " #{@type.inspect}, subtypes: #{@subtypes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/metadata_object.rb

@@ -0,0 +1,89 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # MetadataObject Model.
+  class MetadataObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 [Type22]
+    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[
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+      ]
+    end
+
+    def initialize(identifier:, type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @identifier = identifier
+      @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'] : nil
+      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.
+      MetadataObject.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/metadata_response.rb

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

data/lib/thought_spot_public_rest_api/models/metadata_search_response.rb

@@ -0,0 +1,186 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Metadata Search Response Object.
+  class MetadataSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the metadata.
+    # @return [String]
+    attr_accessor :metadata_id
+
+    # Name of the metadata.
+    # @return [String]
+    attr_accessor :metadata_name
+
+    # Type of the metadata.
+    # @return [MetadataType]
+    attr_accessor :metadata_type
+
+    # Custom identifier of the metadata.
+    # (Available from 10.8.0.cl onwards)
+    # @return [String]
+    attr_accessor :metadata_obj_id
+
+    # Details of dependent objects of the metadata objects.
+    # @return [Object]
+    attr_accessor :dependent_objects
+
+    # Details of incomplete information of the metadata objects if any.
+    # @return [Array[Object]]
+    attr_accessor :incomplete_objects
+
+    # Complete details of the metadata objects.
+    # @return [Object]
+    attr_accessor :metadata_detail
+
+    # Header information of the metadata objects.
+    # @return [Object]
+    attr_accessor :metadata_header
+
+    # Visualization header information of the metadata objects.
+    # @return [Array[Object]]
+    attr_accessor :visualization_headers
+
+    # Stats of the metadata object. Includes views, favorites, last_accessed.
+    # @return [Object]
+    attr_accessor :stats
+
+    # 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['metadata_type'] = 'metadata_type'
+      @_hash['metadata_obj_id'] = 'metadata_obj_id'
+      @_hash['dependent_objects'] = 'dependent_objects'
+      @_hash['incomplete_objects'] = 'incomplete_objects'
+      @_hash['metadata_detail'] = 'metadata_detail'
+      @_hash['metadata_header'] = 'metadata_header'
+      @_hash['visualization_headers'] = 'visualization_headers'
+      @_hash['stats'] = 'stats'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata_id
+        metadata_name
+        metadata_obj_id
+        dependent_objects
+        incomplete_objects
+        metadata_detail
+        metadata_header
+        visualization_headers
+        stats
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata_id
+        metadata_name
+        metadata_obj_id
+        dependent_objects
+        incomplete_objects
+        metadata_detail
+        metadata_header
+        visualization_headers
+        stats
+      ]
+    end
+
+    def initialize(metadata_type:, metadata_id: SKIP, metadata_name: SKIP,
+                   metadata_obj_id: SKIP, dependent_objects: SKIP,
+                   incomplete_objects: SKIP, metadata_detail: SKIP,
+                   metadata_header: SKIP, visualization_headers: SKIP,
+                   stats: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_id = metadata_id unless metadata_id == SKIP
+      @metadata_name = metadata_name unless metadata_name == SKIP
+      @metadata_type = metadata_type
+      @metadata_obj_id = metadata_obj_id unless metadata_obj_id == SKIP
+      @dependent_objects = dependent_objects unless dependent_objects == SKIP
+      @incomplete_objects = incomplete_objects unless incomplete_objects == SKIP
+      @metadata_detail = metadata_detail unless metadata_detail == SKIP
+      @metadata_header = metadata_header unless metadata_header == SKIP
+      @visualization_headers = visualization_headers unless visualization_headers == SKIP
+      @stats = stats unless stats == 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.
+      metadata_type = hash.key?('metadata_type') ? hash['metadata_type'] : nil
+      metadata_id = hash.key?('metadata_id') ? hash['metadata_id'] : SKIP
+      metadata_name = hash.key?('metadata_name') ? hash['metadata_name'] : SKIP
+      metadata_obj_id =
+        hash.key?('metadata_obj_id') ? hash['metadata_obj_id'] : SKIP
+      dependent_objects =
+        hash.key?('dependent_objects') ? hash['dependent_objects'] : SKIP
+      incomplete_objects =
+        hash.key?('incomplete_objects') ? hash['incomplete_objects'] : SKIP
+      metadata_detail =
+        hash.key?('metadata_detail') ? hash['metadata_detail'] : SKIP
+      metadata_header =
+        hash.key?('metadata_header') ? hash['metadata_header'] : SKIP
+      visualization_headers =
+        hash.key?('visualization_headers') ? hash['visualization_headers'] : SKIP
+      stats = hash.key?('stats') ? hash['stats'] : 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.
+      MetadataSearchResponse.new(metadata_type: metadata_type,
+                                 metadata_id: metadata_id,
+                                 metadata_name: metadata_name,
+                                 metadata_obj_id: metadata_obj_id,
+                                 dependent_objects: dependent_objects,
+                                 incomplete_objects: incomplete_objects,
+                                 metadata_detail: metadata_detail,
+                                 metadata_header: metadata_header,
+                                 visualization_headers: visualization_headers,
+                                 stats: stats,
+                                 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},"\
+      " metadata_type: #{@metadata_type}, metadata_obj_id: #{@metadata_obj_id}, dependent_objects:"\
+      " #{@dependent_objects}, incomplete_objects: #{@incomplete_objects}, metadata_detail:"\
+      " #{@metadata_detail}, metadata_header: #{@metadata_header}, visualization_headers:"\
+      " #{@visualization_headers}, stats: #{@stats}, 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}, metadata_type: #{@metadata_type.inspect}, metadata_obj_id:"\
+      " #{@metadata_obj_id.inspect}, dependent_objects: #{@dependent_objects.inspect},"\
+      " incomplete_objects: #{@incomplete_objects.inspect}, metadata_detail:"\
+      " #{@metadata_detail.inspect}, metadata_header: #{@metadata_header.inspect},"\
+      " visualization_headers: #{@visualization_headers.inspect}, stats: #{@stats.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/metadata_search_sort_options.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
+  # Sort options.
+  class MetadataSearchSortOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the field to apply the sort on.
+    # @return [FieldName1]
+    attr_accessor :field_name
+
+    # Sort order : ASC(Ascending) or DESC(Descending).
+    # @return [Order]
+    attr_accessor :order
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field_name'] = 'field_name'
+      @_hash['order'] = 'order'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field_name
+        order
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        field_name
+        order
+      ]
+    end
+
+    def initialize(field_name: SKIP, order: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @field_name = field_name unless field_name == SKIP
+      @order = order unless order == 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.
+      field_name = hash.key?('field_name') ? hash['field_name'] : SKIP
+      order = hash.key?('order') ? hash['order'] : 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.
+      MetadataSearchSortOptions.new(field_name: field_name,
+                                    order: order,
+                                    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} field_name: #{@field_name}, order: #{@order}, 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} field_name: #{@field_name.inspect}, order: #{@order.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/metadata_type.rb

@@ -0,0 +1,68 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Type of the metadata.
+  class MetadataType
+    METADATA_TYPE = [
+      # TODO: Write general description for LIVEBOARD
+      LIVEBOARD = 'LIVEBOARD'.freeze,
+
+      # TODO: Write general description for ANSWER
+      ANSWER = 'ANSWER'.freeze,
+
+      # TODO: Write general description for LOGICAL_TABLE
+      LOGICAL_TABLE = 'LOGICAL_TABLE'.freeze,
+
+      # TODO: Write general description for LOGICAL_COLUMN
+      LOGICAL_COLUMN = 'LOGICAL_COLUMN'.freeze,
+
+      # TODO: Write general description for CONNECTION
+      CONNECTION = 'CONNECTION'.freeze,
+
+      # TODO: Write general description for TAG
+      TAG = 'TAG'.freeze,
+
+      # TODO: Write general description for USER
+      USER = 'USER'.freeze,
+
+      # TODO: Write general description for USER_GROUP
+      USER_GROUP = 'USER_GROUP'.freeze,
+
+      # TODO: Write general description for LOGICAL_RELATIONSHIP
+      LOGICAL_RELATIONSHIP = 'LOGICAL_RELATIONSHIP'.freeze,
+
+      # TODO: Write general description for INSIGHT_SPEC
+      INSIGHT_SPEC = 'INSIGHT_SPEC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = LIVEBOARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'liveboard' then LIVEBOARD
+      when 'answer' then ANSWER
+      when 'logical_table' then LOGICAL_TABLE
+      when 'logical_column' then LOGICAL_COLUMN
+      when 'connection' then CONNECTION
+      when 'tag' then TAG
+      when 'user' then USER
+      when 'user_group' then USER_GROUP
+      when 'logical_relationship' then LOGICAL_RELATIONSHIP
+      when 'insight_spec' then INSIGHT_SPEC
+      else
+        default_value
+      end
+    end
+  end
+end