voucherify 8.0.3 → 8.1.0

data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb

@@ -16,10 +16,10 @@ require 'time'
 module VoucherifySdk
   # Object representing loyalty card parameters. Child attributes are present only if `type` is `LOYALTY_CARD`. Defaults to `null`.
   class LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard
-    # Total points incurred over the lifespan of the loyalty card, minus the expired points.
+    # Total number of points added to the loyalty card over its lifespan.
     attr_accessor :points
 
-    # Points available for reward redemption.
+    # Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`.
     attr_accessor :balance
 
     # The next closest date when the next set of points are due to expire.
@@ -28,9 +28,15 @@ 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.
+    # Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
     attr_accessor :pending_points
 
+    # Shows the total number of expired points over the lifetime of the loyalty card.
+    attr_accessor :expired_points
+
+    # Shows the total number of subtracted points over the lifetime of the loyalty card.
+    attr_accessor :subtracted_points
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +44,9 @@ module VoucherifySdk
         :'balance' => :'balance',
         :'next_expiration_date' => :'next_expiration_date',
         :'next_expiration_points' => :'next_expiration_points',
-        :'pending_points' => :'pending_points'
+        :'pending_points' => :'pending_points',
+        :'expired_points' => :'expired_points',
+        :'subtracted_points' => :'subtracted_points'
       }
     end
 
@@ -54,7 +62,9 @@ module VoucherifySdk
         :'balance' => :'Integer',
         :'next_expiration_date' => :'Date',
         :'next_expiration_points' => :'Integer',
-        :'pending_points' => :'Integer'
+        :'pending_points' => :'Integer',
+        :'expired_points' => :'Integer',
+        :'subtracted_points' => :'Integer'
       }
     end
 
@@ -65,7 +75,9 @@ module VoucherifySdk
         :'balance',
         :'next_expiration_date',
         :'next_expiration_points',
-        :'pending_points'
+        :'pending_points',
+        :'expired_points',
+        :'subtracted_points'
       ])
     end
 
@@ -96,6 +108,14 @@ module VoucherifySdk
       if attributes.key?(:'pending_points')
         self.pending_points = attributes[:'pending_points']
       end
+
+      if attributes.key?(:'expired_points')
+        self.expired_points = attributes[:'expired_points']
+      end
+
+      if attributes.key?(:'subtracted_points')
+        self.subtracted_points = attributes[:'subtracted_points']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -122,7 +142,9 @@ module VoucherifySdk
           balance == o.balance &&
           next_expiration_date == o.next_expiration_date &&
           next_expiration_points == o.next_expiration_points &&
-          pending_points == o.pending_points
+          pending_points == o.pending_points &&
+          expired_points == o.expired_points &&
+          subtracted_points == o.subtracted_points
     end
 
     # @see the `==` method
@@ -134,7 +156,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [points, balance, next_expiration_date, next_expiration_points, pending_points].hash
+      [points, balance, next_expiration_date, next_expiration_points, pending_points, expired_points, subtracted_points].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb

@@ -16,10 +16,10 @@ require 'time'
 module VoucherifySdk
   # Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD.
   class LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard
-    # Total points incurred over the lifespan of the loyalty card, minus the expired points.
+    # Total number of points added to the loyalty card over its lifespan.
     attr_accessor :points
 
-    # Points available for reward redemption.
+    # Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`.
     attr_accessor :balance
 
     # The next closest date when the next set of points are due to expire.
@@ -28,9 +28,15 @@ 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.
+    # Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
     attr_accessor :pending_points
 
+    # Shows the total number of expired points over the lifetime of the loyalty card.
+    attr_accessor :expired_points
+
+    # Shows the total number of subtracted points over the lifetime of the loyalty card.
+    attr_accessor :subtracted_points
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +44,9 @@ module VoucherifySdk
         :'balance' => :'balance',
         :'next_expiration_date' => :'next_expiration_date',
         :'next_expiration_points' => :'next_expiration_points',
-        :'pending_points' => :'pending_points'
+        :'pending_points' => :'pending_points',
+        :'expired_points' => :'expired_points',
+        :'subtracted_points' => :'subtracted_points'
       }
     end
 
@@ -54,7 +62,9 @@ module VoucherifySdk
         :'balance' => :'Integer',
         :'next_expiration_date' => :'String',
         :'next_expiration_points' => :'Integer',
-        :'pending_points' => :'Integer'
+        :'pending_points' => :'Integer',
+        :'expired_points' => :'Integer',
+        :'subtracted_points' => :'Integer'
       }
     end
 
@@ -65,7 +75,9 @@ module VoucherifySdk
         :'balance',
         :'next_expiration_date',
         :'next_expiration_points',
-        :'pending_points'
+        :'pending_points',
+        :'expired_points',
+        :'subtracted_points'
       ])
     end
 
@@ -96,6 +108,14 @@ module VoucherifySdk
       if attributes.key?(:'pending_points')
         self.pending_points = attributes[:'pending_points']
       end
