ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/jwt_user_options.rb

@@ -0,0 +1,109 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # JWT user options to create a JWT token given the payload. *Deprecated in
+  # 9.12.0.cl. Use user_parameters instead.*
+  class JwtUserOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :parameters
+
+    # TODO: Write general description for this method
+    # @return [Array[JwtMetadataObject]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['parameters'] = 'parameters'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        parameters
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+      ]
+    end
+
+    def initialize(parameters: SKIP, metadata: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @parameters = parameters unless parameters == SKIP
+      @metadata = metadata unless metadata == 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.
+      parameters = hash.key?('parameters') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:JwtUserOptionsParameters), hash['parameters']
+      ) : 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 << (JwtMetadataObject.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = SKIP unless hash.key?('metadata')
+
+      # 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.
+      JwtUserOptions.new(parameters: parameters,
+                         metadata: metadata,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [JwtUserOptions | 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} parameters: #{@parameters}, metadata: #{@metadata}, 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} parameters: #{@parameters.inspect}, metadata: #{@metadata.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/jwt_user_options_full.rb

@@ -0,0 +1,88 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # JWT user options to create a JWT token given the payload. *Deprecated in
+  # 9.12.0.cl. Use user_parameters instead.*
+  class JwtUserOptionsFull < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[JwtParameter]]
+    attr_accessor :parameters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['parameters'] = 'parameters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        parameters
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        parameters
+      ]
+    end
+
+    def initialize(parameters: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @parameters = parameters unless parameters == 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
+      parameters = nil
+      unless hash['parameters'].nil?
+        parameters = []
+        hash['parameters'].each do |structure|
+          parameters << (JwtParameter.from_hash(structure) if structure)
+        end
+      end
+
+      parameters = SKIP unless hash.key?('parameters')
+
+      # 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.
+      JwtUserOptionsFull.new(parameters: parameters,
+                             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} parameters: #{@parameters}, 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} parameters: #{@parameters.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/lb_context_input.rb

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

data/lib/thought_spot_public_rest_api/models/liveboard_content.rb

@@ -0,0 +1,162 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # LiveboardContent Model.
+  class LiveboardContent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total available data row count.
+    # @return [Integer]
+    attr_accessor :available_data_row_count
+
+    # Name of the columns.
+    # @return [Array[String]]
+    attr_accessor :column_names
+
+    # Rows of data set.
+    # @return [Array[Object]]
+    attr_accessor :data_rows
+
+    # The starting record number from where the records should be included.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records that should be included.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # Total returned data row count.
+    # @return [Integer]
+    attr_accessor :returned_data_row_count
+
+    # Sampling ratio (0 to 1). If the query was sampled, it is the ratio of keys
+    # returned in the data set to the total number of keys expected in the
+    # query. If the value is 1.0, this means that the complete result is
+    # returned.
+    # @return [Float]
+    attr_accessor :sampling_ratio
+
+    # Unique ID of the visualization.
+    # @return [String]
+    attr_accessor :visualization_id
+
+    # Name of the visualization.
+    # @return [String]
+    attr_accessor :visualization_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available_data_row_count'] = 'available_data_row_count'
+      @_hash['column_names'] = 'column_names'
+      @_hash['data_rows'] = 'data_rows'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['returned_data_row_count'] = 'returned_data_row_count'
+      @_hash['sampling_ratio'] = 'sampling_ratio'
+      @_hash['visualization_id'] = 'visualization_id'
+      @_hash['visualization_name'] = 'visualization_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        visualization_id
+        visualization_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        visualization_id
+        visualization_name
+      ]
+    end
+
+    def initialize(available_data_row_count:, column_names:, data_rows:,
+                   record_offset:, record_size:, returned_data_row_count:,
+                   sampling_ratio:, visualization_id: SKIP,
+                   visualization_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @available_data_row_count = available_data_row_count
+      @column_names = column_names
+      @data_rows = data_rows
+      @record_offset = record_offset
+      @record_size = record_size
+      @returned_data_row_count = returned_data_row_count
+      @sampling_ratio = sampling_ratio
+      @visualization_id = visualization_id unless visualization_id == SKIP
+      @visualization_name = visualization_name unless visualization_name == 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.
+      available_data_row_count =
+        hash.key?('available_data_row_count') ? hash['available_data_row_count'] : nil
+      column_names = hash.key?('column_names') ? hash['column_names'] : nil
+      data_rows = hash.key?('data_rows') ? hash['data_rows'] : nil
+      record_offset = hash.key?('record_offset') ? hash['record_offset'] : nil
+      record_size = hash.key?('record_size') ? hash['record_size'] : nil
+      returned_data_row_count =
+        hash.key?('returned_data_row_count') ? hash['returned_data_row_count'] : nil
+      sampling_ratio =
+        hash.key?('sampling_ratio') ? hash['sampling_ratio'] : nil
+      visualization_id =
+        hash.key?('visualization_id') ? hash['visualization_id'] : SKIP
+      visualization_name =
+        hash.key?('visualization_name') ? hash['visualization_name'] : 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.
+      LiveboardContent.new(available_data_row_count: available_data_row_count,
+                           column_names: column_names,
+                           data_rows: data_rows,
+                           record_offset: record_offset,
+                           record_size: record_size,
+                           returned_data_row_count: returned_data_row_count,
+                           sampling_ratio: sampling_ratio,
+                           visualization_id: visualization_id,
+                           visualization_name: visualization_name,
+                           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} available_data_row_count: #{@available_data_row_count}, column_names:"\
+      " #{@column_names}, data_rows: #{@data_rows}, record_offset: #{@record_offset}, record_size:"\
+      " #{@record_size}, returned_data_row_count: #{@returned_data_row_count}, sampling_ratio:"\
+      " #{@sampling_ratio}, visualization_id: #{@visualization_id}, visualization_name:"\
+      " #{@visualization_name}, 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} available_data_row_count: #{@available_data_row_count.inspect},"\
+      " column_names: #{@column_names.inspect}, data_rows: #{@data_rows.inspect}, record_offset:"\
+      " #{@record_offset.inspect}, record_size: #{@record_size.inspect}, returned_data_row_count:"\
+      " #{@returned_data_row_count.inspect}, sampling_ratio: #{@sampling_ratio.inspect},"\
+      " visualization_id: #{@visualization_id.inspect}, visualization_name:"\
+      " #{@visualization_name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/liveboard_data_response.rb

@@ -0,0 +1,101 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # LiveboardDataResponse Model.
+  class LiveboardDataResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier of the object
+    # @return [String]
+    attr_accessor :metadata_id
+
+    # Name of the metadata object
+    # @return [String]
+    attr_accessor :metadata_name
+
+    # Data content of metadata objects
+    # @return [Array[LiveboardContent]]
+    attr_accessor :contents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_id'] = 'metadata_id'
+      @_hash['metadata_name'] = 'metadata_name'
+      @_hash['contents'] = 'contents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata_id:, metadata_name:, contents:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_id = metadata_id
+      @metadata_name = metadata_name
+      @contents = contents
+      @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_id = hash.key?('metadata_id') ? hash['metadata_id'] : nil
+      metadata_name = hash.key?('metadata_name') ? hash['metadata_name'] : nil
+      # Parameter is an array, so we need to iterate through it
+      contents = nil
+      unless hash['contents'].nil?
+        contents = []
+        hash['contents'].each do |structure|
+          contents << (LiveboardContent.from_hash(structure) if structure)
+        end
+      end
+
+      contents = nil unless hash.key?('contents')
+
+      # 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.
+      LiveboardDataResponse.new(metadata_id: metadata_id,
+                                metadata_name: metadata_name,
+                                contents: contents,
+                                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_id: #{@metadata_id}, metadata_name: #{@metadata_name}, contents:"\
+      " #{@contents}, 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_id: #{@metadata_id.inspect}, metadata_name:"\
+      " #{@metadata_name.inspect}, contents: #{@contents.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/liveboard_options.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
+  # Options to specify details of Liveboard.
+  class LiveboardOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of visualizations.
+    # @return [Array[String]]
+    attr_accessor :visualization_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['visualization_identifiers'] = 'visualization_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(visualization_identifiers:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @visualization_identifiers = visualization_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.
+      visualization_identifiers =
+        hash.key?('visualization_identifiers') ? hash['visualization_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.
+      LiveboardOptions.new(visualization_identifiers: visualization_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} visualization_identifiers: #{@visualization_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} visualization_identifiers: #{@visualization_identifiers.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/liveboard_options_input.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
+  # Options to specify details of Liveboard.
+  class LiveboardOptionsInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of visualizations.
+    # @return [Array[String]]
+    attr_accessor :visualization_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['visualization_identifiers'] = 'visualization_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(visualization_identifiers:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @visualization_identifiers = visualization_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.
+      visualization_identifiers =
+        hash.key?('visualization_identifiers') ? hash['visualization_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.
+      LiveboardOptionsInput.new(visualization_identifiers: visualization_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} visualization_identifiers: #{@visualization_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} visualization_identifiers: #{@visualization_identifiers.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end