tremendous_ruby 5.13.0 → 5.15.0

data/lib/tremendous/models/get_fraud_review200_response_fraud_review.rb

@@ -19,20 +19,9 @@ module Tremendous
     # The current status of the fraud review:  * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. 
     attr_accessor :status
 
-    # The fraud risk associated with the reward.
-    attr_accessor :risk
-
     # The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following:  * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` 
     attr_accessor :reasons
 
-    # The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days.  This field is only present if the status is not `flagged`. 
-    attr_accessor :reviewed_by
-
-    # When the reward was blocked or released following fraud review.  This field is only present if the status is not `flagged`. 
-    attr_accessor :reviewed_at
-
-    attr_accessor :related_rewards
-
     # The device fingerprint, if known.
     attr_accessor :device_id
 
@@ -46,6 +35,20 @@ module Tremendous
 
     attr_accessor :reward
 
+    # The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days.  This field is only present if the status is not `flagged`. 
+    attr_accessor :reviewed_by
+
+    # When the reward was blocked or released following fraud review.  This field is only present if the status is not `flagged`. 
+    attr_accessor :reviewed_at
+
+    # A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don't have a destination account (e.g., merchant cards, charities, etc.). 
+    attr_accessor :redemption_method_account_hash
+
+    # The fraud risk associated with the reward.
+    attr_accessor :risk
+
+    attr_accessor :related_rewards
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -72,16 +75,17 @@ module Tremendous
     def self.attribute_map
       {
         :'status' => :'status',
-        :'risk' => :'risk',
         :'reasons' => :'reasons',
-        :'reviewed_by' => :'reviewed_by',
-        :'reviewed_at' => :'reviewed_at',
-        :'related_rewards' => :'related_rewards',
         :'device_id' => :'device_id',
         :'redemption_method' => :'redemption_method',
         :'redeemed_at' => :'redeemed_at',
         :'geo' => :'geo',
-        :'reward' => :'reward'
+        :'reward' => :'reward',
+        :'reviewed_by' => :'reviewed_by',
+        :'reviewed_at' => :'reviewed_at',
+        :'redemption_method_account_hash' => :'redemption_method_account_hash',
+        :'risk' => :'risk',
+        :'related_rewards' => :'related_rewards'
       }
     end
 
@@ -99,16 +103,17 @@ module Tremendous
     def self.openapi_types
       {
         :'status' => :'String',
-        :'risk' => :'String',
         :'reasons' => :'Array<String>',
-        :'reviewed_by' => :'String',
-        :'reviewed_at' => :'Time',
-        :'related_rewards' => :'GetFraudReview200ResponseFraudReviewRelatedRewards',
         :'device_id' => :'String',
         :'redemption_method' => :'String',
         :'redeemed_at' => :'Time',
-        :'geo' => :'GetFraudReview200ResponseFraudReviewGeo',
-        :'reward' => :'ListRewards200ResponseRewardsInner'
+        :'geo' => :'ListFraudReviews200ResponseFraudReviewsInnerGeo',
+        :'reward' => :'ListRewards200ResponseRewardsInner',
+        :'reviewed_by' => :'String',
+        :'reviewed_at' => :'Time',
+        :'redemption_method_account_hash' => :'String',
+        :'risk' => :'String',
+        :'related_rewards' => :'GetFraudReview200ResponseFraudReviewRelatedRewards'
       }
     end
 
@@ -138,28 +143,12 @@ module Tremendous
         self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'risk')
-        self.risk = attributes[:'risk']
-      end
-
       if attributes.key?(:'reasons')
         if (value = attributes[:'reasons']).is_a?(Array)
           self.reasons = value
         end
       end
 
-      if attributes.key?(:'reviewed_by')
-        self.reviewed_by = attributes[:'reviewed_by']
-      end
-
-      if attributes.key?(:'reviewed_at')
-        self.reviewed_at = attributes[:'reviewed_at']
-      end
-
-      if attributes.key?(:'related_rewards')
-        self.related_rewards = attributes[:'related_rewards']
-      end
-
       if attributes.key?(:'device_id')
         self.device_id = attributes[:'device_id']
       end
@@ -179,6 +168,26 @@ module Tremendous
       if attributes.key?(:'reward')
         self.reward = attributes[:'reward']
       end
+
+      if attributes.key?(:'reviewed_by')
+        self.reviewed_by = attributes[:'reviewed_by']
+      end
+
+      if attributes.key?(:'reviewed_at')
+        self.reviewed_at = attributes[:'reviewed_at']
+      end
+
+      if attributes.key?(:'redemption_method_account_hash')
+        self.redemption_method_account_hash = attributes[:'redemption_method_account_hash']
+      end
+
+      if attributes.key?(:'risk')
+        self.risk = attributes[:'risk']
+      end
+
+      if attributes.key?(:'related_rewards')
+        self.related_rewards = attributes[:'related_rewards']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -195,10 +204,10 @@ module Tremendous
       warn '[DEPRECATED] the `valid?` method is obsolete'
       status_validator = EnumAttributeValidator.new('String', ["flagged", "blocked", "released"])
       return false unless status_validator.valid?(@status)
+      redemption_method_validator = EnumAttributeValidator.new('String', ["bank transfer", "charity", "instant debit transfer", "international bank transfer", "merchant card", "paypal", "venmo", "visa card"])
+      return false unless redemption_method_validator.valid?(@redemption_method)
       risk_validator = EnumAttributeValidator.new('String', ["high", "medium", "low"])
       return false unless risk_validator.valid?(@risk)
