voucherify 8.0.1 → 8.0.3

data/lib/VoucherifySdk/models/voucher_transaction.rb

@@ -33,16 +33,16 @@ module VoucherifySdk
     # Reason why the transaction occurred. In case of a redemption, this value is null.
     attr_accessor :reason
 
-    attr_accessor :type
-
-    attr_accessor :details
-
     # The related transaction ID on the receiving card.
     attr_accessor :related_transaction_id
 
     # Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.
     attr_accessor :created_at
 
+    attr_accessor :details
+
+    attr_accessor :type
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -74,10 +74,10 @@ module VoucherifySdk
         :'campaign_id' => :'campaign_id',
         :'source' => :'source',
         :'reason' => :'reason',
-        :'type' => :'type',
-        :'details' => :'details',
         :'related_transaction_id' => :'related_transaction_id',
-        :'created_at' => :'created_at'
+        :'created_at' => :'created_at',
+        :'details' => :'details',
+        :'type' => :'type'
       }
     end
 
@@ -95,10 +95,10 @@ module VoucherifySdk
         :'campaign_id' => :'String',
         :'source' => :'String',
         :'reason' => :'String',
-        :'type' => :'LoyaltyCardTransactionsType',
-        :'details' => :'VoucherTransactionDetails',
         :'related_transaction_id' => :'String',
-        :'created_at' => :'Time'
+        :'created_at' => :'Time',
+        :'details' => :'VoucherTransactionDetails',
+        :'type' => :'String'
       }
     end
 
@@ -111,9 +111,10 @@ module VoucherifySdk
         :'campaign_id',
         :'source',
         :'reason',
-        :'details',
         :'related_transaction_id',
-        :'created_at'
+        :'created_at',
+        :'details',
+        :'type'
       ])
     end
 
@@ -149,16 +150,6 @@ module VoucherifySdk
         self.reason = attributes[:'reason']
       end
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
-      else
-        self.type = nil
-      end
-
-      if attributes.key?(:'details')
-        self.details = attributes[:'details']
-      end
-
       if attributes.key?(:'related_transaction_id')
         self.related_transaction_id = attributes[:'related_transaction_id']
       end
@@ -166,6 +157,14 @@ module VoucherifySdk
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
+
+      if attributes.key?(:'details')
+        self.details = attributes[:'details']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -173,10 +172,6 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -184,7 +179,8 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["CREDITS_REDEMPTION", "CREDITS_REFUND", "CREDITS_ADDITION", "CREDITS_REMOVAL", "POINTS_PENDING_ACTIVATION", "POINTS_ACCRUAL", "POINTS_REDEMPTION", "POINTS_REFUND", "POINTS_ADDITION", "POINTS_REMOVAL", "POINTS_EXPIRATION", "POINTS_TRANSFER_IN", "POINTS_TRANSFER_OUT"])
+      return false unless type_validator.valid?(@type)
       true
     end
 
@@ -199,10 +195,10 @@ module VoucherifySdk
           campaign_id == o.campaign_id &&
           source == o.source &&
           reason == o.reason &&
-          type == o.type &&
-          details == o.details &&
           related_transaction_id == o.related_transaction_id &&
-          created_at == o.created_at
+          created_at == o.created_at &&
+          details == o.details &&
+          type == o.type
     end
 
     # @see the `==` method
@@ -214,7 +210,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, source_id, voucher_id, campaign_id, source, reason, type, details, related_transaction_id, created_at].hash
+      [id, source_id, voucher_id, campaign_id, source, reason, related_transaction_id, created_at, details, type].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/voucher_transaction_details.rb

@@ -36,6 +36,10 @@ module VoucherifySdk
 
     attr_accessor :event_schema
 
+    attr_accessor :holder_loyalty_tier
+
+    attr_accessor :pending_points
+
     attr_accessor :reward
 
     attr_accessor :source_voucher
@@ -55,6 +59,8 @@ module VoucherifySdk
         :'rollback' => :'rollback',
         :'custom_event' => :'custom_event',
         :'event_schema' => :'event_schema',
