voucherify 8.0.1 → 8.0.2

data/lib/VoucherifySdk/models/loyalty_card_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' => :'LoyaltyCardTransactionDetailsBalanceRelatedObject'
       }
     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/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_points_bucket.rb

@@ -0,0 +1,323 @@
+=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 the details about expiring loyalty points.
+  class LoyaltyPointsBucket
+    # Unique identifier of the loyalty points bucket.
+    attr_accessor :id
+
+    # Unique identifier of the parent loyalty card.
+    attr_accessor :voucher_id
+
+    # Unique identifier of the parent campaign.
+    attr_accessor :campaign_id
+
+    attr_accessor :bucket
+
+    # Loyalty point point bucket status.
+    attr_accessor :status
+
+    # Date when the number of points defined in the bucket object are due to expire.
+    attr_accessor :expires_at
+
+    # Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.
+    attr_accessor :created_at
+
+    # Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.
+    attr_accessor :updated_at
+
+    # The type of the object represented by JSON. This object stores information about the loyalty point bucket.
+    attr_accessor :object
+
+    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',
+        :'voucher_id' => :'voucher_id',
+        :'campaign_id' => :'campaign_id',
+        :'bucket' => :'bucket',
+        :'status' => :'status',
+        :'expires_at' => :'expires_at',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'object' => :'object'
+      }
+    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',
+        :'bucket' => :'LoyaltyPointsBucketBucket',
+        :'status' => :'String',
+        :'expires_at' => :'Time',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
+        :'object' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+        :'voucher_id',
+        :'campaign_id',
+        :'bucket',
+        :'status',
+        :'expires_at',
+        :'created_at',
+        :'updated_at',
+        :'object'
+      ])
+    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?(:'bucket')
+        self.bucket = attributes[:'bucket']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      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
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      else
+        self.object = 'loyalty_points_bucket'
+      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'
+      object_validator = EnumAttributeValidator.new('String', ["loyalty_points_bucket"])
+      return false unless object_validator.valid?(@object)
+      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 &&
+          bucket == o.bucket &&
+          status == o.status &&
+          expires_at == o.expires_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          object == o.object
+    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, bucket, status, expires_at, created_at, updated_at, object].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_points_bucket_bucket.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
+  # Defines the number of points stored in this loyalty point bucket.
+  class LoyaltyPointsBucketBucket
+    # Total number of points in the loyalty point bucket.
+    attr_accessor :total_points
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total_points' => :'total_points'
+      }
+    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
+      {
+        :'total_points' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'total_points'
+      ])
+    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?(:'total_points')
+        self.total_points = attributes[:'total_points']
+      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 &&
+          total_points == o.total_points
+    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
+      [total_points].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/order.rb

@@ -37,7 +37,7 @@ module VoucherifySdk
     # 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.
+    # 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
 
     class EnumAttributeValidator

data/lib/VoucherifySdk/models/order_calculated.rb

@@ -55,7 +55,7 @@ module VoucherifySdk
     # 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.
+    # 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
 
     # The type of the object represented by JSON.