voucherify 8.0.2 → 8.1.0

data/lib/VoucherifySdk/models/redemption_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 RedemptionSession
+    # 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_voucher_gift.rb

@@ -16,10 +16,13 @@ require 'time'
 module VoucherifySdk
   # Object representing gift parameters. Child attributes are present only if `type` is `GIFT_VOUCHER`. Defaults to `null`.
   class RedemptionVoucherGift
-    # 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.
@@ -51,6 +54,7 @@ module VoucherifySdk
     def self.attribute_map
       {
         :'amount' => :'amount',
+        :'subtracted_amount' => :'subtracted_amount',
         :'balance' => :'balance',
         :'effect' => :'effect'
       }
@@ -65,6 +69,7 @@ module VoucherifySdk
     def self.openapi_types
       {
         :'amount' => :'Integer',
+        :'subtracted_amount' => :'Integer',
         :'balance' => :'Integer',
         :'effect' => :'String'
       }
@@ -74,6 +79,7 @@ module VoucherifySdk
     def self.openapi_nullable
       Set.new([
         :'amount',
+        :'subtracted_amount',
         :'balance',
         :'effect'
       ])
@@ -91,6 +97,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
@@ -123,6 +133,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
@@ -136,7 +147,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_voucher_loyalty_card.rb

@@ -16,10 +16,10 @@ require 'time'
 module VoucherifySdk
   # Object representing loyalty card parameters. Child attributes are present only if `type` is `LOYALTY_CARD`. Defaults to `null`.
   class RedemptionVoucherLoyaltyCard
-    # 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.
@@ -28,13 +28,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
 
@@ -49,7 +61,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
 
@@ -59,7 +74,10 @@ module VoucherifySdk
         :'points',
         :'balance',
         :'next_expiration_date',
-        :'next_expiration_points'
+        :'next_expiration_points',
+        :'pending_points',
+        :'expired_points',
+        :'subtracted_points'
       ])
     end
 
@@ -86,6 +104,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?
@@ -111,7 +141,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
@@ -123,7 +156,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/redemptions_get_response_body.rb

@@ -42,6 +42,8 @@ module VoucherifySdk
 
     attr_accessor :status
 
+    attr_accessor :session
+
     attr_accessor :related_redemptions
 
     # If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.
@@ -109,6 +111,7 @@ module VoucherifySdk
         :'redemption' => :'redemption',
         :'result' => :'result',
         :'status' => :'status',
+        :'session' => :'session',
         :'related_redemptions' => :'related_redemptions',
         :'failure_code' => :'failure_code',
         :'failure_message' => :'failure_message',
@@ -144,6 +147,7 @@ module VoucherifySdk
         :'redemption' => :'String',
         :'result' => :'String',
         :'status' => :'String',
+        :'session' => :'RedemptionsGetResponseBodySession',
         :'related_redemptions' => :'RedemptionsGetResponseBodyRelatedRedemptions',
         :'failure_code' => :'String',
         :'failure_message' => :'String',
@@ -174,6 +178,7 @@ module VoucherifySdk
         :'redemption',
         :'result',
         :'status',
+        :'session',
         :'related_redemptions',
         :'failure_code',
         :'failure_message',
@@ -238,6 +243,10 @@ module VoucherifySdk
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'session')
+        self.session = attributes[:'session']
+      end
+
       if attributes.key?(:'related_redemptions')
         self.related_redemptions = attributes[:'related_redemptions']
       end
@@ -333,6 +342,7 @@ module VoucherifySdk
           redemption == o.redemption &&
           result == o.result &&
           status == o.status &&
+          session == o.session &&
           related_redemptions == o.related_redemptions &&
           failure_code == o.failure_code &&
           failure_message == o.failure_message &&
@@ -358,7 +368,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, result, status, related_redemptions, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, promotion_tier, reward, gift, loyalty_card, voucher, reason].hash
+      [id, object, date, customer_id, tracking_id, metadata, amount, redemption, result, status, session, related_redemptions, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, promotion_tier, reward, gift, loyalty_card, voucher, reason].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb

@@ -24,36 +24,33 @@ module VoucherifySdk
     # The order status.
     attr_accessor :status
 
-    # A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
+    # This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :amount
 
-    # A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
+    # This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :initial_amount
 
-    # Sum of all order-level discounts applied to the order.
+    # Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :discount_amount
 
-    # Sum of all product-specific discounts applied to the order.
+    # Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :items_discount_amount
 
-    # Sum of all order-level AND all product-specific discounts applied to the order.
+    # Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :total_discount_amount
 
-    # Order amount after undoing all the discounts through the rollback redemption.
+    # Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :total_amount
 
-    # This field shows the order-level discount applied.
+    # This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :applied_discount_amount
 
