voucherify 8.0.2 → 8.1.0

data/lib/VoucherifySdk/models/redemption_entry_session.rb

@@ -0,0 +1,210 @@
+=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
+  # Contains details about the redemption session lock. Sessions can be established only for discount vouchers, promotions, and gift cards.
+  class RedemptionEntrySession
+    # The session unique ID assigned by Voucherify or your own unique session ID sent in the request.
+    attr_accessor :key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'key' => :'key'
+      }
+    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
+      {
+        :'key' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'key'
+      ])
+    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?(:'key')
+        self.key = attributes[:'key']
+      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 &&
+          key == o.key
+    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
+      [key].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/redemption_entry_voucher_gift.rb

@@ -15,10 +15,13 @@ require 'time'
 
 module VoucherifySdk
   class RedemptionEntryVoucherGift
-    # Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
+    # Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
     attr_accessor :amount
 
-    # Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
+    # Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
+    attr_accessor :subtracted_amount
+
+    # Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
     attr_accessor :balance
 
     # Defines how the credits are applied to the customer's order.
@@ -50,6 +53,7 @@ module VoucherifySdk
     def self.attribute_map
       {
         :'amount' => :'amount',
+        :'subtracted_amount' => :'subtracted_amount',
         :'balance' => :'balance',
         :'effect' => :'effect'
       }
@@ -64,6 +68,7 @@ module VoucherifySdk
     def self.openapi_types
       {
         :'amount' => :'Integer',
+        :'subtracted_amount' => :'Integer',
         :'balance' => :'Integer',
         :'effect' => :'String'
       }
@@ -73,6 +78,7 @@ module VoucherifySdk
     def self.openapi_nullable
       Set.new([
         :'amount',
+        :'subtracted_amount',
         :'balance',
         :'effect'
       ])
@@ -90,6 +96,10 @@ module VoucherifySdk
         self.amount = attributes[:'amount']
       end
 
+      if attributes.key?(:'subtracted_amount')
+        self.subtracted_amount = attributes[:'subtracted_amount']
+      end
+
       if attributes.key?(:'balance')
         self.balance = attributes[:'balance']
       end
@@ -122,6 +132,7 @@ module VoucherifySdk
       return true if self.equal?(o)
       self.class == o.class &&
           amount == o.amount &&
+          subtracted_amount == o.subtracted_amount &&
           balance == o.balance &&
           effect == o.effect
     end
@@ -135,7 +146,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, balance, effect].hash
+      [amount, subtracted_amount, balance, effect].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb

@@ -15,10 +15,10 @@ require 'time'
 
 module VoucherifySdk
   class RedemptionEntryVoucherLoyaltyCard
-    # Total points incurred over the lifespan of the loyalty card.
+    # Total number of points added to the loyalty card over its lifespan.
     attr_accessor :points
 
-    # Points available for reward redemption.
+    # Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`.
     attr_accessor :balance
 
     # The next closest date when the next set of points are due to expire.
@@ -27,13 +27,25 @@ module VoucherifySdk
     # The amount of points that are set to expire next.
     attr_accessor :next_expiration_points
 
+    # Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
+    attr_accessor :pending_points
+
+    # Shows the total number of expired points over the lifetime of the loyalty card.
+    attr_accessor :expired_points
+
+    # Shows the total number of subtracted points over the lifetime of the loyalty card.
+    attr_accessor :subtracted_points
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'points' => :'points',
         :'balance' => :'balance',
         :'next_expiration_date' => :'next_expiration_date',
-        :'next_expiration_points' => :'next_expiration_points'
+        :'next_expiration_points' => :'next_expiration_points',
+        :'pending_points' => :'pending_points',
+        :'expired_points' => :'expired_points',
+        :'subtracted_points' => :'subtracted_points'
       }
     end
 
@@ -48,7 +60,10 @@ module VoucherifySdk
         :'points' => :'Integer',
         :'balance' => :'Integer',
         :'next_expiration_date' => :'Date',
-        :'next_expiration_points' => :'Integer'
+        :'next_expiration_points' => :'Integer',
+        :'pending_points' => :'Integer',
+        :'expired_points' => :'Integer',
+        :'subtracted_points' => :'Integer'
       }
     end
 
@@ -58,7 +73,10 @@ module VoucherifySdk
         :'points',
         :'balance',
         :'next_expiration_date',
-        :'next_expiration_points'
+        :'next_expiration_points',
+        :'pending_points',
+        :'expired_points',
+        :'subtracted_points'
       ])
     end
 
@@ -85,6 +103,18 @@ module VoucherifySdk
       if attributes.key?(:'next_expiration_points')
         self.next_expiration_points = attributes[:'next_expiration_points']
       end
+
+      if attributes.key?(:'pending_points')
+        self.pending_points = attributes[:'pending_points']
+      end
+
+      if attributes.key?(:'expired_points')
+        self.expired_points = attributes[:'expired_points']
+      end
+
+      if attributes.key?(:'subtracted_points')
+        self.subtracted_points = attributes[:'subtracted_points']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -110,7 +140,10 @@ module VoucherifySdk
           points == o.points &&
           balance == o.balance &&
           next_expiration_date == o.next_expiration_date &&
-          next_expiration_points == o.next_expiration_points
+          next_expiration_points == o.next_expiration_points &&
+          pending_points == o.pending_points &&
+          expired_points == o.expired_points &&
+          subtracted_points == o.subtracted_points
     end
 
     # @see the `==` method
@@ -122,7 +155,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [points, balance, next_expiration_date, next_expiration_points].hash
+      [points, balance, next_expiration_date, next_expiration_points, pending_points, expired_points, subtracted_points].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/redemption_related_redemptions_rollbacks_item.rb

@@ -21,11 +21,37 @@ module VoucherifySdk
     # Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
     attr_accessor :date
 
