ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/variable_update_assignment_input.rb

@@ -0,0 +1,95 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Input for variable value update in batch operations
+  class VariableUpdateAssignmentInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID or Name of the variable
+    # @return [String]
+    attr_accessor :variable_identifier
+
+    # Values of the variable
+    # @return [Array[String]]
+    attr_accessor :variable_values
+
+    # Operation to perform
+    # @return [Operation2]
+    attr_accessor :operation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['variable_identifier'] = 'variable_identifier'
+      @_hash['variable_values'] = 'variable_values'
+      @_hash['operation'] = 'operation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(variable_identifier:, variable_values:, operation:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @variable_identifier = variable_identifier
+      @variable_values = variable_values
+      @operation = operation
+      @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.
+      variable_identifier =
+        hash.key?('variable_identifier') ? hash['variable_identifier'] : nil
+      variable_values =
+        hash.key?('variable_values') ? hash['variable_values'] : nil
+      operation = hash.key?('operation') ? hash['operation'] : 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.
+      VariableUpdateAssignmentInput.new(variable_identifier: variable_identifier,
+                                        variable_values: variable_values,
+                                        operation: operation,
+                                        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} variable_identifier: #{@variable_identifier}, variable_values:"\
+      " #{@variable_values}, operation: #{@operation}, 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} variable_identifier: #{@variable_identifier.inspect}, variable_values:"\
+      " #{@variable_values.inspect}, operation: #{@operation.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/variable_update_scope_input.rb

