voucherify 8.0.2 → 8.1.0

data/lib/VoucherifySdk/models/earning_rule.rb

@@ -31,6 +31,8 @@ module VoucherifySdk
 
     attr_accessor :loyalty_tier
 
+    attr_accessor :pending_points
+
     attr_accessor :source
 
     # The type of the object represented by JSON. Default is earning_rule.
@@ -55,6 +57,8 @@ module VoucherifySdk
     # The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format.
     attr_accessor :metadata
 
+    attr_accessor :expiration_rules
+
     # A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.
     attr_accessor :validation_rule_id
 
@@ -96,6 +100,7 @@ module VoucherifySdk
         :'custom_event' => :'custom_event',
         :'segment' => :'segment',
         :'loyalty_tier' => :'loyalty_tier',
+        :'pending_points' => :'pending_points',
         :'source' => :'source',
         :'object' => :'object',
         :'automation_id' => :'automation_id',
@@ -105,6 +110,7 @@ module VoucherifySdk
         :'validity_day_of_week' => :'validity_day_of_week',
         :'validity_hours' => :'validity_hours',
         :'metadata' => :'metadata',
+        :'expiration_rules' => :'expiration_rules',
         :'validation_rule_id' => :'validation_rule_id',
         :'updated_at' => :'updated_at',
         :'active' => :'active'
@@ -126,6 +132,7 @@ module VoucherifySdk
         :'custom_event' => :'EarningRuleCustomEvent',
         :'segment' => :'EarningRuleSegment',
         :'loyalty_tier' => :'EarningRuleLoyaltyTier',
+        :'pending_points' => :'EarningRulePendingPoints',
         :'source' => :'EarningRuleSource',
         :'object' => :'String',
         :'automation_id' => :'String',
@@ -135,6 +142,7 @@ module VoucherifySdk
         :'validity_day_of_week' => :'Array<Integer>',
         :'validity_hours' => :'ValidityHours',
         :'metadata' => :'Object',
+        :'expiration_rules' => :'EarningRuleExpirationRules',
         :'validation_rule_id' => :'String',
         :'updated_at' => :'Time',
         :'active' => :'Boolean'
@@ -150,6 +158,7 @@ module VoucherifySdk
         :'custom_event',
         :'segment',
         :'loyalty_tier',
+        :'pending_points',
         :'source',
         :'object',
         :'automation_id',
@@ -198,6 +207,10 @@ module VoucherifySdk
         self.loyalty_tier = attributes[:'loyalty_tier']
       end
 
+      if attributes.key?(:'pending_points')
+        self.pending_points = attributes[:'pending_points']
+      end
+
       if attributes.key?(:'source')
         self.source = attributes[:'source']
       end
@@ -238,6 +251,10 @@ module VoucherifySdk
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.key?(:'expiration_rules')
+        self.expiration_rules = attributes[:'expiration_rules']
+      end
+
       if attributes.key?(:'validation_rule_id')
         self.validation_rule_id = attributes[:'validation_rule_id']
       end
@@ -280,6 +297,7 @@ module VoucherifySdk
           custom_event == o.custom_event &&
           segment == o.segment &&
           loyalty_tier == o.loyalty_tier &&
+          pending_points == o.pending_points &&
           source == o.source &&
           object == o.object &&
           automation_id == o.automation_id &&
@@ -289,6 +307,7 @@ module VoucherifySdk
           validity_day_of_week == o.validity_day_of_week &&
           validity_hours == o.validity_hours &&
           metadata == o.metadata &&
+          expiration_rules == o.expiration_rules &&
           validation_rule_id == o.validation_rule_id &&
           updated_at == o.updated_at &&
           active == o.active
@@ -303,7 +322,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_at, loyalty, event, custom_event, segment, loyalty_tier, source, object, automation_id, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, metadata, validation_rule_id, updated_at, active].hash
+      [id, created_at, loyalty, event, custom_event, segment, loyalty_tier, pending_points, source, object, automation_id, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, metadata, expiration_rules, validation_rule_id, updated_at, active].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/earning_rule_expiration_rules.rb

