tremendous_ruby 5.3.0 → 5.5.0

data/lib/tremendous/models/review_redeemed_rewards_count.rb

@@ -0,0 +1,293 @@
+=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
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  # If a recipient, device, or IP redeems more than this number of rewards, flag for review.
+  class ReviewRedeemedRewardsCount
+    # The number of redeemed rewards to use as a threshold.
+    attr_accessor :amount
+
+    # The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
+    attr_accessor :period
+
+    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
+      {
+        :'amount' => :'amount',
+        :'period' => :'period'
+      }
+    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
+      {
+        :'amount' => :'Integer',
+        :'period' => :'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::ReviewRedeemedRewardsCount` 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::ReviewRedeemedRewardsCount`. 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?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      else
+        self.period = nil
+      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 @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @amount < 1
+        invalid_properties.push('invalid value for "amount", must be greater than or equal to 1.')
+      end
+
+      if @period.nil?
+        invalid_properties.push('invalid value for "period", period cannot be nil.')
+      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 @amount.nil?
+      return false if @amount < 1
+      return false if @period.nil?
+      period_validator = EnumAttributeValidator.new('String', ["7", "30", "90", "120", "365", "all_time"])
+      return false unless period_validator.valid?(@period)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if amount.nil?
+        fail ArgumentError, 'amount cannot be nil'
+      end
+
+      if amount < 1
+        fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 1.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] period Object to be assigned
+    def period=(period)
+      validator = EnumAttributeValidator.new('String', ["7", "30", "90", "120", "365", "all_time"])
+      unless validator.valid?(period)
+        fail ArgumentError, "invalid value for \"period\", must be one of #{validator.allowable_values}."
+      end
+      @period = period
+    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 &&
+          amount == o.amount &&
+          period == o.period
+    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
+      [amount, period].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/reward.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -170,11 +170,6 @@ module Tremendous
         invalid_properties.push('invalid value for "products", number of items must be greater than or equal to 1.')
       end
 
-      pattern = Regexp.new(/YYYY-MM-DD/)
-      if !@deliver_at.nil? && @deliver_at !~ pattern
-        invalid_properties.push("invalid value for \"deliver_at\", must conform to the pattern #{pattern}.")
-      end
-
       invalid_properties
     end
 
@@ -186,7 +181,6 @@ module Tremendous
       return false if !@order_id.nil? && @order_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if !@products.nil? && @products.length < 1
-      return false if !@deliver_at.nil? && @deliver_at !~ Regexp.new(/YYYY-MM-DD/)
       true
     end
 
@@ -245,21 +239,6 @@ module Tremendous
       @products = products
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] deliver_at Value to be assigned
-    def deliver_at=(deliver_at)
-      if deliver_at.nil?
-        fail ArgumentError, 'deliver_at cannot be nil'
-      end
-
-      pattern = Regexp.new(/YYYY-MM-DD/)
-      if deliver_at !~ pattern
-        fail ArgumentError, "invalid value for \"deliver_at\", must conform to the pattern #{pattern}."
-      end
-
-      @deliver_at = deliver_at
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/tremendous/models/reward_base.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -162,11 +162,6 @@ module Tremendous
         invalid_properties.push('invalid value for "products", number of items must be greater than or equal to 1.')
       end
 
-      pattern = Regexp.new(/YYYY-MM-DD/)
-      if !@deliver_at.nil? && @deliver_at !~ pattern
-        invalid_properties.push("invalid value for \"deliver_at\", must conform to the pattern #{pattern}.")
-      end
-
       invalid_properties
     end
 
@@ -178,7 +173,6 @@ module Tremendous
       return false if !@order_id.nil? && @order_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if !@products.nil? && @products.length < 1
-      return false if !@deliver_at.nil? && @deliver_at !~ Regexp.new(/YYYY-MM-DD/)
       true
     end
 
@@ -237,21 +231,6 @@ module Tremendous
       @products = products
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] deliver_at Value to be assigned
-    def deliver_at=(deliver_at)
-      if deliver_at.nil?
-        fail ArgumentError, 'deliver_at cannot be nil'
-      end
-
-      pattern = Regexp.new(/YYYY-MM-DD/)
-      if deliver_at !~ pattern
-        fail ArgumentError, "invalid value for \"deliver_at\", must conform to the pattern #{pattern}."
-      end
-
-      @deliver_at = deliver_at
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/tremendous/models/reward_base_custom_fields_inner.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 

data/lib/tremendous/models/reward_for_order_create.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -80,7 +80,7 @@ module Tremendous
         :'deliver_at' => :'Date',
         :'custom_fields' => :'Array<RewardBaseCustomFieldsInner>',
         :'language' => :'String',
-        :'delivery' => :'CreateOrderRequestRewardDelivery'
+        :'delivery' => :'SingleRewardOrder1RewardDelivery'
       }
     end
 
@@ -179,11 +179,6 @@ module Tremendous
         invalid_properties.push('invalid value for "products", number of items must be greater than or equal to 1.')
       end
 
-      pattern = Regexp.new(/YYYY-MM-DD/)
-      if !@deliver_at.nil? && @deliver_at !~ pattern
-        invalid_properties.push("invalid value for \"deliver_at\", must conform to the pattern #{pattern}.")
-      end
-
       invalid_properties
     end
 
@@ -195,7 +190,6 @@ module Tremendous
       return false if !@order_id.nil? && @order_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if !@products.nil? && @products.length < 1
