voucherify 8.0.1 → 8.0.3

data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance_related_object.rb

@@ -16,7 +16,7 @@ require 'time'
 module VoucherifySdk
   # Defines the resource that is being modified with the values that are returned in the balance object.
   class LoyaltyCardTransactionDetailsBalanceRelatedObject
-    # Identifies the voucher that is being modified, this is the ID that was assigned by the Voucherify API.
+    # Identifies the voucher that is being modified. The ID is assigned by the Voucherify API.
     attr_accessor :id
 
     # The object being modified, i.e. voucher.
@@ -97,11 +97,6 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      pattern = Regexp.new(/voucher/)
-      if !@type.nil? && @type !~ pattern
-        invalid_properties.push("invalid value for \"type\", must conform to the pattern #{pattern}.")
-      end
-
       invalid_properties
     end
 
@@ -111,7 +106,6 @@ module VoucherifySdk
       warn '[DEPRECATED] the `valid?` method is obsolete'
       type_validator = EnumAttributeValidator.new('String', ["voucher"])
       return false unless type_validator.valid?(@type)
-      return false if !@type.nil? && @type !~ Regexp.new(/voucher/)
       true
     end
 

data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb

@@ -16,7 +16,7 @@ require 'time'
 module VoucherifySdk
   # Contains information about the earning rule.
   class LoyaltyCardTransactionDetailsEarningRule
-    # Unique earning rule ID.
+    # Unique identifier of an earning rule, assigned by Voucherify.
     attr_accessor :id
 
     attr_accessor :source

data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb

@@ -0,0 +1,221 @@
+=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
+  # Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed.
+  class LoyaltyCardTransactionDetailsHolderLoyaltyTier
+    # Unique identifier of the loyalty tier, assigned by Voucherify.
+    attr_accessor :id
+
+    # User-defined name of the loyalty tier.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+        :'name'
+      ])
+    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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      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 &&
+          id == o.id &&
+          name == o.name
+    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
+      [id, name].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/loyalty_card_transaction_details_loyalty_tier.rb

@@ -14,10 +14,12 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Contains information about the loyalty tier.
+  # Contains information about the loyalty tier that is mapped for the earning rule and used in the transaction.
   class LoyaltyCardTransactionDetailsLoyaltyTier
+    # Unique identifier of the loyalty tier, assigned by Voucherify.
     attr_accessor :id
 
+    # User-defined name of the loyalty tier.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb

@@ -15,6 +15,7 @@ require 'time'
 
 module VoucherifySdk
   class LoyaltyCardTransactionsType
+    PENDING_ACTIVATION = "POINTS_PENDING_ACTIVATION".freeze
     ACCRUAL = "POINTS_ACCRUAL".freeze
     REDEMPTION = "POINTS_REDEMPTION".freeze
     REFUND = "POINTS_REFUND".freeze
@@ -25,7 +26,7 @@ module VoucherifySdk
     TRANSFER_OUT = "POINTS_TRANSFER_OUT".freeze
 
     def self.all_vars
-      @all_vars ||= [ACCRUAL, REDEMPTION, REFUND, ADDITION, REMOVAL, EXPIRATION, TRANSFER_IN, TRANSFER_OUT].freeze
+      @all_vars ||= [PENDING_ACTIVATION, ACCRUAL, REDEMPTION, REFUND, ADDITION, REMOVAL, EXPIRATION, TRANSFER_IN, TRANSFER_OUT].freeze
     end
 
     # Builds the enum from string

data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb

@@ -16,7 +16,7 @@ require 'time'
 module VoucherifySdk
   # Object representing loyalty card parameters. Child attributes are present only if `type` is `LOYALTY_CARD`. Defaults to `null`.
   class LoyaltyMemberLoyaltyCard
-    # Total points incurred over the lifespan of the loyalty card.
+    # Total points incurred over the lifespan of the loyalty card, minus the expired points.
     attr_accessor :points
 
     # Points available for reward redemption.
@@ -28,13 +28,17 @@ module VoucherifySdk
     # The amount of points that are set to expire next.
     attr_accessor :next_expiration_points
 
+    # Determines the number of pending points that will be added to the loyalty card after the predefined time.
+    attr_accessor :pending_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'
       }
     end
 
@@ -49,7 +53,8 @@ module VoucherifySdk
         :'points' => :'Integer',
         :'balance' => :'Integer',
         :'next_expiration_date' => :'Date',
-        :'next_expiration_points' => :'Integer'
+        :'next_expiration_points' => :'Integer',
+        :'pending_points' => :'Integer'
       }
     end
 
@@ -59,7 +64,8 @@ module VoucherifySdk
         :'points',
         :'balance',
         :'next_expiration_date',
-        :'next_expiration_points'
+        :'next_expiration_points',
+        :'pending_points'
       ])
     end
 
@@ -86,6 +92,10 @@ 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
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,7 +121,8 @@ 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
     end
 
     # @see the `==` method
@@ -123,7 +134,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].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalty_pending_points.rb

@@ -0,0 +1,314 @@
+=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 pending point entry.
+  class LoyaltyPendingPoints
+    # Unique identifier of the pending point entry, assigned by Voucherify.
+    attr_accessor :id
+
+    # Unique identifier of the loyalty card, assigned by Voucherify.
+    attr_accessor :voucher_id
+
+    # Unique campaign identifier, assigned by Voucherify.
+    attr_accessor :campaign_id
+
+    # Unique customer identifier, assigned by Voucherify.
+    attr_accessor :customer_id
+
+    # Unique order identifier, assigned by Voucherify.
+    attr_accessor :order_id
+
+    # Number of points in the pending state.
+    attr_accessor :points
+
+    # Date when the pending points are activated and added to the customer's loyalty card.
+    attr_accessor :activates_at
+
+    attr_accessor :details
+
+    # Timestamp representing the date and time when the pending point entry was created. The value is shown in the ISO 8601 format.
+    attr_accessor :created_at
+
+    # Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format.
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'voucher_id' => :'voucher_id',
+        :'campaign_id' => :'campaign_id',
+        :'customer_id' => :'customer_id',
+        :'order_id' => :'order_id',
+        :'points' => :'points',
+        :'activates_at' => :'activates_at',
+        :'details' => :'details',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'voucher_id' => :'String',
+        :'campaign_id' => :'String',
+        :'customer_id' => :'String',
+        :'order_id' => :'String',
+        :'points' => :'Integer',
+        :'activates_at' => :'Date',
+        :'details' => :'LoyaltyPendingPointsDetails',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+        :'voucher_id',
+        :'campaign_id',
+        :'customer_id',
+        :'order_id',
+        :'points',
+        :'activates_at',
+        :'created_at',
+        :'updated_at'
+      ])
+    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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'voucher_id')
+        self.voucher_id = attributes[:'voucher_id']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'customer_id')
+        self.customer_id = attributes[:'customer_id']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'points')
+        self.points = attributes[:'points']
+      end
+
+      if attributes.key?(:'activates_at')
+        self.activates_at = attributes[:'activates_at']
+      end
+
+      if attributes.key?(:'details')
+        self.details = attributes[:'details']
+      else
+        self.details = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      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 @details.nil?
+        invalid_properties.push('invalid value for "details", details 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 @details.nil?
+      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 &&
+          id == o.id &&
+          voucher_id == o.voucher_id &&
+          campaign_id == o.campaign_id &&
+          customer_id == o.customer_id &&
+          order_id == o.order_id &&
+          points == o.points &&
+          activates_at == o.activates_at &&
+          details == o.details &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [id, voucher_id, campaign_id, customer_id, order_id, points, activates_at, details, created_at, updated_at].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