-      redemption_method_validator = EnumAttributeValidator.new('String', ["paypal", "bank", "merchant card", "visa card", "charity", "venmo"])
-      return false unless redemption_method_validator.valid?(@redemption_method)
       true
     end
 
@@ -212,6 +221,16 @@ module Tremendous
       @status = status
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] redemption_method Object to be assigned
+    def redemption_method=(redemption_method)
+      validator = EnumAttributeValidator.new('String', ["bank transfer", "charity", "instant debit transfer", "international bank transfer", "merchant card", "paypal", "venmo", "visa card"])
+      unless validator.valid?(redemption_method)
+        fail ArgumentError, "invalid value for \"redemption_method\", must be one of #{validator.allowable_values}."
+      end
+      @redemption_method = redemption_method
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] risk Object to be assigned
     def risk=(risk)
@@ -222,32 +241,23 @@ module Tremendous
       @risk = risk
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] redemption_method Object to be assigned
-    def redemption_method=(redemption_method)
-      validator = EnumAttributeValidator.new('String', ["paypal", "bank", "merchant card", "visa card", "charity", "venmo"])
-      unless validator.valid?(redemption_method)
-        fail ArgumentError, "invalid value for \"redemption_method\", must be one of #{validator.allowable_values}."
-      end
-      @redemption_method = redemption_method
-    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 &&
           status == o.status &&
-          risk == o.risk &&
           reasons == o.reasons &&
-          reviewed_by == o.reviewed_by &&
-          reviewed_at == o.reviewed_at &&
-          related_rewards == o.related_rewards &&
           device_id == o.device_id &&
           redemption_method == o.redemption_method &&
           redeemed_at == o.redeemed_at &&
           geo == o.geo &&
-          reward == o.reward
+          reward == o.reward &&
+          reviewed_by == o.reviewed_by &&
+          reviewed_at == o.reviewed_at &&
+          redemption_method_account_hash == o.redemption_method_account_hash &&
+          risk == o.risk &&
+          related_rewards == o.related_rewards
     end
 
     # @see the `==` method
@@ -259,7 +269,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, risk, reasons, reviewed_by, reviewed_at, related_rewards, device_id, redemption_method, redeemed_at, geo, reward].hash
+      [status, reasons, device_id, redemption_method, redeemed_at, geo, reward, reviewed_by, reviewed_at, redemption_method_account_hash, risk, related_rewards].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/invoice.rb

@@ -22,9 +22,12 @@ module Tremendous
     # Reference to the purchase order number within your organization
     attr_accessor :po_number
 
-    # Amount of the invoice in USD
+    # Amount of the invoice
     attr_accessor :amount
 
+    # Currency of the invoice
+    attr_accessor :currency
+
     attr_accessor :international
 
     # Status of this invoice  <table>   <thead>     <tr>       <th>Status</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>DELETED</code></td>       <td>Invoice has been deleted by your organization</td>     </tr>     <tr>       <td><code>PAID</code></td>       <td>Invoice has been paid by your organization</td>     </tr>     <tr>       <td><code>OPEN</code></td>       <td>Invoice has been created by your organization but has not been paid, yet</td>     </tr>   </tbody> </table> 
@@ -70,6 +73,7 @@ module Tremendous
         :'id' => :'id',
         :'po_number' => :'po_number',
         :'amount' => :'amount',
+        :'currency' => :'currency',
         :'international' => :'international',
         :'status' => :'status',
         :'orders' => :'orders',
@@ -95,6 +99,7 @@ module Tremendous
         :'id' => :'String',
         :'po_number' => :'String',
         :'amount' => :'Float',
+        :'currency' => :'String',
         :'international' => :'Boolean',
         :'status' => :'String',
         :'orders' => :'Array<String>',
@@ -144,6 +149,12 @@ module Tremendous
         self.amount = nil
       end
 
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = 'USD'
+      end
+
       if attributes.key?(:'international')
         self.international = attributes[:'international']
       end
@@ -209,6 +220,8 @@ module Tremendous
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @amount.nil?
+      currency_validator = EnumAttributeValidator.new('String', ["USD", "EUR", "GBP"])
+      return false unless currency_validator.valid?(@currency)
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["DELETED", "PAID", "OPEN", "MARKED_AS_PAID"])
       return false unless status_validator.valid?(@status)
@@ -236,6 +249,16 @@ module Tremendous
       @amount = amount
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] currency Object to be assigned
+    def currency=(currency)
+      validator = EnumAttributeValidator.new('String', ["USD", "EUR", "GBP"])
+      unless validator.valid?(currency)
+        fail ArgumentError, "invalid value for \"currency\", must be one of #{validator.allowable_values}."
+      end
+      @currency = currency
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -264,6 +287,7 @@ module Tremendous
           id == o.id &&
           po_number == o.po_number &&
           amount == o.amount &&
+          currency == o.currency &&
           international == o.international &&
           status == o.status &&
           orders == o.orders &&
@@ -281,7 +305,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, po_number, amount, international, status, orders, rewards, created_at, paid_at].hash
+      [id, po_number, amount, currency, international, status, orders, rewards, created_at, paid_at].hash
     end
 
     # Builds the object from hash

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