ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/search_data_response.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
+  # Response format associated with the search data API.
+  class SearchDataResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Data content of metadata objects
+    # @return [Array[AnswerContent]]
+    attr_accessor :contents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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(contents:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      contents = nil
+      unless hash['contents'].nil?
+        contents = []
+        hash['contents'].each do |structure|
+          contents << (AnswerContent.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.
+      SearchDataResponse.new(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} 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} contents: #{@contents.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/search_email_customization_request.rb

@@ -0,0 +1,78 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SearchEmailCustomizationRequest Model.
+  class SearchEmailCustomizationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of org <br/>  <span class="since-beta-tag">Version:
+    # 10.12.0.cl or later</span>
+    # @return [Array[String]]
+    attr_accessor :org_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['org_identifiers'] = 'org_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        org_identifiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(org_identifiers: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @org_identifiers = org_identifiers unless org_identifiers == 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.
+      org_identifiers =
+        hash.key?('org_identifiers') ? hash['org_identifiers'] : 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.
+      SearchEmailCustomizationRequest.new(org_identifiers: org_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} org_identifiers: #{@org_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} org_identifiers: #{@org_identifiers.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/search_metadata_request.rb

@@ -0,0 +1,446 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SearchMetadataRequest Model.
+  class SearchMetadataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Metadata objects such as Liveboards, Answers, and Worksheets.
+    # @return [Array[MetadataListItemInput]]
+    attr_accessor :metadata
+
+    # Object permission details to search by.
+    # @return [Array[PermissionInput]]
+    attr_accessor :permissions
+
+    # GUID or name of user who created the metadata object.
+    # @return [Array[String]]
+    attr_accessor :created_by_user_identifiers
+
+    # Version of the dependent table of the metadata objects like Worksheets.
+    # @return [DependentObjectVersion]
+    attr_accessor :dependent_object_version
+
+    # List of metadata objects to exclude from search.
+    # @return [Array[ExcludeMetadataListItemInput]]
+    attr_accessor :exclude_objects
+
+    # Options to sort the API response by objects set as favorites
+    # for the logged-in user or the users specified in the API request.
+    # @return [FavoriteObjectOptionsInput]
+    attr_accessor :favorite_object_options
+
+    # Includes system-generated metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_auto_created_objects
+
+    # Includes dependents of the metadata object specified in the API request.
+    # For example, a worksheet can consist of dependent objects such as
+    # Liveboards or Answers.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_dependent_objects
+
+    # The maximum number of dependents to include per metadata object.
+    # @return [Integer]
+    attr_accessor :dependent_objects_record_size
+
+    # Includes complete details of the metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_details
+
+    # Includes headers of the metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_headers
+
+    # Includes details of the hidden objects, such as a column in a worksheet or
+    # a table.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_hidden_objects
+
+    # Includes objects with incomplete metadata.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_incomplete_objects
+
+    # Includes visualization headers of the specified Liveboard object.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_visualization_headers
+
+    # If search assistance lessons are configured on a worksheet,
+    # the API returns the search assist data for Worksheet objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_worksheet_search_assist_data
+
+    # Includes ID or names of the users who modified the metadata object.
+    # @return [Array[String]]
+    attr_accessor :modified_by_user_identifiers
+
+    # 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. It is recommended to use a
+    # smaller `record_size` when fetching dependent objects or any of the
+    # additional metadata detail options.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # Sort options to filter metadata details.
+    # @return [MetadataSearchSortOptions]
+    attr_accessor :sort_options
+
+    # Tags to filter metadata objects by
+    # @return [Array[String]]
+    attr_accessor :tag_identifiers
+
+    # Indicates whether to include stats of the metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_stats
+
+    # <div><span class="since-beta-tag">Version: 10.7.0.cl or later</span></div>
+    # Boolean to indicate whether to include discoverable metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_discoverable_objects
+
+    # <div><span class="since-beta-tag">Version: 10.9.0.cl or later</span></div>
+    # Indicates whether to show resolved parameterised values.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_resolved_parameters
+
+    # Indicates the model version of Liveboard to be attached in metadata
+    # detail.
+    # @return [LiveboardResponseVersion]
+    attr_accessor :liveboard_response_version
+
+    # <div><span class="since-beta-tag">Version: 10.11.0.cl or
+    # later</span></div>
+    # If only published objects should be returned
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_only_published_objects
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['permissions'] = 'permissions'
+      @_hash['created_by_user_identifiers'] = 'created_by_user_identifiers'
+      @_hash['dependent_object_version'] = 'dependent_object_version'
+      @_hash['exclude_objects'] = 'exclude_objects'
+      @_hash['favorite_object_options'] = 'favorite_object_options'
+      @_hash['include_auto_created_objects'] = 'include_auto_created_objects'
+      @_hash['include_dependent_objects'] = 'include_dependent_objects'
+      @_hash['dependent_objects_record_size'] =
+        'dependent_objects_record_size'
+      @_hash['include_details'] = 'include_details'
+      @_hash['include_headers'] = 'include_headers'
+      @_hash['include_hidden_objects'] = 'include_hidden_objects'
+      @_hash['include_incomplete_objects'] = 'include_incomplete_objects'
+      @_hash['include_visualization_headers'] =
+        'include_visualization_headers'
+      @_hash['include_worksheet_search_assist_data'] =
+        'include_worksheet_search_assist_data'
+      @_hash['modified_by_user_identifiers'] = 'modified_by_user_identifiers'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['sort_options'] = 'sort_options'
+      @_hash['tag_identifiers'] = 'tag_identifiers'
+      @_hash['include_stats'] = 'include_stats'
+      @_hash['include_discoverable_objects'] = 'include_discoverable_objects'
+      @_hash['show_resolved_parameters'] = 'show_resolved_parameters'
+      @_hash['liveboard_response_version'] = 'liveboard_response_version'
+      @_hash['include_only_published_objects'] =
+        'include_only_published_objects'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        permissions
+        created_by_user_identifiers
+        dependent_object_version
+        exclude_objects
+        favorite_object_options
+        include_auto_created_objects
+        include_dependent_objects
+        dependent_objects_record_size
+        include_details
+        include_headers
+        include_hidden_objects
+        include_incomplete_objects
+        include_visualization_headers
+        include_worksheet_search_assist_data
+        modified_by_user_identifiers
+        record_offset
+        record_size
+        sort_options
+        tag_identifiers
+        include_stats
+        include_discoverable_objects
+        show_resolved_parameters
+        liveboard_response_version
+        include_only_published_objects
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        include_auto_created_objects
+        include_dependent_objects
+        include_details
+        include_headers
+        include_hidden_objects
+        include_incomplete_objects
+        include_visualization_headers
+        include_worksheet_search_assist_data
+        include_stats
+        include_discoverable_objects
+        show_resolved_parameters
+        include_only_published_objects
+      ]
+    end
+
+    def initialize(metadata: SKIP, permissions: SKIP,
+                   created_by_user_identifiers: SKIP,
+                   dependent_object_version: DependentObjectVersion::V1,
+                   exclude_objects: SKIP, favorite_object_options: SKIP,
+                   include_auto_created_objects: false,
+                   include_dependent_objects: false,
+                   dependent_objects_record_size: 50, include_details: false,
+                   include_headers: true, include_hidden_objects: false,
+                   include_incomplete_objects: false,
+                   include_visualization_headers: false,
+                   include_worksheet_search_assist_data: SKIP,
+                   modified_by_user_identifiers: SKIP, record_offset: 0,
+                   record_size: 10, sort_options: SKIP, tag_identifiers: SKIP,
+                   include_stats: false, include_discoverable_objects: true,
+                   show_resolved_parameters: false,
+                   liveboard_response_version: LiveboardResponseVersion::V1,
+                   include_only_published_objects: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata unless metadata == SKIP
+      @permissions = permissions unless permissions == SKIP
+      unless created_by_user_identifiers == SKIP
+        @created_by_user_identifiers =
+          created_by_user_identifiers
+      end
+      @dependent_object_version = dependent_object_version unless dependent_object_version == SKIP
+      @exclude_objects = exclude_objects unless exclude_objects == SKIP
+      @favorite_object_options = favorite_object_options unless favorite_object_options == SKIP
+      unless include_auto_created_objects == SKIP
+        @include_auto_created_objects =
+          include_auto_created_objects
+      end
+      unless include_dependent_objects == SKIP
+        @include_dependent_objects =
+          include_dependent_objects
+      end
+      unless dependent_objects_record_size == SKIP
+        @dependent_objects_record_size =
+          dependent_objects_record_size
+      end
+      @include_details = include_details unless include_details == SKIP
+      @include_headers = include_headers unless include_headers == SKIP
+      @include_hidden_objects = include_hidden_objects unless include_hidden_objects == SKIP
+      unless include_incomplete_objects == SKIP
+        @include_incomplete_objects =
+          include_incomplete_objects
+      end
+      unless include_visualization_headers == SKIP
+        @include_visualization_headers =
+          include_visualization_headers
+      end
+      unless include_worksheet_search_assist_data == SKIP
+        @include_worksheet_search_assist_data =
+          include_worksheet_search_assist_data
+      end
+      unless modified_by_user_identifiers == SKIP
+        @modified_by_user_identifiers =
+          modified_by_user_identifiers
+      end
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == SKIP
+      @sort_options = sort_options unless sort_options == SKIP
+      @tag_identifiers = tag_identifiers unless tag_identifiers == SKIP
+      @include_stats = include_stats unless include_stats == SKIP
+      unless include_discoverable_objects == SKIP
+        @include_discoverable_objects =
+          include_discoverable_objects
+      end
+      @show_resolved_parameters = show_resolved_parameters unless show_resolved_parameters == SKIP
+      unless liveboard_response_version == SKIP
+        @liveboard_response_version =
+          liveboard_response_version
+      end
+      unless include_only_published_objects == SKIP
+        @include_only_published_objects =
+          include_only_published_objects
+      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.
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (MetadataListItemInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = SKIP unless hash.key?('metadata')
+      # Parameter is an array, so we need to iterate through it
+      permissions = nil
+      unless hash['permissions'].nil?
+        permissions = []
+        hash['permissions'].each do |structure|
+          permissions << (PermissionInput.from_hash(structure) if structure)
+        end
+      end
+
+      permissions = SKIP unless hash.key?('permissions')
+      created_by_user_identifiers =
+        hash.key?('created_by_user_identifiers') ? hash['created_by_user_identifiers'] : SKIP
+      dependent_object_version =
+        hash['dependent_object_version'] ||= DependentObjectVersion::V1
+      # Parameter is an array, so we need to iterate through it
+      exclude_objects = nil
+      unless hash['exclude_objects'].nil?
+        exclude_objects = []
+        hash['exclude_objects'].each do |structure|
+          exclude_objects << (ExcludeMetadataListItemInput.from_hash(structure) if structure)
+        end
+      end
+
+      exclude_objects = SKIP unless hash.key?('exclude_objects')
+      if hash['favorite_object_options']
+        favorite_object_options = FavoriteObjectOptionsInput.from_hash(hash['favorite_object_options'])
+      end
+      include_auto_created_objects =
+        hash['include_auto_created_objects'] ||= false
+      include_dependent_objects = hash['include_dependent_objects'] ||= false
+      dependent_objects_record_size =
+        hash['dependent_objects_record_size'] ||= 50
+      include_details = hash['include_details'] ||= false
+      include_headers = hash['include_headers'] ||= true
+      include_hidden_objects = hash['include_hidden_objects'] ||= false
+      include_incomplete_objects = hash['include_incomplete_objects'] ||= false
+      include_visualization_headers =
+        hash['include_visualization_headers'] ||= false
+      include_worksheet_search_assist_data =
+        hash.key?('include_worksheet_search_assist_data') ? hash['include_worksheet_search_assist_data'] : SKIP
+      modified_by_user_identifiers =
+        hash.key?('modified_by_user_identifiers') ? hash['modified_by_user_identifiers'] : SKIP
+      record_offset = hash['record_offset'] ||= 0
+      record_size = hash['record_size'] ||= 10
+      sort_options = MetadataSearchSortOptions.from_hash(hash['sort_options']) if
+        hash['sort_options']
+      tag_identifiers =
+        hash.key?('tag_identifiers') ? hash['tag_identifiers'] : SKIP
+      include_stats = hash['include_stats'] ||= false
+      include_discoverable_objects =
+        hash['include_discoverable_objects'] ||= true
+      show_resolved_parameters = hash['show_resolved_parameters'] ||= false
+      liveboard_response_version =
+        hash['liveboard_response_version'] ||= LiveboardResponseVersion::V1
+      include_only_published_objects =
+        hash['include_only_published_objects'] ||= 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.
+      SearchMetadataRequest.new(metadata: metadata,
+                                permissions: permissions,
+                                created_by_user_identifiers: created_by_user_identifiers,
+                                dependent_object_version: dependent_object_version,
+                                exclude_objects: exclude_objects,
+                                favorite_object_options: favorite_object_options,
+                                include_auto_created_objects: include_auto_created_objects,
+                                include_dependent_objects: include_dependent_objects,
+                                dependent_objects_record_size: dependent_objects_record_size,
+                                include_details: include_details,
+                                include_headers: include_headers,
+                                include_hidden_objects: include_hidden_objects,
+                                include_incomplete_objects: include_incomplete_objects,
+                                include_visualization_headers: include_visualization_headers,
+                                include_worksheet_search_assist_data: include_worksheet_search_assist_data,
+                                modified_by_user_identifiers: modified_by_user_identifiers,
+                                record_offset: record_offset,
+                                record_size: record_size,
+                                sort_options: sort_options,
+                                tag_identifiers: tag_identifiers,
+                                include_stats: include_stats,
+                                include_discoverable_objects: include_discoverable_objects,
+                                show_resolved_parameters: show_resolved_parameters,
+                                liveboard_response_version: liveboard_response_version,
+                                include_only_published_objects: include_only_published_objects,
+                                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: #{@metadata}, permissions: #{@permissions},"\
+      " created_by_user_identifiers: #{@created_by_user_identifiers}, dependent_object_version:"\
+      " #{@dependent_object_version}, exclude_objects: #{@exclude_objects},"\
+      " favorite_object_options: #{@favorite_object_options}, include_auto_created_objects:"\
+      " #{@include_auto_created_objects}, include_dependent_objects:"\
+      " #{@include_dependent_objects}, dependent_objects_record_size:"\
+      " #{@dependent_objects_record_size}, include_details: #{@include_details}, include_headers:"\
+      " #{@include_headers}, include_hidden_objects: #{@include_hidden_objects},"\
+      " include_incomplete_objects: #{@include_incomplete_objects}, include_visualization_headers:"\
+      " #{@include_visualization_headers}, include_worksheet_search_assist_data:"\
+      " #{@include_worksheet_search_assist_data}, modified_by_user_identifiers:"\
+      " #{@modified_by_user_identifiers}, record_offset: #{@record_offset}, record_size:"\
+      " #{@record_size}, sort_options: #{@sort_options}, tag_identifiers: #{@tag_identifiers},"\
+      " include_stats: #{@include_stats}, include_discoverable_objects:"\
+      " #{@include_discoverable_objects}, show_resolved_parameters: #{@show_resolved_parameters},"\
+      " liveboard_response_version: #{@liveboard_response_version},"\
+      " include_only_published_objects: #{@include_only_published_objects}, 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: #{@metadata.inspect}, permissions: #{@permissions.inspect},"\
+      " created_by_user_identifiers: #{@created_by_user_identifiers.inspect},"\
+      " dependent_object_version: #{@dependent_object_version.inspect}, exclude_objects:"\
+      " #{@exclude_objects.inspect}, favorite_object_options: #{@favorite_object_options.inspect},"\
+      " include_auto_created_objects: #{@include_auto_created_objects.inspect},"\
+      " include_dependent_objects: #{@include_dependent_objects.inspect},"\
+      " dependent_objects_record_size: #{@dependent_objects_record_size.inspect}, include_details:"\
+      " #{@include_details.inspect}, include_headers: #{@include_headers.inspect},"\
+      " include_hidden_objects: #{@include_hidden_objects.inspect}, include_incomplete_objects:"\
+      " #{@include_incomplete_objects.inspect}, include_visualization_headers:"\
+      " #{@include_visualization_headers.inspect}, include_worksheet_search_assist_data:"\
+      " #{@include_worksheet_search_assist_data.inspect}, modified_by_user_identifiers:"\
+      " #{@modified_by_user_identifiers.inspect}, record_offset: #{@record_offset.inspect},"\
+      " record_size: #{@record_size.inspect}, sort_options: #{@sort_options.inspect},"\
+      " tag_identifiers: #{@tag_identifiers.inspect}, include_stats: #{@include_stats.inspect},"\
+      " include_discoverable_objects: #{@include_discoverable_objects.inspect},"\
+      " show_resolved_parameters: #{@show_resolved_parameters.inspect},"\
+      " liveboard_response_version: #{@liveboard_response_version.inspect},"\
+      " include_only_published_objects: #{@include_only_published_objects.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end