ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/response_incomplete_entity.rb

@@ -0,0 +1,90 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Unique ID of the incomplete worksheet.
+  class ResponseIncompleteEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # Name of the incomplete worksheet.
+    # @return [String]
+    attr_accessor :name
+
+    # Error details related to the incomplete conversion.
+    # @return [String]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, name:, error:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @name = name
+      @error = error
+      @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
+      error = hash.key?('error') ? hash['error'] : 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.
+      ResponseIncompleteEntity.new(id: id,
+                                   name: name,
+                                   error: error,
+                                   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}, error: #{@error}, 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}, error: #{@error.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/response_message.rb

@@ -0,0 +1,134 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ResponseMessage Model.
+  class ResponseMessage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the generated response.
+    # @return [String]
+    attr_accessor :session_identifier
+
+    # Generate number of the response.
+    # @return [Integer]
+    attr_accessor :generation_number
+
+    # Type of the generated response.
+    # @return [String]
+    attr_reader :message_type
+
+    # Generated visualization type.
+    # @return [VisualizationType]
+    attr_accessor :visualization_type
+
+    # Tokens for the response.
+    # @return [String]
+    attr_accessor :tokens
+
+    # User friendly tokens for the response.
+    # @return [String]
+    attr_accessor :display_tokens
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['session_identifier'] = 'session_identifier'
+      @_hash['generation_number'] = 'generation_number'
+      @_hash['message_type'] = 'message_type'
+      @_hash['visualization_type'] = 'visualization_type'
+      @_hash['tokens'] = 'tokens'
+      @_hash['display_tokens'] = 'display_tokens'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        session_identifier
+        generation_number
+        visualization_type
+        tokens
+        display_tokens
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        session_identifier
+        generation_number
+        visualization_type
+        tokens
+        display_tokens
+      ]
+    end
+
+    def initialize(session_identifier: SKIP, generation_number: SKIP,
+                   visualization_type: SKIP, tokens: SKIP, display_tokens: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @session_identifier = session_identifier unless session_identifier == SKIP
+      @generation_number = generation_number unless generation_number == SKIP
+      @message_type = 'TSAnswer'
+      @visualization_type = visualization_type unless visualization_type == SKIP
+      @tokens = tokens unless tokens == SKIP
+      @display_tokens = display_tokens unless display_tokens == 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.
+      session_identifier =
+        hash.key?('session_identifier') ? hash['session_identifier'] : SKIP
+      generation_number =
+        hash.key?('generation_number') ? hash['generation_number'] : SKIP
+      visualization_type =
+        hash.key?('visualization_type') ? hash['visualization_type'] : SKIP
+      tokens = hash.key?('tokens') ? hash['tokens'] : SKIP
+      display_tokens =
+        hash.key?('display_tokens') ? hash['display_tokens'] : 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.
+      ResponseMessage.new(session_identifier: session_identifier,
+                          generation_number: generation_number,
+                          visualization_type: visualization_type,
+                          tokens: tokens,
+                          display_tokens: display_tokens,
+                          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} session_identifier: #{@session_identifier}, generation_number:"\
+      " #{@generation_number}, message_type: #{@message_type}, visualization_type:"\
+      " #{@visualization_type}, tokens: #{@tokens}, display_tokens: #{@display_tokens},"\
+      " 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} session_identifier: #{@session_identifier.inspect}, generation_number:"\
+      " #{@generation_number.inspect}, message_type: #{@message_type.inspect}, visualization_type:"\
+      " #{@visualization_type.inspect}, tokens: #{@tokens.inspect}, display_tokens:"\
+      " #{@display_tokens.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/response_post_upgrade_failed_entities.rb

@@ -0,0 +1,82 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Wrapper for the post-upgrade failed entities, as they are inside a 'data'
+  # field in the response.
+  class ResponsePostUpgradeFailedEntities < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ResponsePostUpgradeFailedEntity]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (ResponsePostUpgradeFailedEntity.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+
+      # 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.
+      ResponsePostUpgradeFailedEntities.new(data: data,
+                                            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} data: #{@data}, 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} data: #{@data.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/response_post_upgrade_failed_entity.rb

@@ -0,0 +1,90 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Unique ID of the worksheet that failed post-upgrade.
+  class ResponsePostUpgradeFailedEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # Name of the worksheet that failed post-upgrade.
+    # @return [String]
+    attr_accessor :name
+
+    # Error details related to the post-upgrade failure.
+    # @return [String]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, name:, error:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @name = name
+      @error = error
+      @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
+      error = hash.key?('error') ? hash['error'] : 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.
+      ResponsePostUpgradeFailedEntity.new(id: id,
+                                          name: name,
+                                          error: error,
+                                          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}, error: #{@error}, 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}, error: #{@error.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/response_schedule.rb

@@ -0,0 +1,227 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ResponseSchedule Model.
+  class ResponseSchedule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Author of the schedule.
+    # @return [Author]
+    attr_accessor :author
+
+    # Schedule creation time in milliseconds.
+    # @return [Object]
+    attr_accessor :creation_time_in_millis
+
+    # Description of the job.
+    # @return [String]
+    attr_accessor :description
+
+    # Export file format.
+    # @return [String]
+    attr_accessor :file_format
+
+    # Configuration of schedule with cron expression
+    # @return [Frequency]
+    attr_accessor :frequency
+
+    # GUID of the scheduled job.
+    # @return [String]
+    attr_accessor :id
+
+    # Options to specify details of Liveboard.
+    # @return [LiveboardOptions]
+    attr_accessor :liveboard_options
+
+    # Options to specify details of Liveboard.
+    # @return [MetadataResponse]
+    attr_accessor :metadata
+
+    # Name of the scheduled job.
+    # @return [String]
+    attr_accessor :name
+
+    # Options for PDF export.
+    # @return [PdfOptions]
+    attr_accessor :pdf_options
+
+    # Recipient configuration which includes email address, ID or name of the
+    # users and groups.
+    # @return [RecipientDetails]
+    attr_accessor :recipient_details
+
+    # Status of the job
+    # @return [String]
+    attr_accessor :status
+
+    # Time zone
+    # @return [String]
+    attr_accessor :time_zone
+
+    # Schedule runs history records.
+    # @return [Array[ResponseScheduleRun]]
+    attr_accessor :history_runs
+
+    # Personalised view id of the liveboard to be scheduled.
+    # @return [String]
+    attr_accessor :personalised_view_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['author'] = 'author'
+      @_hash['creation_time_in_millis'] = 'creation_time_in_millis'
+      @_hash['description'] = 'description'
+      @_hash['file_format'] = 'file_format'
+      @_hash['frequency'] = 'frequency'
+      @_hash['id'] = 'id'
+      @_hash['liveboard_options'] = 'liveboard_options'
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash['pdf_options'] = 'pdf_options'
+      @_hash['recipient_details'] = 'recipient_details'
+      @_hash['status'] = 'status'
+      @_hash['time_zone'] = 'time_zone'
+      @_hash['history_runs'] = 'history_runs'
+      @_hash['personalised_view_id'] = 'personalised_view_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        liveboard_options
+        pdf_options
+        status
+        history_runs
+        personalised_view_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        status
+        history_runs
+        personalised_view_id
+      ]
+    end
+
+    def initialize(author:, creation_time_in_millis:, file_format:, frequency:,
+                   id:, metadata:, name:, recipient_details:, time_zone:,
+                   description: SKIP, liveboard_options: SKIP,
+                   pdf_options: SKIP, status: SKIP, history_runs: SKIP,
+                   personalised_view_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @author = author
+      @creation_time_in_millis = creation_time_in_millis
+      @description = description unless description == SKIP
+      @file_format = file_format
+      @frequency = frequency
+      @id = id
+      @liveboard_options = liveboard_options unless liveboard_options == SKIP
+      @metadata = metadata
+      @name = name
+      @pdf_options = pdf_options unless pdf_options == SKIP
+      @recipient_details = recipient_details
+      @status = status unless status == SKIP
+      @time_zone = time_zone
+      @history_runs = history_runs unless history_runs == SKIP
+      @personalised_view_id = personalised_view_id unless personalised_view_id == 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.
+      author = Author.from_hash(hash['author']) if hash['author']
+      creation_time_in_millis =
+        hash.key?('creation_time_in_millis') ? hash['creation_time_in_millis'] : nil
+      file_format = hash.key?('file_format') ? hash['file_format'] : nil
+      frequency = Frequency.from_hash(hash['frequency']) if hash['frequency']
+      id = hash.key?('id') ? hash['id'] : nil
+      metadata = MetadataResponse.from_hash(hash['metadata']) if hash['metadata']
+      name = hash.key?('name') ? hash['name'] : nil
+      recipient_details = RecipientDetails.from_hash(hash['recipient_details']) if
+        hash['recipient_details']
+      time_zone = hash.key?('time_zone') ? hash['time_zone'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      liveboard_options = LiveboardOptions.from_hash(hash['liveboard_options']) if
+        hash['liveboard_options']
+      pdf_options = PdfOptions.from_hash(hash['pdf_options']) if hash['pdf_options']
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      history_runs = nil
+      unless hash['history_runs'].nil?
+        history_runs = []
+        hash['history_runs'].each do |structure|
+          history_runs << (ResponseScheduleRun.from_hash(structure) if structure)
+        end
+      end
+
+      history_runs = SKIP unless hash.key?('history_runs')
+      personalised_view_id =
+        hash.key?('personalised_view_id') ? hash['personalised_view_id'] : 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.
+      ResponseSchedule.new(author: author,
+                           creation_time_in_millis: creation_time_in_millis,
+                           file_format: file_format,
+                           frequency: frequency,
+                           id: id,
+                           metadata: metadata,
+                           name: name,
+                           recipient_details: recipient_details,
+                           time_zone: time_zone,
+                           description: description,
+                           liveboard_options: liveboard_options,
+                           pdf_options: pdf_options,
+                           status: status,
+                           history_runs: history_runs,
+                           personalised_view_id: personalised_view_id,
+                           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} author: #{@author}, creation_time_in_millis: #{@creation_time_in_millis},"\
+      " description: #{@description}, file_format: #{@file_format}, frequency: #{@frequency}, id:"\
+      " #{@id}, liveboard_options: #{@liveboard_options}, metadata: #{@metadata}, name: #{@name},"\
+      " pdf_options: #{@pdf_options}, recipient_details: #{@recipient_details}, status:"\
+      " #{@status}, time_zone: #{@time_zone}, history_runs: #{@history_runs},"\
+      " personalised_view_id: #{@personalised_view_id}, 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} author: #{@author.inspect}, creation_time_in_millis:"\
+      " #{@creation_time_in_millis.inspect}, description: #{@description.inspect}, file_format:"\
+      " #{@file_format.inspect}, frequency: #{@frequency.inspect}, id: #{@id.inspect},"\
+      " liveboard_options: #{@liveboard_options.inspect}, metadata: #{@metadata.inspect}, name:"\
+      " #{@name.inspect}, pdf_options: #{@pdf_options.inspect}, recipient_details:"\
+      " #{@recipient_details.inspect}, status: #{@status.inspect}, time_zone:"\
+      " #{@time_zone.inspect}, history_runs: #{@history_runs.inspect}, personalised_view_id:"\
+      " #{@personalised_view_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end