ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/type31.rb

@@ -0,0 +1,44 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Type of the group
+  class Type31
+    TYPE31 = [
+      # TODO: Write general description for LOCAL_GROUP
+      LOCAL_GROUP = 'LOCAL_GROUP'.freeze,
+
+      # TODO: Write general description for LDAP_GROUP
+      LDAP_GROUP = 'LDAP_GROUP'.freeze,
+
+      # TODO: Write general description for TEAM_GROUP
+      TEAM_GROUP = 'TEAM_GROUP'.freeze,
+
+      # TODO: Write general description for TENANT_GROUP
+      TENANT_GROUP = 'TENANT_GROUP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = LOCAL_GROUP)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'local_group' then LOCAL_GROUP
+      when 'ldap_group' then LDAP_GROUP
+      when 'team_group' then TEAM_GROUP
+      when 'tenant_group' then TENANT_GROUP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/type32.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
+  # Type of metadata object
+  class Type32
+    TYPE32 = [
+      # TODO: Write general description for LIVEBOARD
+      LIVEBOARD = 'LIVEBOARD'.freeze,
+
+      # TODO: Write general description for ANSWER
+      ANSWER = 'ANSWER'.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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/type4.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
+  # Principal type.
+  class Type4
+    TYPE4 = [
+      # TODO: Write general description for USER
+      USER = 'USER'.freeze,
+
+      # TODO: Write general description for USER_GROUP
+      USER_GROUP = 'USER_GROUP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = USER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'user' then USER
+      when 'user_group' then USER_GROUP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/type5.rb

@@ -0,0 +1,76 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # 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 connection objects 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
+  class Type5
+    TYPE5 = [
+      # 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

data/lib/thought_spot_public_rest_api/models/type6.rb

@@ -0,0 +1,28 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # 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.
+  class Type6
+    TYPE6 = [
+      # TODO: Write general description for LOGICAL_TABLE
+      LOGICAL_TABLE = 'LOGICAL_TABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = LOGICAL_TABLE)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/type7.rb

@@ -0,0 +1,50 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # 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.
+  class Type7
+    TYPE7 = [
+      # 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 = 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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/type8.rb

@@ -0,0 +1,42 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # 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.
+  class Type8
+    TYPE8 = [
+      # TODO: Write general description for VISUALIZATION
+      VISUALIZATION = 'VISUALIZATION'.freeze,
+
+      # TODO: Write general description for ANSWER
+      ANSWER = 'ANSWER'.freeze,
+
+      # TODO: Write general description for WORKSHEET
+      WORKSHEET = 'WORKSHEET'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VISUALIZATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'visualization' then VISUALIZATION
+      when 'answer' then ANSWER
+      when 'worksheet' then WORKSHEET
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/type9.rb

@@ -0,0 +1,48 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Type of variable
+  class Type9
+    TYPE9 = [
+      # TODO: Write general description for CONNECTION_PROPERTY
+      CONNECTION_PROPERTY = 'CONNECTION_PROPERTY'.freeze,
+
+      # TODO: Write general description for TABLE_MAPPING
+      TABLE_MAPPING = 'TABLE_MAPPING'.freeze,
+
+      # TODO: Write general description for CONNECTION_PROPERTY_PER_PRINCIPAL
+      CONNECTION_PROPERTY_PER_PRINCIPAL = 'CONNECTION_PROPERTY_PER_PRINCIPAL'.freeze,
+
+      # TODO: Write general description for FORMULA_VARIABLE
+      FORMULA_VARIABLE = 'FORMULA_VARIABLE'.freeze,
+
+      # TODO: Write general description for USER_PROPERTY
+      USER_PROPERTY = 'USER_PROPERTY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONNECTION_PROPERTY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'connection_property' then CONNECTION_PROPERTY
+      when 'table_mapping' then TABLE_MAPPING
+      when 'connection_property_per_principal' then CONNECTION_PROPERTY_PER_PRINCIPAL
+      when 'formula_variable' then FORMULA_VARIABLE
+      when 'user_property' then USER_PROPERTY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/unassign_tag_request.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
+  # UnassignTagRequest Model.
+  class UnassignTagRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Metadata objects.
+    # @return [Array[TagMetadataTypeInput]]
+    attr_accessor :metadata
+
+    # GUID or name of the tag.
+    # @return [Array[String]]
+    attr_accessor :tag_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['tag_identifiers'] = 'tag_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata:, tag_identifiers:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @tag_identifiers = tag_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.
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (TagMetadataTypeInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = nil unless hash.key?('metadata')
+      tag_identifiers =
+        hash.key?('tag_identifiers') ? hash['tag_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.
+      UnassignTagRequest.new(metadata: metadata,
+                             tag_identifiers: tag_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} metadata: #{@metadata}, tag_identifiers: #{@tag_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} metadata: #{@metadata.inspect}, tag_identifiers:"\
+      " #{@tag_identifiers.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/unparameterize_metadata_request.rb

@@ -0,0 +1,113 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UnparameterizeMetadataRequest Model.
+  class UnparameterizeMetadataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of metadata object to unparameterize.
+    # @return [MetadataType4]
+    attr_accessor :metadata_type
+
+    # Unique ID or name of the metadata object to unparameterize.
+    # @return [String]
+    attr_accessor :metadata_identifier
+
+    # Type of field in the metadata to unparameterize.
+    # @return [FieldType1]
+    attr_accessor :field_type
+
+    # Name of the field which needs to be unparameterized.
+    # @return [String]
+    attr_accessor :field_name
+
+    # The value to use in place of the variable for the field
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_type'] = 'metadata_type'
+      @_hash['metadata_identifier'] = 'metadata_identifier'
+      @_hash['field_type'] = 'field_type'
+      @_hash['field_name'] = 'field_name'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata_identifier:, field_type:, field_name:, value:,
+                   metadata_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_type = metadata_type unless metadata_type == SKIP
+      @metadata_identifier = metadata_identifier
+      @field_type = field_type
+      @field_name = field_name
+      @value = value
+      @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_identifier =
+        hash.key?('metadata_identifier') ? hash['metadata_identifier'] : nil
+      field_type = hash.key?('field_type') ? hash['field_type'] : nil
+      field_name = hash.key?('field_name') ? hash['field_name'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+      metadata_type = hash.key?('metadata_type') ? hash['metadata_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.
+      UnparameterizeMetadataRequest.new(metadata_identifier: metadata_identifier,
+                                        field_type: field_type,
+                                        field_name: field_name,
+                                        value: value,
+                                        metadata_type: metadata_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} metadata_type: #{@metadata_type}, metadata_identifier:"\
+      " #{@metadata_identifier}, field_type: #{@field_type}, field_name: #{@field_name}, value:"\
+      " #{@value}, 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_type: #{@metadata_type.inspect}, metadata_identifier:"\
+      " #{@metadata_identifier.inspect}, field_type: #{@field_type.inspect}, field_name:"\
+      " #{@field_name.inspect}, value: #{@value.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/unpublish_metadata_request.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
+  # UnpublishMetadataRequest Model.
+  class UnpublishMetadataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Force unpublishes the object. This will break all the dependent objects in
+    # the unpublished orgs.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :force
+
+    # Should we unpublish all the dependencies for the objects specified.
+    # The dependencies will be unpublished if no other published object is using
+    # it.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_dependencies
+
+    # Metadata objects.
+    # @return [Array[PublishMetadataListItem]]
+    attr_accessor :metadata
+
+    # Unique ID or name of orgs.
+    # @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['force'] = 'force'
+      @_hash['include_dependencies'] = 'include_dependencies'
+      @_hash['metadata'] = 'metadata'
+      @_hash['org_identifiers'] = 'org_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        force
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        force
+      ]
+    end
+
+    def initialize(include_dependencies:, metadata:, org_identifiers:,
+                   force: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @force = force unless force == SKIP
+      @include_dependencies = include_dependencies
+      @metadata = metadata
+      @org_identifiers = org_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.
+      include_dependencies =
+        hash.key?('include_dependencies') ? hash['include_dependencies'] : nil
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (PublishMetadataListItem.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = nil unless hash.key?('metadata')
+      org_identifiers =
+        hash.key?('org_identifiers') ? hash['org_identifiers'] : nil
+      force = hash.key?('force') ? hash['force'] : 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.
+      UnpublishMetadataRequest.new(include_dependencies: include_dependencies,
+                                   metadata: metadata,
+                                   org_identifiers: org_identifiers,
+                                   force: force,
+                                   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} force: #{@force}, include_dependencies: #{@include_dependencies}, metadata:"\
+      " #{@metadata}, 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} force: #{@force.inspect}, include_dependencies:"\
+      " #{@include_dependencies.inspect}, metadata: #{@metadata.inspect}, org_identifiers:"\
+      " #{@org_identifiers.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end