ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/default_metadata_type.rb

@@ -0,0 +1,53 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # When no metadata objects input is passed, metadata objects of this type are
+  # fetched.
+  class DefaultMetadataType
+    DEFAULT_METADATA_TYPE = [
+      # TODO: Write general description for ALL
+      ALL = 'ALL'.freeze,
+
+      # 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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'all' then ALL
+      when 'liveboard' then LIVEBOARD
+      when 'answer' then ANSWER
+      when 'logical_table' then LOGICAL_TABLE
+      when 'logical_column' then LOGICAL_COLUMN
+      when 'connection' then CONNECTION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/delete_collection_request.rb

@@ -0,0 +1,103 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # DeleteCollectionRequest Model.
+  class DeleteCollectionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique GUIDs of collections to delete. Note: Collection names cannot be
+    # used as identifiers since duplicate names are allowed.
+    # @return [Array[String]]
+    attr_accessor :collection_identifiers
+
+    # Flag to delete child objects of the collection that the user has access
+    # to.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :delete_children
+
+    # Preview deletion without actually deleting. When set to true, returns
+    # what would be deleted without performing the actual deletion.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :dry_run
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['collection_identifiers'] = 'collection_identifiers'
+      @_hash['delete_children'] = 'delete_children'
+      @_hash['dry_run'] = 'dry_run'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        delete_children
+        dry_run
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        delete_children
+        dry_run
+      ]
+    end
+
+    def initialize(collection_identifiers:, delete_children: false,
+                   dry_run: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @collection_identifiers = collection_identifiers
+      @delete_children = delete_children unless delete_children == SKIP
+      @dry_run = dry_run unless dry_run == 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.
+      collection_identifiers =
+        hash.key?('collection_identifiers') ? hash['collection_identifiers'] : nil
+      delete_children = hash['delete_children'] ||= false
+      dry_run = hash['dry_run'] ||= 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.
+      DeleteCollectionRequest.new(collection_identifiers: collection_identifiers,
+                                  delete_children: delete_children,
+                                  dry_run: dry_run,
+                                  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} collection_identifiers: #{@collection_identifiers}, delete_children:"\
+      " #{@delete_children}, dry_run: #{@dry_run}, 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} collection_identifiers: #{@collection_identifiers.inspect},"\
+      " delete_children: #{@delete_children.inspect}, dry_run: #{@dry_run.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/delete_config_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
+  # DeleteConfigRequest Model.
+  class DeleteConfigRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Applicable when Orgs is enabled in the cluster
+    #    
+    # Indicator to consider cluster level or org level config. Set it to false
+    # to delete configuration from current org. If set to true, then the
+    # configuration at cluster level and orgs that inherited the configuration
+    # from cluster level will be deleted.  <br/>  <span
+    # class="since-beta-tag">Version: 9.5.0.cl or later</span>
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cluster_level
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cluster_level'] = 'cluster_level'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cluster_level
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cluster_level
+      ]
+    end
+
+    def initialize(cluster_level: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cluster_level = cluster_level unless cluster_level == 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.
+      cluster_level = hash.key?('cluster_level') ? hash['cluster_level'] : 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.
+      DeleteConfigRequest.new(cluster_level: cluster_level,
+                              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} cluster_level: #{@cluster_level}, 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} cluster_level: #{@cluster_level.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/delete_connection_configuration_request.rb

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

data/lib/thought_spot_public_rest_api/models/delete_connection_request.rb

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

data/lib/thought_spot_public_rest_api/models/delete_metadata_request.rb

@@ -0,0 +1,96 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # DeleteMetadataRequest Model.
+  class DeleteMetadataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Metadata objects.
+    # @return [Array[DeleteMetadataTypeInput]]
+    attr_accessor :metadata
+
+    # Indicates whether to delete disabled metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :delete_disabled_objects
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['delete_disabled_objects'] = 'delete_disabled_objects'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        delete_disabled_objects
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        delete_disabled_objects
+      ]
+    end
+
+    def initialize(metadata:, delete_disabled_objects: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @delete_disabled_objects = delete_disabled_objects unless delete_disabled_objects == 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 = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (DeleteMetadataTypeInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = nil unless hash.key?('metadata')
+      delete_disabled_objects = hash['delete_disabled_objects'] ||= 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.
+      DeleteMetadataRequest.new(metadata: metadata,
+                                delete_disabled_objects: delete_disabled_objects,
+                                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: #{@metadata}, delete_disabled_objects:"\
+      " #{@delete_disabled_objects}, 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: #{@metadata.inspect}, delete_disabled_objects:"\
+      " #{@delete_disabled_objects.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/delete_metadata_type_input.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
+  # MetadataType InputType used in Delete MetadataType API
+  class DeleteMetadataTypeInput < 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 [Type18]
+    attr_accessor :type
+
+    # Unique ID or name of the metadata object.
+    # @return [String]
+    attr_accessor :identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['identifier'] = 'identifier'
+      @_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?
+
+      @type = type unless type == SKIP
+      @identifier = identifier
+      @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.
+      DeleteMetadataTypeInput.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} type: #{@type}, identifier: #{@identifier}, 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/delete_org_email_customization_request.rb

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