+
+      if attributes.key?(:'expired_points')
+        self.expired_points = attributes[:'expired_points']
+      end
+
+      if attributes.key?(:'subtracted_points')
+        self.subtracted_points = attributes[:'subtracted_points']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -122,7 +142,9 @@ module VoucherifySdk
           balance == o.balance &&
           next_expiration_date == o.next_expiration_date &&
           next_expiration_points == o.next_expiration_points &&
-          pending_points == o.pending_points
+          pending_points == o.pending_points &&
+          expired_points == o.expired_points &&
+          subtracted_points == o.subtracted_points
     end
 
     # @see the `==` method
@@ -134,7 +156,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [points, balance, next_expiration_date, next_expiration_points, pending_points].hash
+      [points, balance, next_expiration_date, next_expiration_points, pending_points, expired_points, subtracted_points].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_points_expiration_export_create_request_body_parameters.rb

@@ -19,7 +19,7 @@ module VoucherifySdk
     # How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order.
     attr_accessor :order
 
-    # Array of strings containing the data that was exported. These fields define the headers in the CSV file.    The array can be a combination of any of the following available fields:    | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Loyalty points bucket ID. | lopb_Wl1o3EjJIHSNjvO5BDLy4z1n | | campaign_id | Campaign ID of the parent loyalty campaign. | camp_7s3uXI44aKfIk5IhmeOPr6ic | | voucher_id | Voucher ID of the parent loyalty card. | v_YLn0WVWXSXbUfDvxgrgUbtfJ3SQIY655 | | status | Status of the loyalty points bucket. | `ACTIVE` or `INACTIVE` | | expires_at | Timestamp in ISO 8601 format representing the date when the points expire. | 2022-06-30 | | points | Number of points. | 1000 |
+    # Array of strings containing the data that was exported. These fields define the headers in the CSV file.    The array can be a combination of any of the following available fields:    | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Loyalty points bucket ID. | lopb_Wl1o3EjJIHSNjvO5BDLy4z1n | | campaign_id | Campaign ID of the parent loyalty campaign. | camp_7s3uXI44aKfIk5IhmeOPr6ic | | voucher_id | Voucher ID of the parent loyalty card. | v_YLn0WVWXSXbUfDvxgrgUbtfJ3SQIY655 | | status | Status of the loyalty point bucket. | `ACTIVE` or `EXPIRED` | | expires_at | Timestamp in ISO 8601 format representing the date when the points expire. | 2022-06-30 | | points | Number of points. | 1000 |
     attr_accessor :fields
 
     attr_accessor :filters

data/lib/VoucherifySdk/models/loyalties_reward_assignments_reward_get_response_body.rb

@@ -22,7 +22,7 @@ module VoucherifySdk
     # Reward name.
     attr_accessor :name
 
-    # Configurable for **material rewards**. The number of units of the product that you want to share as reward.
+    # Configurable for **material rewards**. The number of units of the product that you want to share as a reward. Use this parameter to code a stock-taking logic.
     attr_accessor :stock
 
     # Defines the number of already invoked (successful) reward redemptions. 

data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body.rb

@@ -0,0 +1,209 @@
+=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
+  # Request body schema for **POST** `v1/loyalties/{campaignId}/transactions/export`.
+  class LoyaltiesTransactionsExportCreateRequestBody
+    attr_accessor :parameters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'parameters' => :'parameters'
+      }
+    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
+      {
+        :'parameters' => :'LoyaltiesTransactionsExportCreateRequestBodyParameters'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'parameters'
+      ])
+    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?(:'parameters')
+        self.parameters = attributes[:'parameters']
+      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 &&
+          parameters == o.parameters
+    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
+      [parameters].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_transactions_export_create_request_body_parameters.rb

@@ -0,0 +1,256 @@
+=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
+  # List of available parameters containing fields and filters that can be exported for transactions in a loyalty card campaign, along with the sorting order of the returned data.
+  class LoyaltiesTransactionsExportCreateRequestBodyParameters
+    # How the export is ordered, where the dash `-` preceding a sorting option means sorting in a descending order.
+    attr_accessor :order
+
+    # Data fields that will be exported for the transactions that are associated with balance movements on cards in a campaign.
+    attr_accessor :fields
+
+    attr_accessor :filters
+
+    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
+      {
+        :'order' => :'order',
+        :'fields' => :'fields',
+        :'filters' => :'filters'
+      }
+    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
+      {
+        :'order' => :'String',
+        :'fields' => :'Array<String>',
+        :'filters' => :'ExportCampaignTransactionsFilters'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'order',
+        :'fields',
+      ])
+    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?(:'order')
+        self.order = attributes[:'order']
+      end
+
+      if attributes.key?(:'fields')
+        if (value = attributes[:'fields']).is_a?(Array)
+          self.fields = value
+        end
+      end
+
+      if attributes.key?(:'filters')
+        self.filters = attributes[:'filters']
+      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'
+      order_validator = EnumAttributeValidator.new('String', ["-created_at", "created_at"])
+      return false unless order_validator.valid?(@order)
+      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 &&
+          order == o.order &&
+          fields == o.fields &&
+          filters == o.filters
+    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
+      [order, fields, filters].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