voucherify 8.0.1 → 8.0.3

data/lib/VoucherifySdk/models/loyalties_members_pending_points_list_response_body.rb

@@ -0,0 +1,286 @@
+=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
+  # Response body schema for **GET** `/loyalties/{campaignId}/members/{memberId}/pending-points` and **GET** `/loyalties/members/{memberId}/pending-points`.
+  class LoyaltiesMembersPendingPointsListResponseBody
+    # The type of the object represented by JSON.
+    attr_accessor :object
+
+    # Identifies the name of the attribute that contains the array of pending point objects.
+    attr_accessor :data_ref
+
+    # A dictionary that contains an array of pending point entries. Each entry in the array is a separate pending point object.
+    attr_accessor :data
+
+    # As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.
+    attr_accessor :has_more
+
+    # Returns an ID that can be used to return another page of results. Use the pending point entry ID in the `starting_after_id` query parameter to display another page of the results starting after the entry with that ID.
+    attr_accessor :more_starting_after
+
+    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
+      {
+        :'object' => :'object',
+        :'data_ref' => :'data_ref',
+        :'data' => :'data',
+        :'has_more' => :'has_more',
+        :'more_starting_after' => :'more_starting_after'
+      }
+    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
+      {
+        :'object' => :'String',
+        :'data_ref' => :'String',
+        :'data' => :'Array<LoyaltyPendingPoints>',
+        :'has_more' => :'Boolean',
+        :'more_starting_after' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'object',
+        :'data_ref',
+        :'data',
+        :'has_more',
+        :'more_starting_after'
+      ])
+    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?(:'object')
+        self.object = attributes[:'object']
+      else
+        self.object = 'list'
+      end
+
+      if attributes.key?(:'data_ref')
+        self.data_ref = attributes[:'data_ref']
+      else
+        self.data_ref = 'data'
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'has_more')
+        self.has_more = attributes[:'has_more']
+      end
+
+      if attributes.key?(:'more_starting_after')
+        self.more_starting_after = attributes[:'more_starting_after']
+      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', ["list"])
+      return false unless object_validator.valid?(@object)
+      data_ref_validator = EnumAttributeValidator.new('String', ["data"])
+      return false unless data_ref_validator.valid?(@data_ref)
+      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 &&
+          object == o.object &&
+          data_ref == o.data_ref &&
+          data == o.data &&
+          has_more == o.has_more &&
+          more_starting_after == o.more_starting_after
+    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
+      [object, data_ref, data, has_more, more_starting_after].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/loyalties_members_points_expiration_list_response_body_data_item.rb

@@ -14,31 +14,32 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
+  # Contains the details about expiring loyalty points.
   class LoyaltiesMembersPointsExpirationListResponseBodyDataItem
-    # Unique loyalty points bucket ID.
+    # Unique identifier of the loyalty points bucket.
     attr_accessor :id
 
-    # Unique parent loyalty card ID.
+    # Unique identifier of the parent loyalty card.
     attr_accessor :voucher_id
 
-    #  Unique parent campaign ID.
+    # Unique identifier of the parent campaign.
     attr_accessor :campaign_id
 
     attr_accessor :bucket
 
-    # Timestamp representing the date and time when the loyalty points bucket object was created. The value is shown in the ISO 8601 format.
-    attr_accessor :created_at
-
-    # Loyalty points bucket point status.
+    # 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 points bucket object was updated. The value is shown in the ISO 8601 format.
+    # 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 points bucket.
+    # The type of the object represented by JSON. This object stores information about the loyalty point bucket.
     attr_accessor :object
 
     class EnumAttributeValidator
@@ -70,9 +71,9 @@ module VoucherifySdk
         :'voucher_id' => :'voucher_id',
         :'campaign_id' => :'campaign_id',
         :'bucket' => :'bucket',
-        :'created_at' => :'created_at',
         :'status' => :'status',
         :'expires_at' => :'expires_at',
+        :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
         :'object' => :'object'
       }
@@ -90,9 +91,9 @@ module VoucherifySdk
         :'voucher_id' => :'String',
         :'campaign_id' => :'String',
         :'bucket' => :'LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket',
-        :'created_at' => :'Time',
         :'status' => :'String',
         :'expires_at' => :'Time',
