tremendous_ruby 5.3.0 → 5.4.0

data/lib/tremendous/models/{reward_with_link_delivery.rb → fraud_review_list_item.rb}

@@ -14,16 +14,15 @@ require 'date'
 require 'time'
 
 module Tremendous
-  # Details on how the reward is delivered to the recipient. 
-  class RewardWithLinkDelivery
-    # How to deliver the reward to the recipient.  <table>   <thead>     <tr>       <th>Delivery Method</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>EMAIL</code></td>       <td>Deliver the reward to the recipient by email</td>     </tr>     <tr>       <td><code>LINK</code></td>       <td>         <p>Deliver the reward to the recipient via a link.</p>         <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be  delivered to the recipient out-of-band.</p>       </td>     </tr>     <tr>       <td><code>PHONE</code></td>       <td>Deliver the reward to the recipient by SMS</td>     </tr>   </tbody> </table> 
-    attr_accessor :method
-
-    # Current status of the delivery of the reward:  * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link opened). * `PENDING` - Delivery is pending but not yet scheduled. 
+  # The fraud review associated with a reward.
+  class FraudReviewListItem
+    # 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
 
-    # Link to redeem the reward at. You need to deliver this link to the recipient.  Only available for rewards for which the `method` for delivery is set to `LINK`. 
-    attr_accessor :link
+    # 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` * `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
+
+    attr_accessor :reward
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -50,9 +49,9 @@ module Tremendous
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'method' => :'method',
         :'status' => :'status',
-        :'link' => :'link'
+        :'reasons' => :'reasons',
+        :'reward' => :'reward'
       }
     end
 
@@ -64,9 +63,9 @@ module Tremendous
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'method' => :'String',
         :'status' => :'String',
-        :'link' => :'String'
+        :'reasons' => :'Array<String>',
+        :'reward' => :'OrderWithoutLinkReward'
       }
     end
 
@@ -80,31 +79,29 @@ module Tremendous
     # @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::RewardWithLinkDelivery` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::FraudReviewListItem` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::RewardWithLinkDelivery`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::FraudReviewListItem`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'method')
-        self.method = attributes[:'method']
-      else
-        self.method = nil
-      end
-
       if attributes.key?(:'status')
         self.status = attributes[:'status']
-      else
-        self.status = nil
       end
 
-      if attributes.key?(:'link')
-        self.link = attributes[:'link']
+      if attributes.key?(:'reasons')
+        if (value = attributes[:'reasons']).is_a?(Array)
+          self.reasons = value
+        end
+      end
+
+      if attributes.key?(:'reward')
+        self.reward = attributes[:'reward']
       end
     end
 
@@ -113,14 +110,6 @@ module Tremendous
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @method.nil?
-        invalid_properties.push('invalid value for "method", method cannot be nil.')
-      end
-
-      if @status.nil?
-        invalid_properties.push('invalid value for "status", status cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -128,29 +117,15 @@ module Tremendous
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @method.nil?
-      method_validator = EnumAttributeValidator.new('String', ["EMAIL", "LINK", "PHONE"])
-      return false unless method_validator.valid?(@method)
-      return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["SCHEDULED", "FAILED", "SUCCEEDED", "PENDING"])
+      status_validator = EnumAttributeValidator.new('String', ["flagged", "blocked", "released"])
       return false unless status_validator.valid?(@status)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] method Object to be assigned