@@ -0,0 +1,313 @@
+=begin
+#Voucherify API
+
+#Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details.
+
+The version of the OpenAPI document: v2018-08-01
+Contact: support@voucherify.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module VoucherifySdk
+  # Defines the loyalty point expiration rule. This expiration rule applies only to this earning rule and supersedes `expiration_rules` defined in the `voucher.loyalty_card` object.
+  class EarningRuleExpirationRules
+    # Type of period. Can be set for `MONTH` or `FIXED_DAY_OF_YEAR`. `MONTH` requires the `period_value` field. `FIXED_DAY_OF_YEAR` requires the `fixed_month` and `fixed_day` fields.
+    attr_accessor :period_type
+
+    # Value of the period. Required for the `period_type: MONTH`.
+    attr_accessor :period_value
+
+    # Type of rounding of the expiration period. Optional for the `period_type: MONTH`.
+    attr_accessor :rounding_type
+
+    # Value of rounding of the expiration period. Required for the `rounding_type`.
+    attr_accessor :rounding_value
+
+    # Determines the month when the points expire; `1` is January, `2` is February, and so on. Required for the `period_type: FIXED_DAY_OF_YEAR`.
+    attr_accessor :fixed_month
+
+    # Determines the day of the month when the points expire. Required for the `period_type: FIXED_DAY_OF_YEAR`.
+    attr_accessor :fixed_day
+
+    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
+      {
+        :'period_type' => :'period_type',
+        :'period_value' => :'period_value',
+        :'rounding_type' => :'rounding_type',
+        :'rounding_value' => :'rounding_value',
+        :'fixed_month' => :'fixed_month',
+        :'fixed_day' => :'fixed_day'
+      }
+    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
+      {
+        :'period_type' => :'String',
+        :'period_value' => :'Integer',
+        :'rounding_type' => :'String',
+        :'rounding_value' => :'Integer',
+        :'fixed_month' => :'Integer',
+        :'fixed_day' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'period_type',
+        :'period_value',
+        :'rounding_type',
+        :'rounding_value',
+        :'fixed_month',
+        :'fixed_day'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'period_type')
+        self.period_type = attributes[:'period_type']
+      else
+        self.period_type = 'MONTH'
+      end
+
+      if attributes.key?(:'period_value')
+        self.period_value = attributes[:'period_value']
+      end
+
+      if attributes.key?(:'rounding_type')
+        self.rounding_type = attributes[:'rounding_type']
+      end
+
+      if attributes.key?(:'rounding_value')
+        self.rounding_value = attributes[:'rounding_value']
+      end
+
+      if attributes.key?(:'fixed_month')
+        self.fixed_month = attributes[:'fixed_month']
+      end
+
+      if attributes.key?(:'fixed_day')
+        self.fixed_day = attributes[:'fixed_day']
+      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 !@fixed_month.nil? && @fixed_month > 12
+        invalid_properties.push('invalid value for "fixed_month", must be smaller than or equal to 12.')
+      end
+
+      if !@fixed_month.nil? && @fixed_month < 1
+        invalid_properties.push('invalid value for "fixed_month", must be greater than or equal to 1.')
+      end
+
+      if !@fixed_day.nil? && @fixed_day > 31
+        invalid_properties.push('invalid value for "fixed_day", must be smaller than or equal to 31.')
+      end
+
+      if !@fixed_day.nil? && @fixed_day < 1
+        invalid_properties.push('invalid value for "fixed_day", must be greater than or equal to 1.')
+      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'
+      period_type_validator = EnumAttributeValidator.new('String', ["FIXED_DAY_OF_YEAR", "MONTH"])
+      return false unless period_type_validator.valid?(@period_type)
+      rounding_type_validator = EnumAttributeValidator.new('String', ["END_OF_MONTH", "END_OF_QUARTER", "END_OF_HALF_YEAR", "END_OF_YEAR", "PARTICULAR_MONTH"])
+      return false unless rounding_type_validator.valid?(@rounding_type)
+      return false if !@fixed_month.nil? && @fixed_month > 12
+      return false if !@fixed_month.nil? && @fixed_month < 1
+      return false if !@fixed_day.nil? && @fixed_day > 31
+      return false if !@fixed_day.nil? && @fixed_day < 1
+      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 &&
+          period_type == o.period_type &&
+          period_value == o.period_value &&
+          rounding_type == o.rounding_type &&
+          rounding_value == o.rounding_value &&
+          fixed_month == o.fixed_month &&
+          fixed_day == o.fixed_day
+    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
+      [period_type, period_value, rounding_type, rounding_value, fixed_month, fixed_day].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 = VoucherifySdk.const_get(type)
+        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/VoucherifySdk/models/earning_rule_loyalty.rb

@@ -20,6 +20,9 @@ module VoucherifySdk
     # Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points.
     attr_accessor :points
 
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
     attr_accessor :calculation_type
 
     attr_accessor :order
