ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/delete_variables_request.rb

@@ -0,0 +1,74 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # DeleteVariablesRequest Model.
+  class DeleteVariablesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique id(s) or name(s) of the variable(s) to delete
+    # @return [Array[String]]
+    attr_accessor :identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identifiers'] = 'identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(identifiers:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @identifiers = identifiers
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      identifiers = hash.key?('identifiers') ? hash['identifiers'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DeleteVariablesRequest.new(identifiers: 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} identifiers: #{@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} identifiers: #{@identifiers.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/delete_webhook_configurations_request.rb

@@ -0,0 +1,75 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # DeleteWebhookConfigurationsRequest Model.
+  class DeleteWebhookConfigurationsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of webhook identifiers to delete.
+    # @return [Array[String]]
+    attr_accessor :webhook_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_identifiers'] = 'webhook_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_identifiers:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_identifiers = webhook_identifiers
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      webhook_identifiers =
+        hash.key?('webhook_identifiers') ? hash['webhook_identifiers'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DeleteWebhookConfigurationsRequest.new(webhook_identifiers: webhook_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} webhook_identifiers: #{@webhook_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} webhook_identifiers: #{@webhook_identifiers.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/dependent_object_version.rb

@@ -0,0 +1,36 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Version of the dependent table of the metadata objects like Worksheets.
+  class DependentObjectVersion
+    DEPENDENT_OBJECT_VERSION = [
+      # TODO: Write general description for V1
+      V1 = 'V1'.freeze,
+
+      # TODO: Write general description for V2
+      V2 = 'V2'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = V1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'v1' then V1
+      when 'v2' then V2
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/deploy_commit_request.rb

@@ -0,0 +1,115 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # DeployCommitRequest Model.
+  class DeployCommitRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Commit_id against which the files should be picked to deploy.
+    #    
+    # Note: If no commit_id is specified, then the head of the branch is
+    # considered.
+    # @return [String]
+    attr_accessor :commit_id
+
+    # Name of the remote branch where changes should be picked
+    # @return [String]
+    attr_accessor :branch_name
+
+    # Indicates if all files or only modified file at specified commit point
+    # should be considered
+    # @return [DeployType]
+    attr_accessor :deploy_type
+
+    # Define the policy to follow while importing TML in the ThoughtSpot
+    # environment. Use “ALL_OR_NONE” to cancel the deployment of all ThoughtSpot
+    # objects if at least one of them fails to import. Use “Partial” to import
+    # ThoughtSpot objects that validate successfully even if other objects in
+    # the same deploy operations fail to import.
+    # @return [DeployPolicy]
+    attr_accessor :deploy_policy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['commit_id'] = 'commit_id'
+      @_hash['branch_name'] = 'branch_name'
+      @_hash['deploy_type'] = 'deploy_type'
+      @_hash['deploy_policy'] = 'deploy_policy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        commit_id
+        deploy_type
+        deploy_policy
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(branch_name:, commit_id: SKIP,
+                   deploy_type: DeployType::DELTA,
+                   deploy_policy: DeployPolicy::ALL_OR_NONE,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @commit_id = commit_id unless commit_id == SKIP
+      @branch_name = branch_name
+      @deploy_type = deploy_type unless deploy_type == SKIP
+      @deploy_policy = deploy_policy unless deploy_policy == 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.
+      branch_name = hash.key?('branch_name') ? hash['branch_name'] : nil
+      commit_id = hash.key?('commit_id') ? hash['commit_id'] : SKIP
+      deploy_type = hash['deploy_type'] ||= DeployType::DELTA
+      deploy_policy = hash['deploy_policy'] ||= DeployPolicy::ALL_OR_NONE
+
+      # 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.
+      DeployCommitRequest.new(branch_name: branch_name,
+                              commit_id: commit_id,
+                              deploy_type: deploy_type,
+                              deploy_policy: deploy_policy,
+                              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} commit_id: #{@commit_id}, branch_name: #{@branch_name}, deploy_type:"\
+      " #{@deploy_type}, deploy_policy: #{@deploy_policy}, 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} commit_id: #{@commit_id.inspect}, branch_name: #{@branch_name.inspect},"\
+      " deploy_type: #{@deploy_type.inspect}, deploy_policy: #{@deploy_policy.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/deploy_policy.rb

@@ -0,0 +1,44 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Define the policy to follow while importing TML in the ThoughtSpot
+  # environment. Use “ALL_OR_NONE” to cancel the deployment of all ThoughtSpot
+  # objects if at least one of them fails to import. Use “Partial” to import
+  # ThoughtSpot objects that validate successfully even if other objects in the
+  # same deploy operations fail to import.
+  class DeployPolicy
+    DEPLOY_POLICY = [
+      # TODO: Write general description for ALL_OR_NONE
+      ALL_OR_NONE = 'ALL_OR_NONE'.freeze,
+
+      # TODO: Write general description for PARTIAL
+      PARTIAL = 'PARTIAL'.freeze,
+
+      # TODO: Write general description for VALIDATE_ONLY
+      VALIDATE_ONLY = 'VALIDATE_ONLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ALL_OR_NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'all_or_none' then ALL_OR_NONE
+      when 'partial' then PARTIAL
+      when 'validate_only' then VALIDATE_ONLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/deploy_response.rb

@@ -0,0 +1,124 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # DeployResponse Model.
+  class DeployResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the file deployed
+    # @return [String]
+    attr_accessor :file_name
+
+    # Name of the metadata object
+    # @return [String]
+    attr_accessor :metadata_name
+
+    # Type of the metadata object
+    # @return [String]
+    attr_accessor :metadata_type
+
+    # Indicates the status of deployment for the file
+    # @return [String]
+    attr_accessor :status_code
+
+    # Any error or warning with the deployment
+    # @return [String]
+    attr_accessor :status_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_name'] = 'file_name'
+      @_hash['metadata_name'] = 'metadata_name'
+      @_hash['metadata_type'] = 'metadata_type'
+      @_hash['status_code'] = 'status_code'
+      @_hash['status_message'] = 'status_message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        file_name
+        metadata_name
+        metadata_type
+        status_code
+        status_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        file_name
+        metadata_name
+        metadata_type
+        status_code
+        status_message
+      ]
+    end
+
+    def initialize(file_name: SKIP, metadata_name: SKIP, metadata_type: SKIP,
+                   status_code: SKIP, status_message: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @file_name = file_name unless file_name == SKIP
+      @metadata_name = metadata_name unless metadata_name == SKIP
+      @metadata_type = metadata_type unless metadata_type == SKIP
+      @status_code = status_code unless status_code == SKIP
+      @status_message = status_message unless status_message == 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.
+      file_name = hash.key?('file_name') ? hash['file_name'] : SKIP
+      metadata_name = hash.key?('metadata_name') ? hash['metadata_name'] : SKIP
+      metadata_type = hash.key?('metadata_type') ? hash['metadata_type'] : SKIP
+      status_code = hash.key?('status_code') ? hash['status_code'] : SKIP
+      status_message =
+        hash.key?('status_message') ? hash['status_message'] : 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.
+      DeployResponse.new(file_name: file_name,
+                         metadata_name: metadata_name,
+                         metadata_type: metadata_type,
+                         status_code: status_code,
+                         status_message: status_message,
+                         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} file_name: #{@file_name}, metadata_name: #{@metadata_name}, metadata_type:"\
+      " #{@metadata_type}, status_code: #{@status_code}, status_message: #{@status_message},"\
+      " 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} file_name: #{@file_name.inspect}, metadata_name: #{@metadata_name.inspect},"\
+      " metadata_type: #{@metadata_type.inspect}, status_code: #{@status_code.inspect},"\
+      " status_message: #{@status_message.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/deploy_type.rb

@@ -0,0 +1,37 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Indicates if all files or only modified file at specified commit point
+  # should be considered
+  class DeployType
+    DEPLOY_TYPE = [
+      # TODO: Write general description for FULL
+      FULL = 'FULL'.freeze,
+
+      # TODO: Write general description for DELTA
+      DELTA = 'DELTA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FULL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'full' then FULL
+      when 'delta' then DELTA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/edoc_format.rb

@@ -0,0 +1,40 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # TML EDOC content format. **Note: exporting in YAML format currently requires
+  # manual formatting of the output. For more details on the workaround, please
+  # click
+  # [here](https://developers.thoughtspot.com/docs/known-issues#_version_9_12_0_
+  # cl)**
+  class EdocFormat
+    EDOC_FORMAT = [
+      # TODO: Write general description for JSON
+      JSON = 'JSON'.freeze,
+
+      # TODO: Write general description for YAML
+      YAML = 'YAML'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = JSON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'json' then JSON
+      when 'yaml' then YAML
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/edoc_format1.rb

@@ -0,0 +1,36 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # TML EDOC content format.
+  class EdocFormat1
+    EDOC_FORMAT1 = [
+      # TODO: Write general description for JSON
+      JSON = 'JSON'.freeze,
+
+      # TODO: Write general description for YAML
+      YAML = 'YAML'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = JSON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'json' then JSON
+      when 'yaml' then YAML
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/entity_header.rb

@@ -0,0 +1,103 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # EntityHeader Model.
+  class EntityHeader < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Description of the data source.
+    # @return [String]
+    attr_accessor :description
+
+    # Display name of the data source.
+    # @return [String]
+    attr_accessor :data_source_name
+
+    # Unique identifier of the data source.
+    # @return [String]
+    attr_accessor :data_source_identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['data_source_name'] = 'data_source_name'
+      @_hash['data_source_identifier'] = 'data_source_identifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        data_source_name
+        data_source_identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        data_source_name
+        data_source_identifier
+      ]
+    end
+
+    def initialize(description: SKIP, data_source_name: SKIP,
+                   data_source_identifier: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @description = description unless description == SKIP
+      @data_source_name = data_source_name unless data_source_name == SKIP
+      @data_source_identifier = data_source_identifier unless data_source_identifier == 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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      data_source_name =
+        hash.key?('data_source_name') ? hash['data_source_name'] : SKIP
+      data_source_identifier =
+        hash.key?('data_source_identifier') ? hash['data_source_identifier'] : 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.
+      EntityHeader.new(description: description,
+                       data_source_name: data_source_name,
+                       data_source_identifier: data_source_identifier,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description}, data_source_name: #{@data_source_name},"\
+      " data_source_identifier: #{@data_source_identifier}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, data_source_name:"\
+      " #{@data_source_name.inspect}, data_source_identifier: #{@data_source_identifier.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end