ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/query_get_decomposed_query_request.rb

@@ -0,0 +1,145 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # QueryGetDecomposedQueryRequest Model.
+  class QueryGetDecomposedQueryRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of answer unique identifiers (GUIDs) whose data will be used to guide
+    # the response.
+    # @return [Array[String]]
+    attr_accessor :answer_ids
+
+    # User provided content like text data, csv data as a string message to
+    # provide context & potentially improve the quality of the response.
+    # @return [Array[String]]
+    attr_accessor :content
+
+    # Unique identifier to denote current conversation.
+    # @return [String]
+    attr_accessor :conversation_id
+
+    # List of liveboard unique identifiers (GUIDs) whose data will be used to
+    # guide the response.
+    # @return [Array[String]]
+    attr_accessor :liveboard_ids
+
+    # Maximum number of decomposed queries that is allowed in the response,
+    # default = 5.
+    # @return [Integer]
+    attr_accessor :max_decomposed_queries
+
+    # NLSRequest object containing user query & instructions.
+    # @return [InputEurekaNlsRequest]
+    attr_accessor :nls_request
+
+    # List of worksheetIds to provide context for decomposing user query into
+    # analytical queries that can be run on them.
+    # @return [Array[String]]
+    attr_accessor :worksheet_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['answer_ids'] = 'answerIds'
+      @_hash['content'] = 'content'
+      @_hash['conversation_id'] = 'conversationId'
+      @_hash['liveboard_ids'] = 'liveboardIds'
+      @_hash['max_decomposed_queries'] = 'maxDecomposedQueries'
+      @_hash['nls_request'] = 'nlsRequest'
+      @_hash['worksheet_ids'] = 'worksheetIds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        answer_ids
+        content
+        conversation_id
+        liveboard_ids
+        max_decomposed_queries
+        nls_request
+        worksheet_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(answer_ids: SKIP, content: SKIP, conversation_id: SKIP,
+                   liveboard_ids: SKIP, max_decomposed_queries: SKIP,
+                   nls_request: SKIP, worksheet_ids: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @answer_ids = answer_ids unless answer_ids == SKIP
+      @content = content unless content == SKIP
+      @conversation_id = conversation_id unless conversation_id == SKIP
+      @liveboard_ids = liveboard_ids unless liveboard_ids == SKIP
+      @max_decomposed_queries = max_decomposed_queries unless max_decomposed_queries == SKIP
+      @nls_request = nls_request unless nls_request == SKIP
+      @worksheet_ids = worksheet_ids unless worksheet_ids == 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.
+      answer_ids = hash.key?('answerIds') ? hash['answerIds'] : SKIP
+      content = hash.key?('content') ? hash['content'] : SKIP
+      conversation_id =
+        hash.key?('conversationId') ? hash['conversationId'] : SKIP
+      liveboard_ids = hash.key?('liveboardIds') ? hash['liveboardIds'] : SKIP
+      max_decomposed_queries =
+        hash.key?('maxDecomposedQueries') ? hash['maxDecomposedQueries'] : SKIP
+      nls_request = InputEurekaNlsRequest.from_hash(hash['nlsRequest']) if hash['nlsRequest']
+      worksheet_ids = hash.key?('worksheetIds') ? hash['worksheetIds'] : 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.
+      QueryGetDecomposedQueryRequest.new(answer_ids: answer_ids,
+                                         content: content,
+                                         conversation_id: conversation_id,
+                                         liveboard_ids: liveboard_ids,
+                                         max_decomposed_queries: max_decomposed_queries,
+                                         nls_request: nls_request,
+                                         worksheet_ids: worksheet_ids,
+                                         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} answer_ids: #{@answer_ids}, content: #{@content}, conversation_id:"\
+      " #{@conversation_id}, liveboard_ids: #{@liveboard_ids}, max_decomposed_queries:"\
+      " #{@max_decomposed_queries}, nls_request: #{@nls_request}, worksheet_ids:"\
+      " #{@worksheet_ids}, 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} answer_ids: #{@answer_ids.inspect}, content: #{@content.inspect},"\
+      " conversation_id: #{@conversation_id.inspect}, liveboard_ids: #{@liveboard_ids.inspect},"\
+      " max_decomposed_queries: #{@max_decomposed_queries.inspect}, nls_request:"\
+      " #{@nls_request.inspect}, worksheet_ids: #{@worksheet_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/recipient_details.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
+  # Recipient configuration which includes email address, ID or name of the
+  # users and groups.
+  class RecipientDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Emails of the recipients. Specify email address if the recipient is not a
+    # ThoughtSpot user.
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # List of user or groups to subscribe for the scheduled job notifications.
+    # @return [Array[PrincipalsListItem]]
+    attr_accessor :principals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emails'] = 'emails'
+      @_hash['principals'] = 'principals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        principals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        emails
+        principals
+      ]
+    end
+
+    def initialize(emails: SKIP, principals: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emails = emails unless emails == SKIP
+      @principals = principals unless principals == 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.
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      principals = nil
+      unless hash['principals'].nil?
+        principals = []
+        hash['principals'].each do |structure|
+          principals << (PrincipalsListItem.from_hash(structure) if structure)
+        end
+      end
+
+      principals = SKIP unless hash.key?('principals')
+
+      # 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.
+      RecipientDetails.new(emails: emails,
+                           principals: principals,
+                           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} emails: #{@emails}, principals: #{@principals}, 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} emails: #{@emails.inspect}, principals: #{@principals.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/recipient_details_input.rb

@@ -0,0 +1,97 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Recipients of the scheduled job notification.
+  class RecipientDetailsInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Emails of the recipients.
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # User or groups to be set as recipients of the schedule notifications.
+    # @return [Array[PrincipalsListItemInput]]
+    attr_accessor :principals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emails'] = 'emails'
+      @_hash['principals'] = 'principals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        principals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        emails
+        principals
+      ]
+    end
+
+    def initialize(emails: SKIP, principals: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emails = emails unless emails == SKIP
+      @principals = principals unless principals == 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.
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      principals = nil
+      unless hash['principals'].nil?
+        principals = []
+        hash['principals'].each do |structure|
+          principals << (PrincipalsListItemInput.from_hash(structure) if structure)
+        end
+      end
+
+      principals = SKIP unless hash.key?('principals')
+
+      # 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.
+      RecipientDetailsInput.new(emails: emails,
+                                principals: principals,
+                                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} emails: #{@emails}, principals: #{@principals}, 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} emails: #{@emails.inspect}, principals: #{@principals.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/regional_settings_input.rb

@@ -0,0 +1,116 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # RegionalSettingsInput Model.
+  class RegionalSettingsInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO code to be appended with currency values.
+    # @return [CurrencyFormat]
+    attr_accessor :currency_format
+
+    # Indicates the locale to be used for all formattings.
+    # @return [UserLocale]
+    attr_accessor :user_locale
+
+    # Indicates the locale to be used for number formatting.
+    # @return [NumberFormatLocale]
+    attr_accessor :number_format_locale
+
+    # Indicates the locale to be used for date formatting.
+    # @return [DateFormatLocale]
+    attr_accessor :date_format_locale
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_format'] = 'currency_format'
+      @_hash['user_locale'] = 'user_locale'
+      @_hash['number_format_locale'] = 'number_format_locale'
+      @_hash['date_format_locale'] = 'date_format_locale'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency_format
+        user_locale
+        number_format_locale
+        date_format_locale
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        currency_format
+        user_locale
+        number_format_locale
+        date_format_locale
+      ]
+    end
+
+    def initialize(currency_format: SKIP, user_locale: SKIP,
+                   number_format_locale: SKIP, date_format_locale: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency_format = currency_format unless currency_format == SKIP
+      @user_locale = user_locale unless user_locale == SKIP
+      @number_format_locale = number_format_locale unless number_format_locale == SKIP
+      @date_format_locale = date_format_locale unless date_format_locale == 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.
+      currency_format =
+        hash.key?('currency_format') ? hash['currency_format'] : SKIP
+      user_locale = hash.key?('user_locale') ? hash['user_locale'] : SKIP
+      number_format_locale =
+        hash.key?('number_format_locale') ? hash['number_format_locale'] : SKIP
+      date_format_locale =
+        hash.key?('date_format_locale') ? hash['date_format_locale'] : 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.
+      RegionalSettingsInput.new(currency_format: currency_format,
+                                user_locale: user_locale,
+                                number_format_locale: number_format_locale,
+                                date_format_locale: date_format_locale,
+                                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} currency_format: #{@currency_format}, user_locale: #{@user_locale},"\
+      " number_format_locale: #{@number_format_locale}, date_format_locale:"\
+      " #{@date_format_locale}, 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} currency_format: #{@currency_format.inspect}, user_locale:"\
+      " #{@user_locale.inspect}, number_format_locale: #{@number_format_locale.inspect},"\
+      " date_format_locale: #{@date_format_locale.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/repo_config_object.rb

@@ -0,0 +1,154 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # RepoConfigObject Model.
+  class RepoConfigObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Remote repository URL configured
+    # @return [String]
+    attr_accessor :repository_url
+
+    # Username to authenticate connection to the version control system
+    # @return [String]
+    attr_accessor :username
+
+    # Name of the remote branch where objects from this Thoughtspot instance
+    # will be versioned.
+    # @return [String]
+    attr_accessor :commit_branch_name
+
+    # Branches that have been pulled in local repository
+    # @return [Array[String]]
+    attr_accessor :branches
+
+    # Maintain mapping of guid for the deployment to an instance
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_guid_mapping
+
+    # Name of the branch where the configuration files related to operations
+    # between Thoughtspot and version control repo should be maintained.
+    # @return [String]
+    attr_accessor :configuration_branch_name
+
+    # The current Org context of the user.
+    # @return [Org]
+    attr_accessor :org
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['repository_url'] = 'repository_url'
+      @_hash['username'] = 'username'
+      @_hash['commit_branch_name'] = 'commit_branch_name'
+      @_hash['branches'] = 'branches'
+      @_hash['enable_guid_mapping'] = 'enable_guid_mapping'
+      @_hash['configuration_branch_name'] = 'configuration_branch_name'
+      @_hash['org'] = 'org'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        repository_url
+        username
+        commit_branch_name
+        branches
+        enable_guid_mapping
+        configuration_branch_name
+        org
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        repository_url
+        username
+        commit_branch_name
+        branches
+        enable_guid_mapping
+        configuration_branch_name
+      ]
+    end
+
+    def initialize(repository_url: SKIP, username: SKIP,
+                   commit_branch_name: SKIP, branches: SKIP,
+                   enable_guid_mapping: SKIP, configuration_branch_name: SKIP,
+                   org: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @repository_url = repository_url unless repository_url == SKIP
+      @username = username unless username == SKIP
+      @commit_branch_name = commit_branch_name unless commit_branch_name == SKIP
+      @branches = branches unless branches == SKIP
+      @enable_guid_mapping = enable_guid_mapping unless enable_guid_mapping == SKIP
+      unless configuration_branch_name == SKIP
+        @configuration_branch_name =
+          configuration_branch_name
+      end
+      @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.
+      repository_url =
+        hash.key?('repository_url') ? hash['repository_url'] : SKIP
+      username = hash.key?('username') ? hash['username'] : SKIP
+      commit_branch_name =
+        hash.key?('commit_branch_name') ? hash['commit_branch_name'] : SKIP
+      branches = hash.key?('branches') ? hash['branches'] : SKIP
+      enable_guid_mapping =
+        hash.key?('enable_guid_mapping') ? hash['enable_guid_mapping'] : SKIP
+      configuration_branch_name =
+        hash.key?('configuration_branch_name') ? hash['configuration_branch_name'] : SKIP
+      org = Org.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.
+      RepoConfigObject.new(repository_url: repository_url,
+                           username: username,
+                           commit_branch_name: commit_branch_name,
+                           branches: branches,
+                           enable_guid_mapping: enable_guid_mapping,
+                           configuration_branch_name: configuration_branch_name,
+                           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} repository_url: #{@repository_url}, username: #{@username},"\
+      " commit_branch_name: #{@commit_branch_name}, branches: #{@branches}, enable_guid_mapping:"\
+      " #{@enable_guid_mapping}, configuration_branch_name: #{@configuration_branch_name}, 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} repository_url: #{@repository_url.inspect}, username: #{@username.inspect},"\
+      " commit_branch_name: #{@commit_branch_name.inspect}, branches: #{@branches.inspect},"\
+      " enable_guid_mapping: #{@enable_guid_mapping.inspect}, configuration_branch_name:"\
+      " #{@configuration_branch_name.inspect}, org: #{@org.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/reset_event.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
+  # ResetEvent.
+  class ResetEvent
+    RESET_EVENT = [
+      # 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