tremendous_ruby 5.14.0 → 5.15.0

data/lib/tremendous/models/list_fields200_response_fields_inner.rb

@@ -20,7 +20,7 @@ module Tremendous
     # Label of the field
     attr_accessor :label
 
-    # Type of the values of the field
+    # Type of the values of the field  <table>   <thead>     <tr>       <th>Type</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>Checkbox</code></td>       <td>A boolean value (true/false)</td>     </tr>     <tr>       <td><code>Currency</code></td>       <td>A monetary value</td>     </tr>     <tr>       <td><code>Date</code></td>       <td>A date value</td>     </tr>     <tr>       <td><code>Dropdown</code></td>       <td>A single selection from predefined options (see <code>data.options</code>)</td>     </tr>     <tr>       <td><code>Email</code></td>       <td>An email address</td>     </tr>     <tr>       <td><code>List</code></td>       <td>Multiple selections from predefined options (see <code>data.options</code>)</td>     </tr>     <tr>       <td><code>Number</code></td>       <td>A numeric value</td>     </tr>     <tr>       <td><code>Phone</code></td>       <td>A phone number</td>     </tr>     <tr>       <td><code>Text</code></td>       <td>A single-line text value</td>     </tr>     <tr>       <td><code>TextArea</code></td>       <td>A multi-line text value</td>     </tr>   </tbody> </table> 
     attr_accessor :data_type
 
     attr_accessor :data
@@ -31,6 +31,28 @@ module Tremendous
     # Type of objects this field gets associated with
     attr_accessor :scope
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -59,7 +81,7 @@ module Tremendous
         :'id' => :'String',
         :'label' => :'String',
         :'data_type' => :'String',
-        :'data' => :'Hash<String, Object>',
+        :'data' => :'ListFields200ResponseFieldsInnerData',
         :'required' => :'Boolean',
         :'scope' => :'String'
       }
@@ -100,9 +122,7 @@ module Tremendous
       end
 
       if attributes.key?(:'data')
-        if (value = attributes[:'data']).is_a?(Hash)
-          self.data = value
-        end
+        self.data = attributes[:'data']
       end
 
       if attributes.key?(:'required')
@@ -132,6 +152,8 @@ module Tremendous
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@id.nil? && @id !~ Regexp.new(/[A-Z0-9]{4,20}/)
+      data_type_validator = EnumAttributeValidator.new('String', ["Checkbox", "Currency", "Date", "Dropdown", "Email", "List", "Number", "Phone", "Text", "TextArea"])
+      return false unless data_type_validator.valid?(@data_type)
       true
     end
 
@@ -150,6 +172,16 @@ module Tremendous
       @id = id
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] data_type Object to be assigned
+    def data_type=(data_type)
+      validator = EnumAttributeValidator.new('String', ["Checkbox", "Currency", "Date", "Dropdown", "Email", "List", "Number", "Phone", "Text", "TextArea"])
+      unless validator.valid?(data_type)
+        fail ArgumentError, "invalid value for \"data_type\", must be one of #{validator.allowable_values}."
+      end
+      @data_type = data_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/tremendous/models/list_fields200_response_fields_inner_data.rb

@@ -0,0 +1,236 @@
+=begin
+#API Endpoints
+
+#Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and its members within Tremendous, please see the Tremendous Organizational API.
+
+The version of the OpenAPI document: 2
+Contact: developers@tremendous.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  # Additional configuration for the field. Only used for `Dropdown` and `List` data types. 
+  class ListFields200ResponseFieldsInnerData
+    # List of valid options for `Dropdown` and `List` field types. For `Dropdown`, the user selects one option. For `List`, the user can select multiple options. 
+    attr_accessor :options
+
+    # Optional human-readable labels for each option. Keys are the option values, values are the display labels. If not provided, the option values are used as labels. 
+    attr_accessor :labels
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'options' => :'options',
+        :'labels' => :'labels'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'options' => :'Array<String>',
+        :'labels' => :'Hash<String, String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::ListFields200ResponseFieldsInnerData` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::ListFields200ResponseFieldsInnerData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'options')
+        if (value = attributes[:'options']).is_a?(Array)
+          self.options = value
+        end
+      end
+
+      if attributes.key?(:'labels')
+        if (value = attributes[:'labels']).is_a?(Hash)
+          self.labels = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          options == o.options &&
+          labels == o.labels
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [options, labels].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Tremendous.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/tremendous/version.rb

@@ -1,3 +1,3 @@
 module Tremendous
-  VERSION = "5.14.0"
+  VERSION = "5.15.0"
 end

data/lib/tremendous.rb

@@ -43,6 +43,10 @@ require 'tremendous/models/create_connected_organization_member_session200_respo
 require 'tremendous/models/create_connected_organization_member_session200_response_connected_organization_member_session'
 require 'tremendous/models/create_connected_organization_member_session_request'
 require 'tremendous/models/create_connected_organization_request'
+require 'tremendous/models/create_field'
+require 'tremendous/models/create_field200_response'
+require 'tremendous/models/create_field_request'
+require 'tremendous/models/create_field_request_data'
 require 'tremendous/models/create_invoice200_response'
 require 'tremendous/models/create_invoice_request'
 require 'tremendous/models/create_member'
@@ -140,6 +144,7 @@ require 'tremendous/models/list_connected_organizations200_response_connected_or
 require 'tremendous/models/list_connected_organizations200_response_connected_organizations_inner_organization'
 require 'tremendous/models/list_fields200_response'
 require 'tremendous/models/list_fields200_response_fields_inner'
+require 'tremendous/models/list_fields200_response_fields_inner_data'
 require 'tremendous/models/list_forex_response'
 require 'tremendous/models/list_fraud_reviews200_response'
 require 'tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tremendous_ruby
 version: !ruby/object:Gem::Version
-  version: 5.14.0
+  version: 5.15.0
 platform: ruby
 authors:
 - Tremendous Developers
@@ -81,6 +81,10 @@ files:
 - lib/tremendous/models/create_connected_organization_member_session200_response_connected_organization_member_session.rb
 - lib/tremendous/models/create_connected_organization_member_session_request.rb
 - lib/tremendous/models/create_connected_organization_request.rb
+- lib/tremendous/models/create_field.rb
+- lib/tremendous/models/create_field200_response.rb
+- lib/tremendous/models/create_field_request.rb
+- lib/tremendous/models/create_field_request_data.rb
 - lib/tremendous/models/create_invoice200_response.rb
 - lib/tremendous/models/create_invoice_request.rb
 - lib/tremendous/models/create_member.rb
@@ -184,6 +188,7 @@ files:
 - lib/tremendous/models/list_connected_organizations200_response_connected_organizations_inner_organization.rb
 - lib/tremendous/models/list_fields200_response.rb
 - lib/tremendous/models/list_fields200_response_fields_inner.rb
+- lib/tremendous/models/list_fields200_response_fields_inner_data.rb
 - lib/tremendous/models/list_forex_response.rb
 - lib/tremendous/models/list_fraud_reviews200_response.rb
 - lib/tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner.rb