@@ -0,0 +1,130 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Input for defining the scope of variable value assignments in batch update
+  # operations
+  class VariableUpdateScopeInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique name of the org
+    # @return [String]
+    attr_accessor :org_identifier
+
+    # Type of principal to which the variable value applies. Use USER to assign
+    # values to a specific user, or USER_GROUP to assign values to a group.
+    # @return [PrincipalType2]
+    attr_accessor :principal_type
+
+    # Unique ID or name of the principal
+    # @return [String]
+    attr_accessor :principal_identifier
+
+    # Unique ID or name of the model. Required for FORMULA_VARIABLE type to
+    # scope the variable value to a specific worksheet.
+    # @return [String]
+    attr_accessor :model_identifier
+
+    # The priority level for this scope assignment, used for conflict resolution
+    # when multiple values match. Higher priority values (larger numbers) take
+    # precedence.
+    # @return [Integer]
+    attr_accessor :priority
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['org_identifier'] = 'org_identifier'
+      @_hash['principal_type'] = 'principal_type'
+      @_hash['principal_identifier'] = 'principal_identifier'
+      @_hash['model_identifier'] = 'model_identifier'
+      @_hash['priority'] = 'priority'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        principal_type
+        principal_identifier
+        model_identifier
+        priority
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        principal_type
+        principal_identifier
+        model_identifier
+        priority
+      ]
+    end
+
+    def initialize(org_identifier:, principal_type: SKIP,
+                   principal_identifier: SKIP, model_identifier: SKIP,
+                   priority: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @org_identifier = org_identifier
+      @principal_type = principal_type unless principal_type == SKIP
+      @principal_identifier = principal_identifier unless principal_identifier == SKIP
+      @model_identifier = model_identifier unless model_identifier == SKIP
+      @priority = priority unless priority == 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_identifier =
+        hash.key?('org_identifier') ? hash['org_identifier'] : nil
+      principal_type =
+        hash.key?('principal_type') ? hash['principal_type'] : SKIP
+      principal_identifier =
+        hash.key?('principal_identifier') ? hash['principal_identifier'] : SKIP
+      model_identifier =
+        hash.key?('model_identifier') ? hash['model_identifier'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : 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.
+      VariableUpdateScopeInput.new(org_identifier: org_identifier,
+                                   principal_type: principal_type,
+                                   principal_identifier: principal_identifier,
+                                   model_identifier: model_identifier,
+                                   priority: priority,
+                                   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_identifier: #{@org_identifier}, principal_type: #{@principal_type},"\
+      " principal_identifier: #{@principal_identifier}, model_identifier: #{@model_identifier},"\
+      " priority: #{@priority}, 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_identifier: #{@org_identifier.inspect}, principal_type:"\
+      " #{@principal_type.inspect}, principal_identifier: #{@principal_identifier.inspect},"\
+      " model_identifier: #{@model_identifier.inspect}, priority: #{@priority.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/variable_value.rb

@@ -0,0 +1,151 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # VariableValue Model.
+  class VariableValue < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value of the variable
+    # @return [String]
+    attr_accessor :value
+
+    # The value of the variable if it is a list type
+    # @return [Array[String]]
+    attr_accessor :value_list
+
+    # The unique name of the org
+    # @return [String]
+    attr_accessor :org_identifier
+
+    # Type of principal to which this value applies. Use USER to assign the
+    # value to a specific user, or USER_GROUP to assign it to a group.
+    # @return [PrincipalType1]
+    attr_accessor :principal_type
+
+    # Unique ID or name of the principal
+    # @return [String]
+    attr_accessor :principal_identifier
+
+    # Unique ID of the model <br/> <span class="since-beta-tag">Beta</span>
+    # <span class="since-beta-tag">Version: 26.3.0.cl or later</span>
+    # @return [String]
+    attr_accessor :model_identifier
+
+    # The priority assigned to this value. If there are 2 matching values, the
+    # one with the higher priority will be picked.
+    # @return [Integer]
+    attr_accessor :priority
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash['value_list'] = 'value_list'
+      @_hash['org_identifier'] = 'org_identifier'
+      @_hash['principal_type'] = 'principal_type'
+      @_hash['principal_identifier'] = 'principal_identifier'
+      @_hash['model_identifier'] = 'model_identifier'
+      @_hash['priority'] = 'priority'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        value
+        value_list
+        principal_type
+        principal_identifier
+        model_identifier
+        priority
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        value
+        value_list
+        principal_type
+        principal_identifier
+        model_identifier
+        priority
+      ]
+    end
+
+    def initialize(org_identifier:, value: SKIP, value_list: SKIP,
+                   principal_type: SKIP, principal_identifier: SKIP,
+                   model_identifier: SKIP, priority: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @value = value unless value == SKIP
+      @value_list = value_list unless value_list == SKIP
+      @org_identifier = org_identifier
+      @principal_type = principal_type unless principal_type == SKIP
+      @principal_identifier = principal_identifier unless principal_identifier == SKIP
+      @model_identifier = model_identifier unless model_identifier == SKIP
+      @priority = priority unless priority == 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_identifier =
+        hash.key?('org_identifier') ? hash['org_identifier'] : nil
+      value = hash.key?('value') ? hash['value'] : SKIP
+      value_list = hash.key?('value_list') ? hash['value_list'] : SKIP
+      principal_type =
+        hash.key?('principal_type') ? hash['principal_type'] : SKIP
+      principal_identifier =
+        hash.key?('principal_identifier') ? hash['principal_identifier'] : SKIP
+      model_identifier =
+        hash.key?('model_identifier') ? hash['model_identifier'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : 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.
+      VariableValue.new(org_identifier: org_identifier,
+                        value: value,
+                        value_list: value_list,
+                        principal_type: principal_type,
+                        principal_identifier: principal_identifier,
+                        model_identifier: model_identifier,
+                        priority: priority,
+                        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} value: #{@value}, value_list: #{@value_list}, org_identifier:"\
+      " #{@org_identifier}, principal_type: #{@principal_type}, principal_identifier:"\
+      " #{@principal_identifier}, model_identifier: #{@model_identifier}, priority: #{@priority},"\
+      " 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} value: #{@value.inspect}, value_list: #{@value_list.inspect},"\
+      " org_identifier: #{@org_identifier.inspect}, principal_type: #{@principal_type.inspect},"\
+      " principal_identifier: #{@principal_identifier.inspect}, model_identifier:"\
+      " #{@model_identifier.inspect}, priority: #{@priority.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/variable_values.rb

@@ -0,0 +1,106 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Variable values.
+  class VariableValues < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the existing formula variable.
+    # @return [String]
+    attr_accessor :name
+
+    # The values to filter on.
+    # @return [Array[Object]]
+    attr_accessor :values
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['values'] = 'values'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, values:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @values = values
+      @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.
+      name = hash.key?('name') ? hash['name'] : nil
+      values = hash.key?('values') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:VariableValuesValues), hash['values']
+      ) : 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.
+      VariableValues.new(name: name,
+                         values: values,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VariableValues | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.name,
+                                ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:VariableValuesValues)
+                           .validate(value.values)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:VariableValuesValues)
+                         .validate(value['values'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, values: #{@values}, 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} name: #{@name.inspect}, values: #{@values.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/visibility.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
+  # Visibility of the users. The `SHARABLE` property makes a user visible to
+  # other users and group, who can share objects with the user.
+  class Visibility
+    VISIBILITY = [
+      # TODO: Write general description for SHARABLE
+      SHARABLE = 'SHARABLE'.freeze,
+
+      # TODO: Write general description for NON_SHARABLE
+      NON_SHARABLE = 'NON_SHARABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SHARABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sharable' then SHARABLE
+      when 'non_sharable' then NON_SHARABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/visibility1.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
+  # Visibility of the Org.
+  class Visibility1
+    VISIBILITY1 = [
+      # TODO: Write general description for SHOW
+      SHOW = 'SHOW'.freeze,
+
+      # TODO: Write general description for HIDDEN
+      HIDDEN = 'HIDDEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SHOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'show' then SHOW
+      when 'hidden' then HIDDEN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/visibility10.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
+  # Visibility of the user
+  class Visibility10
+    VISIBILITY10 = [
+      # TODO: Write general description for SHARABLE
+      SHARABLE = 'SHARABLE'.freeze,
+
+      # TODO: Write general description for NON_SHARABLE
+      NON_SHARABLE = 'NON_SHARABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SHARABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sharable' then SHARABLE
+      when 'non_sharable' then NON_SHARABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/visibility2.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
+  # Visibility of the group. The SHARABLE makes a group visible to other users
+  # and groups, and thus allows them to share objects.
+  class Visibility2
+    VISIBILITY2 = [
+      # TODO: Write general description for SHARABLE
+      SHARABLE = 'SHARABLE'.freeze,
+
+      # TODO: Write general description for NON_SHARABLE
+      NON_SHARABLE = 'NON_SHARABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SHARABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sharable' then SHARABLE
+      when 'non_sharable' then NON_SHARABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/visibility3.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
+  # Visibility of the users. The SHARABLE property makes a user visible to other
+  # users and group, who can share objects with the user.
+  class Visibility3
+    VISIBILITY3 = [
+      # TODO: Write general description for SHARABLE
+      SHARABLE = 'SHARABLE'.freeze,
+
+      # TODO: Write general description for NON_SHARABLE
+      NON_SHARABLE = 'NON_SHARABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SHARABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sharable' then SHARABLE
+      when 'non_sharable' then NON_SHARABLE
+      else
+        default_value
+      end
+    end
+  end
+end