ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/collection_delete_response.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
+  # Response object for delete collection operation.
+  class CollectionDeleteResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of metadata objects that were successfully deleted.
+    # @return [Array[CollectionDeleteTypeIdentifiers]]
+    attr_accessor :metadata_deleted
+
+    # List of metadata objects that were skipped during deletion.
+    # Objects may be skipped due to lack of permissions, dependencies, or other
+    # constraints.
+    # @return [Array[CollectionDeleteTypeIdentifiers]]
+    attr_accessor :metadata_skipped
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_deleted'] = 'metadata_deleted'
+      @_hash['metadata_skipped'] = 'metadata_skipped'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata_deleted
+        metadata_skipped
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata_deleted
+        metadata_skipped
+      ]
+    end
+
+    def initialize(metadata_deleted: SKIP, metadata_skipped: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_deleted = metadata_deleted unless metadata_deleted == SKIP
+      @metadata_skipped = metadata_skipped unless metadata_skipped == 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.
+      # Parameter is an array, so we need to iterate through it
+      metadata_deleted = nil
+      unless hash['metadata_deleted'].nil?
+        metadata_deleted = []
+        hash['metadata_deleted'].each do |structure|
+          metadata_deleted << (CollectionDeleteTypeIdentifiers.from_hash(structure) if structure)
+        end
+      end
+
+      metadata_deleted = SKIP unless hash.key?('metadata_deleted')
+      # Parameter is an array, so we need to iterate through it
+      metadata_skipped = nil
+      unless hash['metadata_skipped'].nil?
+        metadata_skipped = []
+        hash['metadata_skipped'].each do |structure|
+          metadata_skipped << (CollectionDeleteTypeIdentifiers.from_hash(structure) if structure)
+        end
+      end
+
+      metadata_skipped = SKIP unless hash.key?('metadata_skipped')
+
+      # 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.
+      CollectionDeleteResponse.new(metadata_deleted: metadata_deleted,
+                                   metadata_skipped: metadata_skipped,
+                                   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_deleted: #{@metadata_deleted}, metadata_skipped:"\
+      " #{@metadata_skipped}, 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_deleted: #{@metadata_deleted.inspect}, metadata_skipped:"\
+      " #{@metadata_skipped.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/collection_delete_type_identifiers.rb

@@ -0,0 +1,97 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Group of metadata objects identified by type.
+  class CollectionDeleteTypeIdentifiers < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of the metadata object (e.g., Collection, Worksheet, Table).
+    # @return [String]
+    attr_accessor :type
+
+    # List of metadata identifiers belonging to the given type.
+    # @return [Array[GenericInfo]]
+    attr_accessor :identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['identifiers'] = 'identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        identifiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        identifiers
+      ]
+    end
+
+    def initialize(type: SKIP, identifiers: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @identifiers = identifiers unless 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      identifiers = nil
+      unless hash['identifiers'].nil?
+        identifiers = []
+        hash['identifiers'].each do |structure|
+          identifiers << (GenericInfo.from_hash(structure) if structure)
+        end
+      end
+
+      identifiers = SKIP unless hash.key?('identifiers')
+
+      # 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.
+      CollectionDeleteTypeIdentifiers.new(type: type,
+                                          identifiers: 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} type: #{@type}, identifiers: #{@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} type: #{@type.inspect}, identifiers: #{@identifiers.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/collection_entity_identifier.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
+  # Entity identifier with name.
+  class CollectionEntityIdentifier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the entity.
+    # @return [String]
+    attr_accessor :identifier
+
+    # Name of the entity.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identifier'] = 'identifier'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        identifier
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        identifier
+        name
+      ]
+    end
+
+    def initialize(identifier: SKIP, name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @identifier = identifier unless identifier == SKIP
+      @name = name unless name == 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
+      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.
+      CollectionEntityIdentifier.new(identifier: identifier,
+                                     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} identifier: #{@identifier}, name: #{@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} identifier: #{@identifier.inspect}, name: #{@name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/collection_metadata_input.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
+  # Input type for metadata to be added to a collection.
+  class CollectionMetadataInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of metadata object.
+    # @return [Type27]
+    attr_accessor :type
+
+    # List of unique IDs or names of metadata objects.
+    # @return [Array[String]]
+    attr_accessor :identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['identifiers'] = 'identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, identifiers:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @identifiers = identifiers
+      @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'] : nil
+      identifiers = hash.key?('identifiers') ? hash['identifiers'] : 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.
+      CollectionMetadataInput.new(type: type,
+                                  identifiers: 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} type: #{@type}, identifiers: #{@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} type: #{@type.inspect}, identifiers: #{@identifiers.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/collection_metadata_item.rb

@@ -0,0 +1,97 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Metadata item in a collection response.
+  class CollectionMetadataItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of the metadata object.
+    # @return [String]
+    attr_accessor :type
+
+    # List of identifiers for this metadata type.
+    # @return [Array[CollectionEntityIdentifier]]
+    attr_accessor :identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['identifiers'] = 'identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        identifiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        identifiers
+      ]
+    end
+
+    def initialize(type: SKIP, identifiers: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @identifiers = identifiers unless 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      identifiers = nil
+      unless hash['identifiers'].nil?
+        identifiers = []
+        hash['identifiers'].each do |structure|
+          identifiers << (CollectionEntityIdentifier.from_hash(structure) if structure)
+        end
+      end
+
+      identifiers = SKIP unless hash.key?('identifiers')
+
+      # 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.
+      CollectionMetadataItem.new(type: type,
+                                 identifiers: 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} type: #{@type}, identifiers: #{@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} type: #{@type.inspect}, identifiers: #{@identifiers.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/collection_search_response.rb

@@ -0,0 +1,129 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Response object for search collections operation.
+  class CollectionSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of collections matching the search criteria.
+    # @return [Array[Collection]]
+    attr_accessor :collections
+
+    # The starting record number from where the records are included.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records returned.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # Indicates if this is the last batch of results.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_last_batch
+
+    # Total count of records returned.
+    # @return [Integer]
+    attr_accessor :count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['collections'] = 'collections'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['is_last_batch'] = 'is_last_batch'
+      @_hash['count'] = 'count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        record_offset
+        record_size
+        is_last_batch
+        count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        record_offset
+        record_size
+        is_last_batch
+        count
+      ]
+    end
+
+    def initialize(collections:, record_offset: SKIP, record_size: SKIP,
+                   is_last_batch: SKIP, count: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @collections = collections
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == SKIP
+      @is_last_batch = is_last_batch unless is_last_batch == SKIP
+      @count = count unless count == 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.
+      # Parameter is an array, so we need to iterate through it
+      collections = nil
+      unless hash['collections'].nil?
+        collections = []
+        hash['collections'].each do |structure|
+          collections << (Collection.from_hash(structure) if structure)
+        end
+      end
+
+      collections = nil unless hash.key?('collections')
+      record_offset = hash.key?('record_offset') ? hash['record_offset'] : SKIP
+      record_size = hash.key?('record_size') ? hash['record_size'] : SKIP
+      is_last_batch = hash.key?('is_last_batch') ? hash['is_last_batch'] : SKIP
+      count = hash.key?('count') ? hash['count'] : 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.
+      CollectionSearchResponse.new(collections: collections,
+                                   record_offset: record_offset,
+                                   record_size: record_size,
+                                   is_last_batch: is_last_batch,
+                                   count: count,
+                                   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} collections: #{@collections}, record_offset: #{@record_offset},"\
+      " record_size: #{@record_size}, is_last_batch: #{@is_last_batch}, count: #{@count},"\
+      " 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} collections: #{@collections.inspect}, record_offset:"\
+      " #{@record_offset.inspect}, record_size: #{@record_size.inspect}, is_last_batch:"\
+      " #{@is_last_batch.inspect}, count: #{@count.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end