@@ -57,6 +60,7 @@ module VoucherifySdk
       {
         :'type' => :'type',
         :'points' => :'points',
+        :'points_formula' => :'points_formula',
         :'calculation_type' => :'calculation_type',
         :'order' => :'order',
         :'order_items' => :'order_items',
@@ -75,6 +79,7 @@ module VoucherifySdk
       {
         :'type' => :'String',
         :'points' => :'Integer',
+        :'points_formula' => :'String',
         :'calculation_type' => :'String',
         :'order' => :'EarningRuleLoyaltyOrder',
         :'order_items' => :'EarningRuleLoyaltyOrderItems',
@@ -88,6 +93,7 @@ module VoucherifySdk
       Set.new([
         :'type',
         :'points',
+        :'points_formula',
         :'calculation_type',
         :'order',
         :'order_items',
@@ -112,6 +118,10 @@ module VoucherifySdk
         self.points = attributes[:'points']
       end
 
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
+
       if attributes.key?(:'calculation_type')
         self.calculation_type = attributes[:'calculation_type']
       end
@@ -159,6 +169,7 @@ module VoucherifySdk
       self.class == o.class &&
           type == o.type &&
           points == o.points &&
+          points_formula == o.points_formula &&
           calculation_type == o.calculation_type &&
           order == o.order &&
           order_items == o.order_items &&
@@ -175,7 +186,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, points, calculation_type, order, order_items, customer, custom_event].hash
+      [type, points, points_formula, calculation_type, order, order_items, customer, custom_event].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/earning_rule_loyalty_custom_event_metadata.rb

@@ -22,6 +22,9 @@ module VoucherifySdk
     # Number of points to be awarded, i.e. how many points to be added to the loyalty card.
     attr_accessor :points
 
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
     #  Custom event metadata property.
     attr_accessor :property
 
@@ -30,6 +33,7 @@ module VoucherifySdk
       {
         :'every' => :'every',
         :'points' => :'points',
+        :'points_formula' => :'points_formula',
         :'property' => :'property'
       }
     end
@@ -44,6 +48,7 @@ module VoucherifySdk
       {
         :'every' => :'Integer',
         :'points' => :'Integer',
+        :'points_formula' => :'String',
         :'property' => :'String'
       }
     end
@@ -53,6 +58,7 @@ module VoucherifySdk
       Set.new([
         :'every',
         :'points',
+        :'points_formula',
         :'property'
       ])
     end
@@ -73,6 +79,10 @@ module VoucherifySdk
         self.points = attributes[:'points']
       end
 
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
+
       if attributes.key?(:'property')
         self.property = attributes[:'property']
       end
@@ -100,6 +110,7 @@ module VoucherifySdk
       self.class == o.class &&
           every == o.every &&
           points == o.points &&
+          points_formula == o.points_formula &&
           property == o.property
     end
 
@@ -112,7 +123,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [every, points, property].hash
+      [every, points, points_formula, property].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/earning_rule_loyalty_customer_metadata.rb

@@ -22,6 +22,9 @@ module VoucherifySdk
     # Number of points to be awarded, i.e. how many points to be added to the loyalty card.
     attr_accessor :points
 
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
     # Customer metadata property.
     attr_accessor :property
 
@@ -30,6 +33,7 @@ module VoucherifySdk
       {
         :'every' => :'every',
         :'points' => :'points',
+        :'points_formula' => :'points_formula',
         :'property' => :'property'
       }
     end
@@ -44,6 +48,7 @@ module VoucherifySdk
       {
         :'every' => :'Integer',
         :'points' => :'Integer',
+        :'points_formula' => :'String',
         :'property' => :'String'
       }
     end
@@ -53,6 +58,7 @@ module VoucherifySdk
       Set.new([
         :'every',
         :'points',
+        :'points_formula',
         :'property'
       ])
     end
@@ -73,6 +79,10 @@ module VoucherifySdk
         self.points = attributes[:'points']
       end
 
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
+
       if attributes.key?(:'property')
         self.property = attributes[:'property']
       end
@@ -100,6 +110,7 @@ module VoucherifySdk
       self.class == o.class &&
           every == o.every &&
           points == o.points &&
+          points_formula == o.points_formula &&
           property == o.property
     end
 
@@ -112,7 +123,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [every, points, property].hash
+      [every, points, points_formula, property].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/earning_rule_loyalty_order_amount.rb

@@ -22,11 +22,15 @@ module VoucherifySdk
     # Number of points to be awarded, i.e. how many points to be added to the loyalty card.
     attr_accessor :points
 
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'every' => :'every',
-        :'points' => :'points'
+        :'points' => :'points',
+        :'points_formula' => :'points_formula'
       }
     end
 
@@ -39,7 +43,8 @@ module VoucherifySdk
     def self.openapi_types
       {
         :'every' => :'Integer',
-        :'points' => :'Integer'
+        :'points' => :'Integer',
+        :'points_formula' => :'String'
       }
     end
 
@@ -47,7 +52,8 @@ module VoucherifySdk
     def self.openapi_nullable
       Set.new([
         :'every',
-        :'points'
+        :'points',
+        :'points_formula'
       ])
     end
 
@@ -66,6 +72,10 @@ module VoucherifySdk
       if attributes.key?(:'points')
         self.points = attributes[:'points']
       end
+
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,7 +99,8 @@ module VoucherifySdk
       return true if self.equal?(o)
       self.class == o.class &&
           every == o.every &&
-          points == o.points
+          points == o.points &&
+          points_formula == o.points_formula
     end
 
     # @see the `==` method
@@ -101,7 +112,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [every, points].hash
+      [every, points, points_formula].hash
     end
 
     # Builds the object from hash