-    def method=(method)
-      validator = EnumAttributeValidator.new('String', ["EMAIL", "LINK", "PHONE"])
-      unless validator.valid?(method)
-        fail ArgumentError, "invalid value for \"method\", must be one of #{validator.allowable_values}."
-      end
-      @method = method
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["SCHEDULED", "FAILED", "SUCCEEDED", "PENDING"])
+      validator = EnumAttributeValidator.new('String', ["flagged", "blocked", "released"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
@@ -162,9 +137,9 @@ module Tremendous
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          method == o.method &&
           status == o.status &&
-          link == o.link
+          reasons == o.reasons &&
+          reward == o.reward
     end
 
     # @see the `==` method
@@ -176,7 +151,7 @@ module Tremendous
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [method, status, link].hash
+      [status, reasons, reward].hash
     end
 
     # Builds the object from hash

data/lib/tremendous/models/fraud_review_reason.rb

@@ -0,0 +1,58 @@
+=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 it's 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
+OpenAPI Generator version: 7.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  class FraudReviewReason
+    DISALLOWED_IP = "Disallowed IP".freeze
+    DISALLOWED_EMAIL = "Disallowed email".freeze
+    DISALLOWED_COUNTRY = "Disallowed country".freeze
+    OVER_REWARD_DOLLAR_LIMIT = "Over reward dollar limit".freeze
+    OVER_REWARD_COUNT_LIMIT = "Over reward count limit".freeze
+    VPN_DETECTED = "VPN detected".freeze
+    DEVICE_RELATED_TO_MULTIPLE_EMAILS = "Device related to multiple emails".freeze
+    DEVICE_OR_ACCOUNT_RELATED_TO_MULTIPLE_EMAILS = "Device or account related to multiple emails".freeze
+    IP_ON_A_TREMENDOUS_FRAUD_LIST = "IP on a Tremendous fraud list".freeze
+    BANK_ACCOUNT_ON_A_TREMENDOUS_FRAUD_LIST = "Bank account on a Tremendous fraud list".freeze
+    FINGERPRINT_ON_A_TREMENDOUS_FRAUD_LIST = "Fingerprint on a Tremendous fraud list".freeze
+    EMAIL_ON_A_TREMENDOUS_FRAUD_LIST = "Email on a Tremendous fraud list".freeze
+    PHONE_ON_A_TREMENDOUS_FRAUD_LIST = "Phone on a Tremendous fraud list".freeze
+    IP_RELATED_TO_A_BLOCKED_REWARD = "IP related to a blocked reward".freeze
+    BANK_ACCOUNT_RELATED_TO_A_BLOCKED_REWARD = "Bank account related to a blocked reward".freeze
+    FINGERPRINT_RELATED_TO_A_BLOCKED_REWARD = "Fingerprint related to a blocked reward".freeze
+    EMAIL_RELATED_TO_A_BLOCKED_REWARD = "Email related to a blocked reward".freeze
+    PHONE_RELATED_TO_A_BLOCKED_REWARD = "Phone related to a blocked reward".freeze
+    ALLOWED_IP = "Allowed IP".freeze
+    ALLOWED_EMAIL = "Allowed email".freeze
+
+    def self.all_vars
+      @all_vars ||= [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, 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].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if FraudReviewReason.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #FraudReviewReason"
+    end
+  end
+end

data/lib/tremendous/models/fraud_review_redemption_method.rb

@@ -0,0 +1,44 @@
+=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 it's 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
+OpenAPI Generator version: 7.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  class FraudReviewRedemptionMethod
+    PAYPAL = "paypal".freeze
+    BANK = "bank".freeze
+    MERCHANT_CARD = "merchant card".freeze
+    VISA_CARD = "visa card".freeze
+    CHARITY = "charity".freeze
+    VENMO = "venmo".freeze
+
+    def self.all_vars
+      @all_vars ||= [PAYPAL, BANK, MERCHANT_CARD, VISA_CARD, CHARITY, VENMO].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if FraudReviewRedemptionMethod.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #FraudReviewRedemptionMethod"
+    end
+  end
+end

data/lib/tremendous/models/fraud_review_related_rewards.rb

@@ -0,0 +1,304 @@
+=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 it's 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
+OpenAPI Generator version: 7.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  class FraudReviewRelatedRewards
+    # The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned. 
+    attr_accessor :ids
+
+    # How many related rewards were found in total.
+    attr_accessor :count
+
+    # How many related rewards have been blocked.
+    attr_accessor :blocked_count
+
+    # Total amount claimed by the related rewards (in USD).
+    attr_accessor :aggregated_value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ids' => :'ids',
+        :'count' => :'count',
+        :'blocked_count' => :'blocked_count',
+        :'aggregated_value' => :'aggregated_value'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ids' => :'Array<String>',
+        :'count' => :'Float',
+        :'blocked_count' => :'Float',
+        :'aggregated_value' => :'Float'
+      }
+    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::FraudReviewRelatedRewards` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::FraudReviewRelatedRewards`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'ids')
+        if (value = attributes[:'ids']).is_a?(Array)
+          self.ids = value
+        end
+      end
+
+      if attributes.key?(:'count')
+        self.count = attributes[:'count']
+      end
+
+      if attributes.key?(:'blocked_count')
+        self.blocked_count = attributes[:'blocked_count']
+      end
+
+      if attributes.key?(:'aggregated_value')
+        self.aggregated_value = attributes[:'aggregated_value']
+      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
+      if !@count.nil? && @count < 0
+        invalid_properties.push('invalid value for "count", must be greater than or equal to 0.')
+      end
+
+      if !@blocked_count.nil? && @blocked_count < 0
+        invalid_properties.push('invalid value for "blocked_count", must be greater than or equal to 0.')
+      end
+
+      if !@aggregated_value.nil? && @aggregated_value < 0
+        invalid_properties.push('invalid value for "aggregated_value", must be greater than or equal to 0.')
+      end
+
+      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'
+      return false if !@count.nil? && @count < 0
+      return false if !@blocked_count.nil? && @blocked_count < 0
+      return false if !@aggregated_value.nil? && @aggregated_value < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] count Value to be assigned
+    def count=(count)
+      if count.nil?
+        fail ArgumentError, 'count cannot be nil'
+      end
+
+      if count < 0
+        fail ArgumentError, 'invalid value for "count", must be greater than or equal to 0.'
+      end
+
+      @count = count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] blocked_count Value to be assigned
+    def blocked_count=(blocked_count)
+      if blocked_count.nil?
+        fail ArgumentError, 'blocked_count cannot be nil'
+      end
+
+      if blocked_count < 0
+        fail ArgumentError, 'invalid value for "blocked_count", must be greater than or equal to 0.'
+      end
+
+      @blocked_count = blocked_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] aggregated_value Value to be assigned
+    def aggregated_value=(aggregated_value)
+      if aggregated_value.nil?
+        fail ArgumentError, 'aggregated_value cannot be nil'
+      end
+
+      if aggregated_value < 0
+        fail ArgumentError, 'invalid value for "aggregated_value", must be greater than or equal to 0.'
+      end
+
+      @aggregated_value = aggregated_value
+    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 &&
+          ids == o.ids &&
+          count == o.count &&
+          blocked_count == o.blocked_count &&
+          aggregated_value == o.aggregated_value
+    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
+      [ids, count, blocked_count, aggregated_value].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/models/fraud_review_status.rb

@@ -0,0 +1,41 @@
+=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 it's 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
+OpenAPI Generator version: 7.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  class FraudReviewStatus
+    FLAGGED = "flagged".freeze
+    BLOCKED = "blocked".freeze
+    RELEASED = "released".freeze
+
+    def self.all_vars
+      @all_vars ||= [FLAGGED, BLOCKED, RELEASED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if FraudReviewStatus.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #FraudReviewStatus"
+    end
+  end
+end