ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/channel_validation_aws_s3_info.rb

@@ -0,0 +1,99 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # AWS S3 storage information returned from a validation step.
+  class ChannelValidationAwsS3Info < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the S3 bucket.
+    # @return [String]
+    attr_accessor :bucket_name
+
+    # Name of the uploaded file.
+    # @return [String]
+    attr_accessor :file_name
+
+    # Key of the object in S3 storage.
+    # @return [String]
+    attr_accessor :object_key
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bucket_name'] = 'bucket_name'
+      @_hash['file_name'] = 'file_name'
+      @_hash['object_key'] = 'object_key'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bucket_name
+        file_name
+        object_key
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        bucket_name
+        file_name
+        object_key
+      ]
+    end
+
+    def initialize(bucket_name: SKIP, file_name: SKIP, object_key: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bucket_name = bucket_name unless bucket_name == SKIP
+      @file_name = file_name unless file_name == SKIP
+      @object_key = object_key unless object_key == 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.
+      bucket_name = hash.key?('bucket_name') ? hash['bucket_name'] : SKIP
+      file_name = hash.key?('file_name') ? hash['file_name'] : SKIP
+      object_key = hash.key?('object_key') ? hash['object_key'] : 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.
+      ChannelValidationAwsS3Info.new(bucket_name: bucket_name,
+                                     file_name: file_name,
+                                     object_key: object_key,
+                                     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} bucket_name: #{@bucket_name}, file_name: #{@file_name}, object_key:"\
+      " #{@object_key}, 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} bucket_name: #{@bucket_name.inspect}, file_name: #{@file_name.inspect},"\
+      " object_key: #{@object_key.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/channel_validation_detail.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
+  # Validation detail result for a sub-step.
+  class ChannelValidationDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The validation step that was performed.
+    # @return [ValidationStep]
+    attr_accessor :validation_step
+
+    # Status of this validation step.
+    # @return [Status2]
+    attr_accessor :status
+
+    # HTTP status code returned by the channel (if applicable).
+    # @return [Integer]
+    attr_accessor :http_status
+
+    # Error message from the channel or validation process.
+    # @return [String]
+    attr_accessor :error_message
+
+    # AWS S3 storage information returned from a validation step.
+    # @return [ChannelValidationAwsS3Info]
+    attr_accessor :aws_s3_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['validation_step'] = 'validation_step'
+      @_hash['status'] = 'status'
+      @_hash['http_status'] = 'http_status'
+      @_hash['error_message'] = 'error_message'
+      @_hash['aws_s3_info'] = 'aws_s3_info'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        http_status
+        error_message
+        aws_s3_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        http_status
+        error_message
+      ]
+    end
+
+    def initialize(validation_step:, status:, http_status: SKIP,
+                   error_message: SKIP, aws_s3_info: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @validation_step = validation_step
+      @status = status
+      @http_status = http_status unless http_status == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @aws_s3_info = aws_s3_info unless aws_s3_info == 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.
+      validation_step =
+        hash.key?('validation_step') ? hash['validation_step'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      http_status = hash.key?('http_status') ? hash['http_status'] : SKIP
+      error_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+      aws_s3_info = ChannelValidationAwsS3Info.from_hash(hash['aws_s3_info']) if
+        hash['aws_s3_info']
+
+      # 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.
+      ChannelValidationDetail.new(validation_step: validation_step,
+                                  status: status,
+                                  http_status: http_status,
+                                  error_message: error_message,
+                                  aws_s3_info: aws_s3_info,
+                                  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} validation_step: #{@validation_step}, status: #{@status}, http_status:"\
+      " #{@http_status}, error_message: #{@error_message}, aws_s3_info: #{@aws_s3_info},"\
+      " 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} validation_step: #{@validation_step.inspect}, status: #{@status.inspect},"\
+      " http_status: #{@http_status.inspect}, error_message: #{@error_message.inspect},"\
+      " aws_s3_info: #{@aws_s3_info.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/cluster_non_embed_access.rb

@@ -0,0 +1,102 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Cluster-level non-embed access configuration.
+  class ClusterNonEmbedAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Block full application access for non-embedded usage.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :block_full_app_access
+
+    # Groups that have non-embed full app access.
+    # Only applicable when orgs feature is disabled. Use org_preferences when
+    # org feature is enabled.
+    # @return [Array[GroupInfo]]
+    attr_accessor :groups_with_access
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['block_full_app_access'] = 'block_full_app_access'
+      @_hash['groups_with_access'] = 'groups_with_access'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        block_full_app_access
+        groups_with_access
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        block_full_app_access
+        groups_with_access
+      ]
+    end
+
+    def initialize(block_full_app_access: SKIP, groups_with_access: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @block_full_app_access = block_full_app_access unless block_full_app_access == SKIP
+      @groups_with_access = groups_with_access unless groups_with_access == 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.
+      block_full_app_access =
+        hash.key?('block_full_app_access') ? hash['block_full_app_access'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      groups_with_access = nil
+      unless hash['groups_with_access'].nil?
+        groups_with_access = []
+        hash['groups_with_access'].each do |structure|
+          groups_with_access << (GroupInfo.from_hash(structure) if structure)
+        end
+      end
+
+      groups_with_access = SKIP unless hash.key?('groups_with_access')
+
+      # 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.
+      ClusterNonEmbedAccess.new(block_full_app_access: block_full_app_access,
+                                groups_with_access: groups_with_access,
+                                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} block_full_app_access: #{@block_full_app_access}, groups_with_access:"\
+      " #{@groups_with_access}, 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} block_full_app_access: #{@block_full_app_access.inspect},"\
+      " groups_with_access: #{@groups_with_access.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/cluster_non_embed_access_input.rb

@@ -0,0 +1,100 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Input for cluster-level non-embed access configuration.
+  class ClusterNonEmbedAccessInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Block full application access for non-embedded usage.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :block_full_app_access
+
+    # Group identifiers that are allowed non-embed full app access.
+    # Can only be set when orgs feature is disabled and block_full_app_access is
+    # true.
+    # @return [Array[String]]
+    attr_accessor :groups_identifiers_with_access
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['block_full_app_access'] = 'block_full_app_access'
+      @_hash['groups_identifiers_with_access'] =
+        'groups_identifiers_with_access'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        block_full_app_access
+        groups_identifiers_with_access
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        block_full_app_access
+        groups_identifiers_with_access
+      ]
+    end
+
+    def initialize(block_full_app_access: SKIP,
+                   groups_identifiers_with_access: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @block_full_app_access = block_full_app_access unless block_full_app_access == SKIP
+      unless groups_identifiers_with_access == SKIP
+        @groups_identifiers_with_access =
+          groups_identifiers_with_access
+      end
+      @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.
+      block_full_app_access =
+        hash.key?('block_full_app_access') ? hash['block_full_app_access'] : SKIP
+      groups_identifiers_with_access =
+        hash.key?('groups_identifiers_with_access') ? hash['groups_identifiers_with_access'] : 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.
+      ClusterNonEmbedAccessInput.new(block_full_app_access: block_full_app_access,
+                                     groups_identifiers_with_access: groups_identifiers_with_access,
+                                     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} block_full_app_access: #{@block_full_app_access},"\
+      " groups_identifiers_with_access: #{@groups_identifiers_with_access}, 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} block_full_app_access: #{@block_full_app_access.inspect},"\
+      " groups_identifiers_with_access: #{@groups_identifiers_with_access.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/cluster_preference.rb

@@ -0,0 +1,26 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ClusterPreference.
+  class ClusterPreference
+    CLUSTER_PREFERENCE = [
+      # TODO: Write general description for LIVEBOARD_SCHEDULE
+      LIVEBOARD_SCHEDULE = 'LIVEBOARD_SCHEDULE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = LIVEBOARD_SCHEDULE)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/cluster_type.rb

@@ -0,0 +1,37 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # The type of ThoughtSpot cluster deployment. Determines which authentication
+  # method is used for S3 access. Example: "AWS" or "GCP"
+  class ClusterType
+    CLUSTER_TYPE = [
+      # TODO: Write general description for AWS
+      AWS = 'AWS'.freeze,
+
+      # TODO: Write general description for GCP
+      GCP = 'GCP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AWS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'aws' then AWS
+      when 'gcp' then GCP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/collection.rb

@@ -0,0 +1,169 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Response object for a collection.
+  class Collection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the collection.
+    # @return [String]
+    attr_accessor :id
+
+    # Name of the collection.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the collection.
+    # @return [String]
+    attr_accessor :description
+
+    # Metadata objects in the collection.
+    # @return [Array[CollectionMetadataItem]]
+    attr_accessor :metadata
+
+    # Creation timestamp in milliseconds.
+    # @return [String]
+    attr_accessor :created_at
+
+    # Last updated timestamp in milliseconds.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # Name of the author who created the collection.
+    # @return [String]
+    attr_accessor :author_name
+
+    # Unique identifier of the author.
+    # @return [String]
+    attr_accessor :author_id
+
+    # Entity identifier with name.
+    # @return [CollectionEntityIdentifier]
+    attr_accessor :org
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['metadata'] = 'metadata'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['author_name'] = 'author_name'
+      @_hash['author_id'] = 'author_id'
+      @_hash['org'] = 'org'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        metadata
+        created_at
+        updated_at
+        author_name
+        author_id
+        org
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        metadata
+        created_at
+        updated_at
+        author_name
+        author_id
+      ]
+    end
+
+    def initialize(id:, name:, description: SKIP, metadata: SKIP,
+                   created_at: SKIP, updated_at: SKIP, author_name: SKIP,
+                   author_id: SKIP, org: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @name = name
+      @description = description unless description == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @author_name = author_name unless author_name == SKIP
+      @author_id = author_id unless author_id == SKIP
+      @org = org unless org == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (CollectionMetadataItem.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = SKIP unless hash.key?('metadata')
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      author_name = hash.key?('author_name') ? hash['author_name'] : SKIP
+      author_id = hash.key?('author_id') ? hash['author_id'] : SKIP
+      org = CollectionEntityIdentifier.from_hash(hash['org']) if hash['org']
+
+      # 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.
+      Collection.new(id: id,
+                     name: name,
+                     description: description,
+                     metadata: metadata,
+                     created_at: created_at,
+                     updated_at: updated_at,
+                     author_name: author_name,
+                     author_id: author_id,
+                     org: org,
+                     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} id: #{@id}, name: #{@name}, description: #{@description}, metadata:"\
+      " #{@metadata}, created_at: #{@created_at}, updated_at: #{@updated_at}, author_name:"\
+      " #{@author_name}, author_id: #{@author_id}, org: #{@org}, 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} id: #{@id.inspect}, name: #{@name.inspect}, description:"\
+      " #{@description.inspect}, metadata: #{@metadata.inspect}, created_at:"\
+      " #{@created_at.inspect}, updated_at: #{@updated_at.inspect}, author_name:"\
+      " #{@author_name.inspect}, author_id: #{@author_id.inspect}, org: #{@org.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end