-      return false if !@deliver_at.nil? && @deliver_at !~ Regexp.new(/YYYY-MM-DD/)
       true
     end
 
@@ -254,21 +248,6 @@ module Tremendous
       @products = products
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] deliver_at Value to be assigned
-    def deliver_at=(deliver_at)
-      if deliver_at.nil?
-        fail ArgumentError, 'deliver_at cannot be nil'
-      end
-
-      pattern = Regexp.new(/YYYY-MM-DD/)
-      if deliver_at !~ pattern
-        fail ArgumentError, "invalid value for \"deliver_at\", must conform to the pattern #{pattern}."
-      end
-
-      @deliver_at = deliver_at
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/tremendous/models/reward_link.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 

data/lib/tremendous/models/reward_token.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 

data/lib/tremendous/models/reward_value.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -94,7 +94,7 @@ module Tremendous
       if attributes.key?(:'currency_code')
         self.currency_code = attributes[:'currency_code']
       else
-        self.currency_code = nil
+        self.currency_code = 'USD'
       end
     end
 
@@ -107,10 +107,6 @@ module Tremendous
         invalid_properties.push('invalid value for "denomination", denomination cannot be nil.')
       end
 
-      if @currency_code.nil?
-        invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -119,7 +115,6 @@ module Tremendous
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @denomination.nil?
-      return false if @currency_code.nil?
       currency_code_validator = EnumAttributeValidator.new('String', ["USD", "CAD", "EUR", "AED", "AFN", "ALL", "AMD", "ARS", "AUD", "AZN", "BAM", "BDT", "BGN", "BHD", "BIF", "BND", "BOB", "BRL", "BWP", "BYR", "BZD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "GBP", "GEL", "GHS", "GNF", "GTQ", "HKD", "HNL", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KHR", "KRW", "KWD", "KZT", "LBP", "LKR", "LTL", "LVL", "MAD", "MDL", "MGA", "MKD", "MMK", "MOP", "MUR", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SDG", "SEK", "SGD", "SOS", "SYP", "THB", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYU", "UZS", "VEF", "VND", "XAF", "XOF", "YER", "ZAR", "ZMK"])
       return false unless currency_code_validator.valid?(@currency_code)
       true

data/lib/tremendous/models/reward_without_link.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -170,11 +170,6 @@ module Tremendous
         invalid_properties.push('invalid value for "products", number of items must be greater than or equal to 1.')
       end
 
-      pattern = Regexp.new(/YYYY-MM-DD/)
-      if !@deliver_at.nil? && @deliver_at !~ pattern
-        invalid_properties.push("invalid value for \"deliver_at\", must conform to the pattern #{pattern}.")
-      end
-
       invalid_properties
     end
 
@@ -186,7 +181,6 @@ module Tremendous
       return false if !@order_id.nil? && @order_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
       return false if !@products.nil? && @products.length < 1
-      return false if !@deliver_at.nil? && @deliver_at !~ Regexp.new(/YYYY-MM-DD/)
       true
     end
 
@@ -245,21 +239,6 @@ module Tremendous
       @products = products
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] deliver_at Value to be assigned
-    def deliver_at=(deliver_at)
-      if deliver_at.nil?
-        fail ArgumentError, 'deliver_at cannot be nil'
-      end
-
-      pattern = Regexp.new(/YYYY-MM-DD/)
-      if deliver_at !~ pattern
-        fail ArgumentError, "invalid value for \"deliver_at\", must conform to the pattern #{pattern}."
-      end
-
-      @deliver_at = deliver_at
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/tremendous/models/reward_without_link_delivery.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 

data/lib/tremendous/models/role.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 

data/lib/tremendous/models/simulate_webhook_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 

data/lib/tremendous/models/{order_for_create.rb → single_reward_order.rb}

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 2
 Contact: developers@tremendous.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -14,7 +14,8 @@ require 'date'
 require 'time'
 
 module Tremendous
-  class OrderForCreate
+  # An order that contains a single reward. The reward is sent to a single recipient. 
+  class SingleRewardOrder
     # Reference for this order, supplied by the customer.  When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders.  It also allows for retrieving by `external_id` instead of `id` only. 
     attr_accessor :external_id
 
@@ -40,8 +41,8 @@ module Tremendous
     def self.openapi_types
       {
         :'external_id' => :'String',
-        :'payment' => :'CreateOrderRequestPayment',
-        :'reward' => :'OrderForCreateReward'
+        :'payment' => :'SingleRewardOrder1Payment',
+        :'reward' => :'SingleRewardOrderReward'
       }
     end
 
@@ -56,13 +57,13 @@ 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::OrderForCreate` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::SingleRewardOrder` 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::OrderForCreate`. 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::SingleRewardOrder`. 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
       }
@@ -73,8 +74,6 @@ module Tremendous
 
       if attributes.key?(:'payment')
         self.payment = attributes[:'payment']
-      else
-        self.payment = nil
       end
 
       if attributes.key?(:'reward')
@@ -89,10 +88,6 @@ module Tremendous
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @payment.nil?
-        invalid_properties.push('invalid value for "payment", payment cannot be nil.')
-      end
-
       if @reward.nil?
         invalid_properties.push('invalid value for "reward", reward cannot be nil.')
       end
@@ -104,7 +99,6 @@ module Tremendous
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @payment.nil?
       return false if @reward.nil?
       true
     end