+        :'holder_loyalty_tier' => :'holder_loyalty_tier',
+        :'pending_points' => :'pending_points',
         :'reward' => :'reward',
         :'source_voucher' => :'source_voucher',
         :'destination_voucher' => :'destination_voucher'
@@ -79,6 +85,8 @@ module VoucherifySdk
         :'rollback' => :'VoucherTransactionDetailsRollback',
         :'custom_event' => :'VoucherTransactionDetailsCustomEvent',
         :'event_schema' => :'VoucherTransactionDetailsEventSchema',
+        :'holder_loyalty_tier' => :'VoucherTransactionDetailsHolderLoyaltyTier',
+        :'pending_points' => :'LoyaltyPendingPoints',
         :'reward' => :'VoucherTransactionDetailsReward',
         :'source_voucher' => :'SimpleVoucher',
         :'destination_voucher' => :'SimpleVoucher'
@@ -88,7 +96,6 @@ module VoucherifySdk
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'balance',
         :'order',
         :'event',
         :'earning_rule',
@@ -98,6 +105,7 @@ module VoucherifySdk
         :'rollback',
         :'custom_event',
         :'event_schema',
+        :'holder_loyalty_tier',
         :'reward',
       ])
     end
@@ -150,6 +158,14 @@ module VoucherifySdk
         self.event_schema = attributes[:'event_schema']
       end
 
+      if attributes.key?(:'holder_loyalty_tier')
+        self.holder_loyalty_tier = attributes[:'holder_loyalty_tier']
+      end
+
+      if attributes.key?(:'pending_points')
+        self.pending_points = attributes[:'pending_points']
+      end
+
       if attributes.key?(:'reward')
         self.reward = attributes[:'reward']
       end
@@ -193,6 +209,8 @@ module VoucherifySdk
           rollback == o.rollback &&
           custom_event == o.custom_event &&
           event_schema == o.event_schema &&
+          holder_loyalty_tier == o.holder_loyalty_tier &&
+          pending_points == o.pending_points &&
           reward == o.reward &&
           source_voucher == o.source_voucher &&
           destination_voucher == o.destination_voucher
@@ -207,7 +225,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [balance, order, event, earning_rule, segment, loyalty_tier, redemption, rollback, custom_event, event_schema, reward, source_voucher, destination_voucher].hash
+      [balance, order, event, earning_rule, segment, loyalty_tier, redemption, rollback, custom_event, event_schema, holder_loyalty_tier, pending_points, reward, source_voucher, destination_voucher].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb

@@ -19,18 +19,21 @@ module VoucherifySdk
     # The type of voucher whose balance is being adjusted due to the transaction.
     attr_accessor :type
 
-    # The number of all points accumulated on the card as affected by add or subtract operations.
+    # The number of all points or credits accumulated on the card as affected by add or subtract operations.
     attr_accessor :total
 
     # The type of the object represented by the JSON.
     attr_accessor :object
 
-    # Points added or subtracted in the transaction.
+    # Points added or subtracted in the transaction of a loyalty card.
     attr_accessor :points
 
-    # The available points on the card after the transaction as affected by redemption or rollback.
+    # The available points or credits on the card after the transaction as affected by redemption or rollback.
     attr_accessor :balance
 
+    # The type of the operation being performed. The operation type is `AUTOMATIC` if it is an automatic redemption.
+    attr_accessor :operation_type
+
     attr_accessor :related_object
 
     class EnumAttributeValidator
@@ -63,6 +66,7 @@ module VoucherifySdk
         :'object' => :'object',
         :'points' => :'points',
         :'balance' => :'balance',
+        :'operation_type' => :'operation_type',
         :'related_object' => :'related_object'
       }
     end
@@ -80,6 +84,7 @@ module VoucherifySdk
         :'object' => :'String',
         :'points' => :'Integer',
         :'balance' => :'Integer',
+        :'operation_type' => :'String',
         :'related_object' => :'VoucherTransactionDetailsBalanceRelatedObject'
       }
     end
