ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/fetch_permissions_on_metadata_request.rb

@@ -0,0 +1,159 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # FetchPermissionsOnMetadataRequest Model.
+  class FetchPermissionsOnMetadataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID or name of the metadata object.
+    # @return [Array[PermissionsMetadataTypeInput]]
+    attr_accessor :metadata
+
+    # User or group objects for which you want to fetch permissions.
+    # If not specified, the API returns all users and groups that
+    # can access the specified metadata objects.
+    # @return [Array[PrincipalsInput]]
+    attr_accessor :principals
+
+    # Indicates whether to fetch permissions of dependent metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_dependent_objects
+
+    # The starting record number from where the records should be included for
+    # each metadata type.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records that should be included for each metadata type.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # <div><span class="since-beta-tag">Version: 10.3.0.cl or later</span></div>
+    # Specifies the type of permission. Valid values are:
+    #     EFFECTIVE - If the user permission to the metadata objects is granted
+    # by the privileges assigned to the groups to which they belong.
+    #     DEFINED - If a user or user group received access to metadata objects
+    # via object sharing by another user.
+    # @return [String]
+    attr_accessor :permission_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['principals'] = 'principals'
+      @_hash['include_dependent_objects'] = 'include_dependent_objects'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['permission_type'] = 'permission_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        principals
+        include_dependent_objects
+        record_offset
+        record_size
+        permission_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        include_dependent_objects
+      ]
+    end
+
+    def initialize(metadata:, principals: SKIP,
+                   include_dependent_objects: false, record_offset: 0,
+                   record_size: -1, permission_type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @principals = principals unless principals == SKIP
+      unless include_dependent_objects == SKIP
+        @include_dependent_objects =
+          include_dependent_objects
+      end
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == SKIP
+      @permission_type = permission_type unless permission_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.
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (PermissionsMetadataTypeInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = nil unless hash.key?('metadata')
+      # Parameter is an array, so we need to iterate through it
+      principals = nil
+      unless hash['principals'].nil?
+        principals = []
+        hash['principals'].each do |structure|
+          principals << (PrincipalsInput.from_hash(structure) if structure)
+        end
+      end
+
+      principals = SKIP unless hash.key?('principals')
+      include_dependent_objects = hash['include_dependent_objects'] ||= false
+      record_offset = hash['record_offset'] ||= 0
+      record_size = hash['record_size'] ||= -1
+      permission_type =
+        hash.key?('permission_type') ? hash['permission_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.
+      FetchPermissionsOnMetadataRequest.new(metadata: metadata,
+                                            principals: principals,
+                                            include_dependent_objects: include_dependent_objects,
+                                            record_offset: record_offset,
+                                            record_size: record_size,
+                                            permission_type: permission_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: #{@metadata}, principals: #{@principals},"\
+      " include_dependent_objects: #{@include_dependent_objects}, record_offset:"\
+      " #{@record_offset}, record_size: #{@record_size}, permission_type: #{@permission_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} metadata: #{@metadata.inspect}, principals: #{@principals.inspect},"\
+      " include_dependent_objects: #{@include_dependent_objects.inspect}, record_offset:"\
+      " #{@record_offset.inspect}, record_size: #{@record_size.inspect}, permission_type:"\
+      " #{@permission_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/field_name.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
+  # Name of the field to apply the sort on.
+  class FieldName
+    FIELD_NAME = [
+      # TODO: Write general description for NAME
+      NAME = 'NAME'.freeze,
+
+      # TODO: Write general description for DISPLAY_NAME
+      DISPLAY_NAME = 'DISPLAY_NAME'.freeze,
+
+      # TODO: Write general description for AUTHOR
+      AUTHOR = 'AUTHOR'.freeze,
+
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for MODIFIED
+      MODIFIED = 'MODIFIED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = NAME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'name' then NAME
+      when 'display_name' then DISPLAY_NAME
+      when 'author' then AUTHOR
+      when 'created' then CREATED
+      when 'modified' then MODIFIED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/field_name1.rb

@@ -0,0 +1,60 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Name of the field to apply the sort on.
+  class FieldName1
+    FIELD_NAME1 = [
+      # TODO: Write general description for NAME
+      NAME = 'NAME'.freeze,
+
+      # TODO: Write general description for DISPLAY_NAME
+      DISPLAY_NAME = 'DISPLAY_NAME'.freeze,
+
+      # TODO: Write general description for AUTHOR
+      AUTHOR = 'AUTHOR'.freeze,
+
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for MODIFIED
+      MODIFIED = 'MODIFIED'.freeze,
+
+      # TODO: Write general description for VIEWS
+      VIEWS = 'VIEWS'.freeze,
+
+      # TODO: Write general description for FAVORITES
+      FAVORITES = 'FAVORITES'.freeze,
+
+      # TODO: Write general description for LAST_ACCESSED
+      LAST_ACCESSED = 'LAST_ACCESSED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = NAME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'name' then NAME
+      when 'display_name' then DISPLAY_NAME
+      when 'author' then AUTHOR
+      when 'created' then CREATED
+      when 'modified' then MODIFIED
+      when 'views' then VIEWS
+      when 'favorites' then FAVORITES
+      when 'last_accessed' then LAST_ACCESSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/field_name2.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
+  # Name of the field to apply the sort on.
+  class FieldName2
+    FIELD_NAME2 = [
+      # TODO: Write general description for NAME
+      NAME = 'NAME'.freeze,
+
+      # TODO: Write general description for DISPLAY_NAME
+      DISPLAY_NAME = 'DISPLAY_NAME'.freeze,
+
+      # TODO: Write general description for AUTHOR
+      AUTHOR = 'AUTHOR'.freeze,
+
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for MODIFIED
+      MODIFIED = 'MODIFIED'.freeze,
+
+      # TODO: Write general description for LAST_ACCESSED
+      LAST_ACCESSED = 'LAST_ACCESSED'.freeze,
+
+      # TODO: Write general description for SYNCED
+      SYNCED = 'SYNCED'.freeze,
+
+      # TODO: Write general description for VIEWS
+      VIEWS = 'VIEWS'.freeze,
+
+      # TODO: Write general description for USER_STATE
+      USER_STATE = 'USER_STATE'.freeze,
+
+      # TODO: Write general description for ROW_COUNT
+      ROW_COUNT = 'ROW_COUNT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = NAME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'name' then NAME
+      when 'display_name' then DISPLAY_NAME
+      when 'author' then AUTHOR
+      when 'created' then CREATED
+      when 'modified' then MODIFIED
+      when 'last_accessed' then LAST_ACCESSED
+      when 'synced' then SYNCED
+      when 'views' then VIEWS
+      when 'user_state' then USER_STATE
+      when 'row_count' then ROW_COUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/field_name3.rb

@@ -0,0 +1,52 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Name of the field to apply the sort on.
+  class FieldName3
+    FIELD_NAME3 = [
+      # TODO: Write general description for DEFAULT
+      DEFAULT = 'DEFAULT'.freeze,
+
+      # TODO: Write general description for NAME
+      NAME = 'NAME'.freeze,
+
+      # TODO: Write general description for DISPLAY_NAME
+      DISPLAY_NAME = 'DISPLAY_NAME'.freeze,
+
+      # TODO: Write general description for AUTHOR
+      AUTHOR = 'AUTHOR'.freeze,
+
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for MODIFIED
+      MODIFIED = 'MODIFIED'.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 'name' then NAME
+      when 'display_name' then DISPLAY_NAME
+      when 'author' then AUTHOR
+      when 'created' then CREATED
+      when 'modified' then MODIFIED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/field_name4.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
+  # Name of the field to apply the sort on.
+  class FieldName4
+    FIELD_NAME4 = [
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for MODIFIED
+      MODIFIED = 'MODIFIED'.freeze,
+
+      # TODO: Write general description for NAME
+      NAME = 'NAME'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created' then CREATED
+      when 'modified' then MODIFIED
+      when 'name' then NAME
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/field_type.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 field in the metadata to parameterize.
+  class FieldType
+    FIELD_TYPE = [
+      # TODO: Write general description for ATTRIBUTE
+      ATTRIBUTE = 'ATTRIBUTE'.freeze,
+
+      # TODO: Write general description for CONNECTION_PROPERTY
+      CONNECTION_PROPERTY = 'CONNECTION_PROPERTY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ATTRIBUTE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'attribute' then ATTRIBUTE
+      when 'connection_property' then CONNECTION_PROPERTY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/field_type1.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 field in the metadata to unparameterize.
+  class FieldType1
+    FIELD_TYPE1 = [
+      # TODO: Write general description for ATTRIBUTE
+      ATTRIBUTE = 'ATTRIBUTE'.freeze,
+
+      # TODO: Write general description for CONNECTION_PROPERTY
+      CONNECTION_PROPERTY = 'CONNECTION_PROPERTY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ATTRIBUTE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'attribute' then ATTRIBUTE
+      when 'connection_property' then CONNECTION_PROPERTY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/file_format.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
+  # Export file format.
+  class FileFormat
+    FILE_FORMAT = [
+      # TODO: Write general description for CSV
+      CSV = 'CSV'.freeze,
+
+      # TODO: Write general description for PDF
+      PDF = 'PDF'.freeze,
+
+      # TODO: Write general description for XLSX
+      XLSX = 'XLSX'.freeze,
+
+      # TODO: Write general description for PNG
+      PNG = 'PNG'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CSV)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'csv' then CSV
+      when 'pdf' then PDF
+      when 'xlsx' then XLSX
+      when 'png' then PNG
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/file_format2.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
+  # Export file format.
+  class FileFormat2
+    FILE_FORMAT2 = [
+      # TODO: Write general description for CSV
+      CSV = 'CSV'.freeze,
+
+      # TODO: Write general description for PDF
+      PDF = 'PDF'.freeze,
+
+      # TODO: Write general description for XLSX
+      XLSX = 'XLSX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CSV)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'csv' then CSV
+      when 'pdf' then PDF
+      when 'xlsx' then XLSX
+      else
+        default_value
+      end
+    end
+  end
+end