ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/fetch_liveboard_data_request.rb

@@ -0,0 +1,185 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # FetchLiveboardDataRequest Model.
+  class FetchLiveboardDataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID or name of the Liveboard.
+    # @return [String]
+    attr_accessor :metadata_identifier
+
+    # GUIDs or names of the visualizations on the Liveboard.
+    # @return [Array[String]]
+    attr_accessor :visualization_identifiers
+
+    # Transient content of the Liveboard.
+    # @return [String]
+    attr_accessor :transient_content
+
+    # JSON output in compact or full format. The FULL option is available in
+    # 9.12.5.cl or later.
+    # @return [DataFormat]
+    attr_accessor :data_format
+
+    # The starting record number from where the records should be included.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records to include in a batch.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # JSON object with representing filter condition to apply filters at
+    # runtime. For example, <code> {"col1": "item type", "op1": "EQ", "val1":
+    # "Bags"} </code>. You can add multiple keys by incrementing the number at
+    # the end, for example, col2, op2, val2, and col3, op3, val3. For more
+    # information, see [API
+    # Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-repo
+    # rt-apis#_runtime_filters).
+    # @return [Object]
+    attr_accessor :runtime_filter
+
+    # JSON object representing columns to sort data at runtime. For example,
+    # <code> {"sortCol1": "sales", "asc1": true} </code>. You can add multiple
+    # keys by incrementing the number at the end, for example, sortCol1, asc2.
+    # For more information, see [API
+    # Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-repo
+    # rt-apis#_runtime_sort).
+    # @return [Object]
+    attr_accessor :runtime_sort
+
+    # JSON object for setting values of parameters at runtime. For example,
+    # <code> {"param1": "Double List Param", "paramVal1": 0.5}</code>. You can
+    # add multiple keys by incrementing the number at the end, for example,
+    # param2, paramVal2. For more information, see [API
+    # Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-repo
+    # rt-apis#_runtime_parameters).
+    # @return [Object]
+    attr_accessor :runtime_param_override
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_identifier'] = 'metadata_identifier'
+      @_hash['visualization_identifiers'] = 'visualization_identifiers'
+      @_hash['transient_content'] = 'transient_content'
+      @_hash['data_format'] = 'data_format'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['runtime_filter'] = 'runtime_filter'
+      @_hash['runtime_sort'] = 'runtime_sort'
+      @_hash['runtime_param_override'] = 'runtime_param_override'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        visualization_identifiers
+        transient_content
+        data_format
+        record_offset
+        record_size
+        runtime_filter
+        runtime_sort
+        runtime_param_override
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata_identifier:, visualization_identifiers: SKIP,
+                   transient_content: SKIP, data_format: DataFormat::COMPACT,
+                   record_offset: 0, record_size: 10, runtime_filter: SKIP,
+                   runtime_sort: SKIP, runtime_param_override: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_identifier = metadata_identifier
+      unless visualization_identifiers == SKIP
+        @visualization_identifiers =
+          visualization_identifiers
+      end
+      @transient_content = transient_content unless transient_content == SKIP
+      @data_format = data_format unless data_format == SKIP
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == SKIP
+      @runtime_filter = runtime_filter unless runtime_filter == SKIP
+      @runtime_sort = runtime_sort unless runtime_sort == SKIP
+      @runtime_param_override = runtime_param_override unless runtime_param_override == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      metadata_identifier =
+        hash.key?('metadata_identifier') ? hash['metadata_identifier'] : nil
+      visualization_identifiers =
+        hash.key?('visualization_identifiers') ? hash['visualization_identifiers'] : SKIP
+      transient_content =
+        hash.key?('transient_content') ? hash['transient_content'] : SKIP
+      data_format = hash['data_format'] ||= DataFormat::COMPACT
+      record_offset = hash['record_offset'] ||= 0
+      record_size = hash['record_size'] ||= 10
+      runtime_filter =
+        hash.key?('runtime_filter') ? hash['runtime_filter'] : SKIP
+      runtime_sort = hash.key?('runtime_sort') ? hash['runtime_sort'] : SKIP
+      runtime_param_override =
+        hash.key?('runtime_param_override') ? hash['runtime_param_override'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FetchLiveboardDataRequest.new(metadata_identifier: metadata_identifier,
+                                    visualization_identifiers: visualization_identifiers,
+                                    transient_content: transient_content,
+                                    data_format: data_format,
+                                    record_offset: record_offset,
+                                    record_size: record_size,
+                                    runtime_filter: runtime_filter,
+                                    runtime_sort: runtime_sort,
+                                    runtime_param_override: runtime_param_override,
+                                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata_identifier: #{@metadata_identifier}, visualization_identifiers:"\
+      " #{@visualization_identifiers}, transient_content: #{@transient_content}, data_format:"\
+      " #{@data_format}, record_offset: #{@record_offset}, record_size: #{@record_size},"\
+      " runtime_filter: #{@runtime_filter}, runtime_sort: #{@runtime_sort},"\
+      " runtime_param_override: #{@runtime_param_override}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata_identifier: #{@metadata_identifier.inspect},"\
+      " visualization_identifiers: #{@visualization_identifiers.inspect}, transient_content:"\
+      " #{@transient_content.inspect}, data_format: #{@data_format.inspect}, record_offset:"\
+      " #{@record_offset.inspect}, record_size: #{@record_size.inspect}, runtime_filter:"\
+      " #{@runtime_filter.inspect}, runtime_sort: #{@runtime_sort.inspect},"\
+      " runtime_param_override: #{@runtime_param_override.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/fetch_liveboard_sql_query_request.rb

@@ -0,0 +1,91 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # FetchLiveboardSqlQueryRequest Model.
+  class FetchLiveboardSqlQueryRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID or name of the Liveboard.
+    # @return [String]
+    attr_accessor :metadata_identifier
+
+    # 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['metadata_identifier'] = 'metadata_identifier'
+      @_hash['visualization_identifiers'] = 'visualization_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        visualization_identifiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata_identifier:, visualization_identifiers: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_identifier = metadata_identifier
+      unless visualization_identifiers == SKIP
+        @visualization_identifiers =
+          visualization_identifiers
+      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.
+      metadata_identifier =
+        hash.key?('metadata_identifier') ? hash['metadata_identifier'] : nil
+      visualization_identifiers =
+        hash.key?('visualization_identifiers') ? hash['visualization_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.
+      FetchLiveboardSqlQueryRequest.new(metadata_identifier: metadata_identifier,
+                                        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} metadata_identifier: #{@metadata_identifier}, 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} metadata_identifier: #{@metadata_identifier.inspect},"\
+      " visualization_identifiers: #{@visualization_identifiers.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/fetch_logs_request.rb

@@ -0,0 +1,112 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # FetchLogsRequest Model.
+  class FetchLogsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the log type
+    # @return [String]
+    attr_reader :log_type
+
+    # Start time in EPOCH format
+    # @return [Float]
+    attr_accessor :start_epoch_time_in_millis
+
+    # End time in EPOCH format
+    # @return [Float]
+    attr_accessor :end_epoch_time_in_millis
+
+    # Fetch all the logs. This is available from 9.10.5.cl
+    # @return [TrueClass | FalseClass]
+    attr_accessor :get_all_logs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['log_type'] = 'log_type'
+      @_hash['start_epoch_time_in_millis'] = 'start_epoch_time_in_millis'
+      @_hash['end_epoch_time_in_millis'] = 'end_epoch_time_in_millis'
+      @_hash['get_all_logs'] = 'get_all_logs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_epoch_time_in_millis
+        end_epoch_time_in_millis
+        get_all_logs
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        get_all_logs
+      ]
+    end
+
+    def initialize(start_epoch_time_in_millis: SKIP,
+                   end_epoch_time_in_millis: SKIP, get_all_logs: true,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @log_type = 'SECURITY_AUDIT'
+      unless start_epoch_time_in_millis == SKIP
+        @start_epoch_time_in_millis =
+          start_epoch_time_in_millis
+      end
+      @end_epoch_time_in_millis = end_epoch_time_in_millis unless end_epoch_time_in_millis == SKIP
+      @get_all_logs = get_all_logs unless get_all_logs == 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.
+      start_epoch_time_in_millis =
+        hash.key?('start_epoch_time_in_millis') ? hash['start_epoch_time_in_millis'] : SKIP
+      end_epoch_time_in_millis =
+        hash.key?('end_epoch_time_in_millis') ? hash['end_epoch_time_in_millis'] : SKIP
+      get_all_logs = hash['get_all_logs'] ||= true
+
+      # 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.
+      FetchLogsRequest.new(start_epoch_time_in_millis: start_epoch_time_in_millis,
+                           end_epoch_time_in_millis: end_epoch_time_in_millis,
+                           get_all_logs: get_all_logs,
+                           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} log_type: #{@log_type}, start_epoch_time_in_millis:"\
+      " #{@start_epoch_time_in_millis}, end_epoch_time_in_millis: #{@end_epoch_time_in_millis},"\
+      " get_all_logs: #{@get_all_logs}, 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} log_type: #{@log_type.inspect}, start_epoch_time_in_millis:"\
+      " #{@start_epoch_time_in_millis.inspect}, end_epoch_time_in_millis:"\
+      " #{@end_epoch_time_in_millis.inspect}, get_all_logs: #{@get_all_logs.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/fetch_object_privileges_request.rb

@@ -0,0 +1,128 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # FetchObjectPrivilegesRequest Model.
+  class FetchObjectPrivilegesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Metadata objects for which you want to fetch object privileges. For now
+    # only LOGICAL_TABLE is supported. It may be extended to other metadata
+    # types in the future.
+    # @return [Array[ObjectPrivilegesMetadataInput]]
+    attr_accessor :metadata
+
+    # User or group objects for which you want to fetch object privileges.
+    # If not specified, the API returns all users and groups that
+    # have object privileges on the specified metadata objects.
+    # @return [Array[PrincipalsInput]]
+    attr_accessor :principals
+
+    # The starting record number from where the records should be included for
+    # each metadata type.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records that should be included for each metadata type.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['principals'] = 'principals'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        principals
+        record_offset
+        record_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata:, principals: SKIP, record_offset: 0,
+                   record_size: 20, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @principals = principals unless principals == SKIP
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == 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
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (ObjectPrivilegesMetadataInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = nil unless hash.key?('metadata')
+      # Parameter is an array, so we need to iterate through it
+      principals = nil
+      unless hash['principals'].nil?
+        principals = []
+        hash['principals'].each do |structure|
+          principals << (PrincipalsInput.from_hash(structure) if structure)
+        end
+      end
+
+      principals = SKIP unless hash.key?('principals')
+      record_offset = hash['record_offset'] ||= 0
+      record_size = hash['record_size'] ||= 20
+
+      # 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.
+      FetchObjectPrivilegesRequest.new(metadata: metadata,
+                                       principals: principals,
+                                       record_offset: record_offset,
+                                       record_size: record_size,
+                                       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}, principals: #{@principals}, record_offset:"\
+      " #{@record_offset}, record_size: #{@record_size}, 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}, principals: #{@principals.inspect},"\
+      " record_offset: #{@record_offset.inspect}, record_size: #{@record_size.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/fetch_permissions_of_principals_request.rb

@@ -0,0 +1,139 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # FetchPermissionsOfPrincipalsRequest Model.
+  class FetchPermissionsOfPrincipalsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID or name of the user or group.
+    # @return [Array[PrincipalsInput]]
+    attr_accessor :principals
+
+    # Metadata objects for which you want to fetch permission details.
+    # If not specified, the API returns permission details for all
+    # metadata objects that the specified users and groups can access.
+    # @return [Array[PermissionsMetadataTypeInput]]
+    attr_accessor :metadata
+
+    # The starting record number from where the records should be included for
+    # each metadata type.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records that should be included for each metadata type.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # When no metadata objects input is passed, metadata objects of this type
+    # are fetched.
+    # @return [DefaultMetadataType]
+    attr_accessor :default_metadata_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['principals'] = 'principals'
+      @_hash['metadata'] = 'metadata'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['default_metadata_type'] = 'default_metadata_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        record_offset
+        record_size
+        default_metadata_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(principals:, metadata: SKIP, record_offset: 0,
+                   record_size: -1, default_metadata_type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @principals = principals
+      @metadata = metadata unless metadata == SKIP
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == SKIP
+      @default_metadata_type = default_metadata_type unless default_metadata_type == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      principals = nil
+      unless hash['principals'].nil?
+        principals = []
+        hash['principals'].each do |structure|
+          principals << (PrincipalsInput.from_hash(structure) if structure)
+        end
+      end
+
+      principals = nil unless hash.key?('principals')
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (PermissionsMetadataTypeInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = SKIP unless hash.key?('metadata')
+      record_offset = hash['record_offset'] ||= 0
+      record_size = hash['record_size'] ||= -1
+      default_metadata_type =
+        hash.key?('default_metadata_type') ? hash['default_metadata_type'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FetchPermissionsOfPrincipalsRequest.new(principals: principals,
+                                              metadata: metadata,
+                                              record_offset: record_offset,
+                                              record_size: record_size,
+                                              default_metadata_type: default_metadata_type,
+                                              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} principals: #{@principals}, metadata: #{@metadata}, record_offset:"\
+      " #{@record_offset}, record_size: #{@record_size}, default_metadata_type:"\
+      " #{@default_metadata_type}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} principals: #{@principals.inspect}, metadata: #{@metadata.inspect},"\
+      " record_offset: #{@record_offset.inspect}, record_size: #{@record_size.inspect},"\
+      " default_metadata_type: #{@default_metadata_type.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end