+    # Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values. This is returned only in GET `v1/redemptions/` and GET `v1/redemptions/{redemptionId}` endpoints.
+    attr_accessor :rollback_order_mode
+
+    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
       {
         :'id' => :'id',
-        :'date' => :'date'
+        :'date' => :'date',
+        :'rollback_order_mode' => :'rollback_order_mode'
       }
     end
 
@@ -38,7 +64,8 @@ module VoucherifySdk
     def self.openapi_types
       {
         :'id' => :'String',
-        :'date' => :'Time'
+        :'date' => :'Time',
+        :'rollback_order_mode' => :'String'
       }
     end
 
@@ -63,6 +90,10 @@ module VoucherifySdk
       if attributes.key?(:'date')
         self.date = attributes[:'date']
       end
+
+      if attributes.key?(:'rollback_order_mode')
+        self.rollback_order_mode = attributes[:'rollback_order_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -77,6 +108,8 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      rollback_order_mode_validator = EnumAttributeValidator.new('String', ["WITH_ORDER", "WITHOUT_ORDER"])
+      return false unless rollback_order_mode_validator.valid?(@rollback_order_mode)
       true
     end
 
@@ -86,7 +119,8 @@ module VoucherifySdk
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          date == o.date
+          date == o.date &&
+          rollback_order_mode == o.rollback_order_mode
     end
 
     # @see the `==` method
@@ -98,7 +132,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, date].hash
+      [id, date, rollback_order_mode].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/redemption_reward_result_parameters_campaign.rb

@@ -19,7 +19,7 @@ module VoucherifySdk
     # Campaign unique ID.
     attr_accessor :id
 
-    # Points available for reward redemption.
+    # Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`.
     attr_accessor :balance
 
     # Defines the type of the campaign.

data/lib/VoucherifySdk/models/redemption_rollback.rb

@@ -49,8 +49,6 @@ module VoucherifySdk
     # Redemption status.
     attr_accessor :status
 
-    attr_accessor :related_redemptions
-
     # If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.
     attr_accessor :failure_code
 
@@ -79,6 +77,8 @@ module VoucherifySdk
 
     attr_accessor :loyalty_card
 
+    attr_accessor :related_redemptions
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -115,7 +115,6 @@ module VoucherifySdk
         :'reason' => :'reason',
         :'result' => :'result',
         :'status' => :'status',
-        :'related_redemptions' => :'related_redemptions',
         :'failure_code' => :'failure_code',
         :'failure_message' => :'failure_message',
         :'order' => :'order',
@@ -127,7 +126,8 @@ module VoucherifySdk
         :'promotion_tier' => :'promotion_tier',
         :'reward' => :'reward',
         :'gift' => :'gift',
-        :'loyalty_card' => :'loyalty_card'
+        :'loyalty_card' => :'loyalty_card',
+        :'related_redemptions' => :'related_redemptions'
       }
     end
 
@@ -150,7 +150,6 @@ module VoucherifySdk
         :'reason' => :'String',
         :'result' => :'String',
         :'status' => :'String',
-        :'related_redemptions' => :'RedemptionRollbackRelatedRedemptions',
         :'failure_code' => :'String',
         :'failure_message' => :'String',
         :'order' => :'OrderCalculated',
@@ -162,7 +161,8 @@ module VoucherifySdk
         :'promotion_tier' => :'PromotionTier',
         :'reward' => :'RedemptionRewardResult',
         :'gift' => :'RedemptionRollbackGift',
-        :'loyalty_card' => :'RedemptionRollbackLoyaltyCard'
+        :'loyalty_card' => :'RedemptionRollbackLoyaltyCard',
+        :'related_redemptions' => :'RedemptionRollbackRelatedRedemptions'
       }
     end
 
@@ -180,14 +180,14 @@ module VoucherifySdk
         :'reason',
         :'result',
         :'status',
-        :'related_redemptions',
         :'failure_code',
         :'failure_message',
         :'channel',
         :'related_object_type',
         :'related_object_id',
         :'gift',
-        :'loyalty_card'
+        :'loyalty_card',
+        :'related_redemptions'
       ])
     end
 
@@ -245,10 +245,6 @@ module VoucherifySdk
         self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'related_redemptions')
-        self.related_redemptions = attributes[:'related_redemptions']
-      end
-
       if attributes.key?(:'failure_code')
         self.failure_code = attributes[:'failure_code']
       end
@@ -296,6 +292,10 @@ module VoucherifySdk
       if attributes.key?(:'loyalty_card')
         self.loyalty_card = attributes[:'loyalty_card']
       end
+
+      if attributes.key?(:'related_redemptions')
+        self.related_redemptions = attributes[:'related_redemptions']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -337,7 +337,6 @@ module VoucherifySdk
           reason == o.reason &&
           result == o.result &&
           status == o.status &&
-          related_redemptions == o.related_redemptions &&
           failure_code == o.failure_code &&
           failure_message == o.failure_message &&
           order == o.order &&
@@ -349,7 +348,8 @@ module VoucherifySdk
           promotion_tier == o.promotion_tier &&
           reward == o.reward &&
           gift == o.gift &&
-          loyalty_card == o.loyalty_card
+          loyalty_card == o.loyalty_card &&
+          related_redemptions == o.related_redemptions
     end
 
     # @see the `==` method
@@ -361,7 +361,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, object, date, customer_id, tracking_id, metadata, amount, redemption, reason, result, status, related_redemptions, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, voucher, promotion_tier, reward, gift, loyalty_card].hash
+      [id, object, date, customer_id, tracking_id, metadata, amount, redemption, reason, result, status, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, voucher, promotion_tier, reward, gift, loyalty_card, related_redemptions].hash
     end
 
     # Builds the object from hash