@@ -92,6 +97,7 @@ module VoucherifySdk
         :'object',
         :'points',
         :'balance',
+        :'operation_type',
         :'related_object'
       ])
     end
@@ -106,8 +112,6 @@ module VoucherifySdk
 
       if attributes.key?(:'type')
         self.type = attributes[:'type']
-      else
-        self.type = 'loyalty_card'
       end
 
       if attributes.key?(:'total')
@@ -128,6 +132,10 @@ module VoucherifySdk
         self.balance = attributes[:'balance']
       end
 
+      if attributes.key?(:'operation_type')
+        self.operation_type = attributes[:'operation_type']
+      end
+
       if attributes.key?(:'related_object')
         self.related_object = attributes[:'related_object']
       end
@@ -138,16 +146,6 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      pattern = Regexp.new(/loyalty_card/)
-      if !@type.nil? && @type !~ pattern
-        invalid_properties.push("invalid value for \"type\", must conform to the pattern #{pattern}.")
-      end
-
-      pattern = Regexp.new(/balance/)
-      if !@object.nil? && @object !~ pattern
-        invalid_properties.push("invalid value for \"object\", must conform to the pattern #{pattern}.")
-      end
-
       invalid_properties
     end
 
@@ -155,12 +153,12 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      type_validator = EnumAttributeValidator.new('String', ["loyalty_card"])
+      type_validator = EnumAttributeValidator.new('String', ["loyalty_card", "gift_voucher"])
       return false unless type_validator.valid?(@type)
-      return false if !@type.nil? && @type !~ Regexp.new(/loyalty_card/)
       object_validator = EnumAttributeValidator.new('String', ["balance"])
       return false unless object_validator.valid?(@object)
-      return false if !@object.nil? && @object !~ Regexp.new(/balance/)
+      operation_type_validator = EnumAttributeValidator.new('String', ["MANUAL", "AUTOMATIC"])
+      return false unless operation_type_validator.valid?(@operation_type)
       true
     end
 
@@ -174,6 +172,7 @@ module VoucherifySdk
           object == o.object &&
           points == o.points &&
           balance == o.balance &&
+          operation_type == o.operation_type &&
           related_object == o.related_object
     end
 
@@ -186,7 +185,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, total, object, points, balance, related_object].hash
+      [type, total, object, points, balance, operation_type, related_object].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/voucher_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 VoucherTransactionDetailsBalanceRelatedObject
-    # 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/voucher_transaction_details_custom_event.rb

@@ -16,10 +16,10 @@ require 'time'
 module VoucherifySdk
   # Contains information about the custom event that triggers the point accrual.
   class VoucherTransactionDetailsCustomEvent
-    # Unique event ID.
+    # Unique identifier of the event.
     attr_accessor :id
 
-    # Type of custom event.
+    # Type of the custom event.
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb

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

data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb

@@ -16,10 +16,10 @@ require 'time'
 module VoucherifySdk
   # Contains information about the custom event metadata schema.
   class VoucherTransactionDetailsEventSchema
-    # Unique metadata schema ID.
+    # Unique identifier of the metadata schema.
     attr_accessor :id
 
-    # Type of custom event.
+    # Type of the custom event.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/VoucherifySdk/models/voucher_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 VoucherTransactionDetailsHolderLoyaltyTier
+    # 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/voucher_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 VoucherTransactionDetailsLoyaltyTier
+    # 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/voucher_transaction_details_rollback.rb

@@ -16,7 +16,7 @@ require 'time'
 module VoucherifySdk
   # Contains information about the redemption rollback.
   class VoucherTransactionDetailsRollback
-    # Unique redemption rollback ID.
+    # Unique identifier of the redemption rollback.
     attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb

@@ -16,8 +16,10 @@ require 'time'
 module VoucherifySdk
   # Contains information about the segment.
   class VoucherTransactionDetailsSegment
+    # Unique identifier of the segment.
     attr_accessor :id
 
+    # Name of the segment.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.