ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/import_users_request.rb

@@ -0,0 +1,121 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ImportUsersRequest Model.
+  class ImportUsersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of users needs to be imported.
+    # @return [Array[ImportUser]]
+    attr_accessor :users
+
+    # The default password to assign to users if they do not have a password
+    # assigned in ThoughtSpot.
+    # @return [String]
+    attr_accessor :default_password
+
+    # If true, the API performs a test operation and returns user IDs whose data
+    # will be edited after the import.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :dry_run
+
+    # If set to true, removes the users that are not specified in the API
+    # request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :delete_unspecified_users
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['users'] = 'users'
+      @_hash['default_password'] = 'default_password'
+      @_hash['dry_run'] = 'dry_run'
+      @_hash['delete_unspecified_users'] = 'delete_unspecified_users'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        default_password
+        dry_run
+        delete_unspecified_users
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        dry_run
+        delete_unspecified_users
+      ]
+    end
+
+    def initialize(users:, default_password: SKIP, dry_run: true,
+                   delete_unspecified_users: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @users = users
+      @default_password = default_password unless default_password == SKIP
+      @dry_run = dry_run unless dry_run == SKIP
+      @delete_unspecified_users = delete_unspecified_users unless delete_unspecified_users == 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
+      users = nil
+      unless hash['users'].nil?
+        users = []
+        hash['users'].each do |structure|
+          users << (ImportUser.from_hash(structure) if structure)
+        end
+      end
+
+      users = nil unless hash.key?('users')
+      default_password =
+        hash.key?('default_password') ? hash['default_password'] : SKIP
+      dry_run = hash['dry_run'] ||= true
+      delete_unspecified_users = hash['delete_unspecified_users'] ||= 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.
+      ImportUsersRequest.new(users: users,
+                             default_password: default_password,
+                             dry_run: dry_run,
+                             delete_unspecified_users: delete_unspecified_users,
+                             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} users: #{@users}, default_password: #{@default_password}, dry_run:"\
+      " #{@dry_run}, delete_unspecified_users: #{@delete_unspecified_users},"\
+      " 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} users: #{@users.inspect}, default_password: #{@default_password.inspect},"\
+      " dry_run: #{@dry_run.inspect}, delete_unspecified_users:"\
+      " #{@delete_unspecified_users.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/import_users_response.rb

@@ -0,0 +1,127 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ImportUsersResponse Model.
+  class ImportUsersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ImportUserType]]
+    attr_accessor :users_added
+
+    # TODO: Write general description for this method
+    # @return [Array[ImportUserType]]
+    attr_accessor :users_updated
+
+    # TODO: Write general description for this method
+    # @return [Array[ImportUserType]]
+    attr_accessor :users_deleted
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['users_added'] = 'users_added'
+      @_hash['users_updated'] = 'users_updated'
+      @_hash['users_deleted'] = 'users_deleted'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        users_added
+        users_updated
+        users_deleted
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        users_added
+        users_updated
+        users_deleted
+      ]
+    end
+
+    def initialize(users_added: SKIP, users_updated: SKIP, users_deleted: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @users_added = users_added unless users_added == SKIP
+      @users_updated = users_updated unless users_updated == SKIP
+      @users_deleted = users_deleted unless users_deleted == 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
+      users_added = nil
+      unless hash['users_added'].nil?
+        users_added = []
+        hash['users_added'].each do |structure|
+          users_added << (ImportUserType.from_hash(structure) if structure)
+        end
+      end
+
+      users_added = SKIP unless hash.key?('users_added')
+      # Parameter is an array, so we need to iterate through it
+      users_updated = nil
+      unless hash['users_updated'].nil?
+        users_updated = []
+        hash['users_updated'].each do |structure|
+          users_updated << (ImportUserType.from_hash(structure) if structure)
+        end
+      end
+
+      users_updated = SKIP unless hash.key?('users_updated')
+      # Parameter is an array, so we need to iterate through it
+      users_deleted = nil
+      unless hash['users_deleted'].nil?
+        users_deleted = []
+        hash['users_deleted'].each do |structure|
+          users_deleted << (ImportUserType.from_hash(structure) if structure)
+        end
+      end
+
+      users_deleted = SKIP unless hash.key?('users_deleted')
+
+      # 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.
+      ImportUsersResponse.new(users_added: users_added,
+                              users_updated: users_updated,
+                              users_deleted: users_deleted,
+                              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} users_added: #{@users_added}, users_updated: #{@users_updated},"\
+      " users_deleted: #{@users_deleted}, 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} users_added: #{@users_added.inspect}, users_updated:"\
+      " #{@users_updated.inspect}, users_deleted: #{@users_deleted.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/import_worksheets.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
+  # Mention the worksheet tmls to import
+  class ImportWorksheets
+    IMPORT_WORKSHEETS = [
+      # TODO: Write general description for ALL
+      ALL = 'ALL'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze,
+
+      # TODO: Write general description for SELECTED
+      SELECTED = 'SELECTED'.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 'none' then NONE
+      when 'selected' then SELECTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/input_eureka_nls_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
+  # InputEurekaNlsRequest Model.
+  class InputEurekaNlsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Cluster version like 10.4.0.cl, 10.5.0.cl, so on.
+    # @return [Integer]
+    attr_accessor :agent_version
+
+    # If true, results are not returned from cache & calculated every time. Can
+    # incur high costs & latency.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :bypass_cache
+
+    # User specific instructions for processing the @query.
+    # @return [Array[String]]
+    attr_accessor :instructions
+
+    # User query which is a topical/goal oriented question that needs to be
+    # broken down into smaller simple analytical questions.
+    # @return [String]
+    attr_accessor :query
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['agent_version'] = 'agentVersion'
+      @_hash['bypass_cache'] = 'bypassCache'
+      @_hash['instructions'] = 'instructions'
+      @_hash['query'] = 'query'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        agent_version
+        bypass_cache
+        instructions
+        query
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        agent_version
+        bypass_cache
+        instructions
+        query
+      ]
+    end
+
+    def initialize(agent_version: SKIP, bypass_cache: SKIP, instructions: SKIP,
+                   query: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @agent_version = agent_version unless agent_version == SKIP
+      @bypass_cache = bypass_cache unless bypass_cache == SKIP
+      @instructions = instructions unless instructions == SKIP
+      @query = query unless query == 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.
+      agent_version = hash.key?('agentVersion') ? hash['agentVersion'] : SKIP
+      bypass_cache = hash.key?('bypassCache') ? hash['bypassCache'] : SKIP
+      instructions = hash.key?('instructions') ? hash['instructions'] : SKIP
+      query = hash.key?('query') ? hash['query'] : 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.
+      InputEurekaNlsRequest.new(agent_version: agent_version,
+                                bypass_cache: bypass_cache,
+                                instructions: instructions,
+                                query: query,
+                                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} agent_version: #{@agent_version}, bypass_cache: #{@bypass_cache},"\
+      " instructions: #{@instructions}, query: #{@query}, 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} agent_version: #{@agent_version.inspect}, bypass_cache:"\
+      " #{@bypass_cache.inspect}, instructions: #{@instructions.inspect}, query:"\
+      " #{@query.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/jwt_metadata_object.rb

@@ -0,0 +1,98 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Metadata objects.
+  class JwtMetadataObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :identifier
+
+    # TODO: Write general description for this method
+    # @return [Type10]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identifier'] = 'identifier'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        identifier
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        identifier
+        type
+      ]
+    end
+
+    def initialize(identifier: SKIP, type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @identifier = identifier unless identifier == SKIP
+      @type = type unless 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.
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      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.
+      JwtMetadataObject.new(identifier: identifier,
+                            type: type,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [JwtMetadataObject | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} identifier: #{@identifier}, type: #{@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} identifier: #{@identifier.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/jwt_parameter.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
+  # List of runtime parameters need to set during the session.
+  class JwtParameter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Runtime filter parameter type in JWT.
+    # @return [Object]
+    attr_accessor :runtime_filter
+
+    # Runtime sort parameter type in JWT.
+    # @return [Object]
+    attr_accessor :runtime_sort
+
+    # Runtime param override type in JWT.
+    # @return [Object]
+    attr_accessor :runtime_param_override
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['runtime_filter'] = 'runtime_filter'
+      @_hash['runtime_sort'] = 'runtime_sort'
+      @_hash['runtime_param_override'] = 'runtime_param_override'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        runtime_filter
+        runtime_sort
+        runtime_param_override
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        runtime_filter
+        runtime_sort
+        runtime_param_override
+      ]
+    end
+
+    def initialize(runtime_filter: SKIP, runtime_sort: SKIP,
+                   runtime_param_override: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @runtime_filter = runtime_filter unless runtime_filter == SKIP
+      @runtime_sort = runtime_sort unless runtime_sort == SKIP
+      @runtime_param_override = runtime_param_override unless runtime_param_override == 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.
+      runtime_filter =
+        hash.key?('runtime_filter') ? hash['runtime_filter'] : SKIP
+      runtime_sort = hash.key?('runtime_sort') ? hash['runtime_sort'] : SKIP
+      runtime_param_override =
+        hash.key?('runtime_param_override') ? hash['runtime_param_override'] : 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.
+      JwtParameter.new(runtime_filter: runtime_filter,
+                       runtime_sort: runtime_sort,
+                       runtime_param_override: runtime_param_override,
+                       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} runtime_filter: #{@runtime_filter}, runtime_sort: #{@runtime_sort},"\
+      " runtime_param_override: #{@runtime_param_override}, 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} runtime_filter: #{@runtime_filter.inspect}, runtime_sort:"\
+      " #{@runtime_sort.inspect}, runtime_param_override: #{@runtime_param_override.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end