-    # Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)`
+    # Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).   `sum(items, i => i.applied_discount_amount)`
     attr_accessor :items_applied_discount_amount
 
-    # Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`
+    # Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`
     attr_accessor :total_applied_discount_amount
 
-    # Array of items applied to the order. It can include up 500 items.
-    attr_accessor :items
-
     # A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
     attr_accessor :metadata
 
@@ -66,7 +63,7 @@ module VoucherifySdk
     # Timestamp representing the date and time when the order was last updated in ISO 8601 format.
     attr_accessor :updated_at
 
-    # Unique customer ID of the customer making the purchase.
+    # Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
     attr_accessor :customer_id
 
     # Unique referrer ID.
@@ -78,6 +75,9 @@ module VoucherifySdk
 
     attr_accessor :redemptions
 
+    # Array of items applied to the order. It can include up 500 items.
+    attr_accessor :items
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -115,7 +115,6 @@ module VoucherifySdk
         :'applied_discount_amount' => :'applied_discount_amount',
         :'items_applied_discount_amount' => :'items_applied_discount_amount',
         :'total_applied_discount_amount' => :'total_applied_discount_amount',
-        :'items' => :'items',
         :'metadata' => :'metadata',
         :'object' => :'object',
         :'created_at' => :'created_at',
@@ -124,7 +123,8 @@ module VoucherifySdk
         :'referrer_id' => :'referrer_id',
         :'customer' => :'customer',
         :'referrer' => :'referrer',
-        :'redemptions' => :'redemptions'
+        :'redemptions' => :'redemptions',
+        :'items' => :'items'
       }
     end
 
@@ -148,7 +148,6 @@ module VoucherifySdk
         :'applied_discount_amount' => :'Integer',
         :'items_applied_discount_amount' => :'Integer',
         :'total_applied_discount_amount' => :'Integer',
-        :'items' => :'Array<OrderCalculatedItem>',
         :'metadata' => :'Object',
         :'object' => :'String',
         :'created_at' => :'Time',
@@ -157,7 +156,8 @@ module VoucherifySdk
         :'referrer_id' => :'String',
         :'customer' => :'RedemptionsGetResponseBodyOrderCustomer',
         :'referrer' => :'RedemptionsGetResponseBodyOrderReferrer',
-        :'redemptions' => :'Hash<String, OrderRedemptionsEntry>'
+        :'redemptions' => :'Hash<String, OrderRedemptionsEntry>',
+        :'items' => :'Array<OrderCalculatedItem>'
       }
     end
 
@@ -176,7 +176,6 @@ module VoucherifySdk
         :'applied_discount_amount',
         :'items_applied_discount_amount',
         :'total_applied_discount_amount',
-        :'items',
         :'metadata',
         :'object',
         :'created_at',
@@ -185,7 +184,8 @@ module VoucherifySdk
         :'referrer_id',
         :'customer',
         :'referrer',
-        :'redemptions'
+        :'redemptions',
+        :'items'
       ])
     end
 
@@ -245,12 +245,6 @@ module VoucherifySdk
         self.total_applied_discount_amount = attributes[:'total_applied_discount_amount']
       end
 
-      if attributes.key?(:'items')
-        if (value = attributes[:'items']).is_a?(Array)
-          self.items = value
-        end
-      end
-
       if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
@@ -290,6 +284,12 @@ module VoucherifySdk
           self.redemptions = value
         end
       end
+
+      if attributes.key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -328,7 +328,6 @@ module VoucherifySdk
           applied_discount_amount == o.applied_discount_amount &&
           items_applied_discount_amount == o.items_applied_discount_amount &&
           total_applied_discount_amount == o.total_applied_discount_amount &&
-          items == o.items &&
           metadata == o.metadata &&
           object == o.object &&
           created_at == o.created_at &&
@@ -337,7 +336,8 @@ module VoucherifySdk
           referrer_id == o.referrer_id &&
           customer == o.customer &&
           referrer == o.referrer &&
-          redemptions == o.redemptions
+          redemptions == o.redemptions &&
+          items == o.items
     end
 
     # @see the `==` method
@@ -349,7 +349,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, source_id, status, amount, initial_amount, discount_amount, items_discount_amount, total_discount_amount, total_amount, applied_discount_amount, items_applied_discount_amount, total_applied_discount_amount, items, metadata, object, created_at, updated_at, customer_id, referrer_id, customer, referrer, redemptions].hash
+      [id, source_id, status, amount, initial_amount, discount_amount, items_discount_amount, total_discount_amount, total_amount, applied_discount_amount, items_applied_discount_amount, total_applied_discount_amount, metadata, object, created_at, updated_at, customer_id, referrer_id, customer, referrer, redemptions, items].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb

@@ -31,7 +31,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.