+        :'created_at' => :'Time',
         :'updated_at' => :'Time',
         :'object' => :'String'
       }
@@ -101,6 +102,15 @@ module VoucherifySdk
     # 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
 
@@ -114,44 +124,30 @@ module VoucherifySdk
 
       if attributes.key?(:'id')
         self.id = attributes[:'id']
-      else
-        self.id = nil
       end
 
       if attributes.key?(:'voucher_id')
         self.voucher_id = attributes[:'voucher_id']
-      else
-        self.voucher_id = nil
       end
 
       if attributes.key?(:'campaign_id')
         self.campaign_id = attributes[:'campaign_id']
-      else
-        self.campaign_id = nil
       end
 
       if attributes.key?(:'bucket')
         self.bucket = attributes[:'bucket']
-      else
-        self.bucket = nil
-      end
-
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
-      else
-        self.created_at = nil
       end
 
       if attributes.key?(:'status')
         self.status = attributes[:'status']
-      else
-        self.status = nil
       end
 
       if attributes.key?(:'expires_at')
         self.expires_at = attributes[:'expires_at']
-      else
-        self.expires_at = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
       if attributes.key?(:'updated_at')
@@ -170,43 +166,6 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
-      if @voucher_id.nil?
-        invalid_properties.push('invalid value for "voucher_id", voucher_id cannot be nil.')
-      end
-
-      if @campaign_id.nil?
-        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
-      end
-
-      if @bucket.nil?
-        invalid_properties.push('invalid value for "bucket", bucket cannot be nil.')
-      end
-
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
-      end
-
-      if @status.nil?
-        invalid_properties.push('invalid value for "status", status cannot be nil.')
-      end
-
-      if @expires_at.nil?
-        invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
-      end
-
-      if @object.nil?
-        invalid_properties.push('invalid value for "object", object cannot be nil.')
-      end
-
-      pattern = Regexp.new(/loyalty_points_bucket/)
-      if @object !~ pattern
-        invalid_properties.push("invalid value for \"object\", must conform to the pattern #{pattern}.")
-      end
-
       invalid_properties
     end
 
@@ -214,17 +173,8 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @id.nil?
-      return false if @voucher_id.nil?
-      return false if @campaign_id.nil?
-      return false if @bucket.nil?
-      return false if @created_at.nil?
-      return false if @status.nil?
-      return false if @expires_at.nil?
-      return false if @object.nil?
       object_validator = EnumAttributeValidator.new('String', ["loyalty_points_bucket"])
       return false unless object_validator.valid?(@object)
-      return false if @object !~ Regexp.new(/loyalty_points_bucket/)
       true
     end
 
@@ -237,9 +187,9 @@ module VoucherifySdk
           voucher_id == o.voucher_id &&
           campaign_id == o.campaign_id &&
           bucket == o.bucket &&
-          created_at == o.created_at &&
           status == o.status &&
           expires_at == o.expires_at &&
+          created_at == o.created_at &&
           updated_at == o.updated_at &&
           object == o.object
     end
@@ -253,7 +203,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, voucher_id, campaign_id, bucket, created_at, status, expires_at, updated_at, object].hash
+      [id, voucher_id, campaign_id, bucket, status, expires_at, created_at, updated_at, object].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item_bucket.rb

@@ -14,9 +14,9 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Defines the number of points stored in the given loyalty points bucket.
+  # Defines the number of points stored in this loyalty point bucket.
   class LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket
-    # Total number of points in the loyalty points bucket.
+    # Total number of points in the loyalty point bucket.
     attr_accessor :total_points
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -41,6 +41,7 @@ module VoucherifySdk
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_points'
       ])
     end
 
@@ -54,8 +55,6 @@ module VoucherifySdk
 
       if attributes.key?(:'total_points')
         self.total_points = attributes[:'total_points']
-      else
-        self.total_points = nil
       end
     end
 
@@ -64,10 +63,6 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @total_points.nil?
-        invalid_properties.push('invalid value for "total_points", total_points cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -75,7 +70,6 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @total_points.nil?
       true
     end
 

data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_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 LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard
-    # 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/loyalties_members_transfers_create_response_body_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.
   class LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard
-    # 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' => :'String',
-        :'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