voucherify 8.0.3 → 8.1.0

data/lib/VoucherifySdk/models/loyalties_transactions_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** `v1/loyalties/{campaignId}/transactions`.
+  class LoyaltiesTransactionsListResponseBody
+    # The type of the object represented by JSON.
+    attr_accessor :object
+
+    # Identifies the name of the attribute that contains the array of transaction objects.
+    attr_accessor :data_ref
+
+    # A dictionary that contains an array of transactions. Each entry in the array is a separate transaction 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 (with a different paging or a different start date filter) 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 transaction ID in the `starting_after_id` query parameter to display another page of the results starting after the transaction 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<LoyaltyCardTransaction>',
+        :'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_update_campaign_request_body.rb

@@ -49,7 +49,7 @@ module VoucherifySdk
     # Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.
     attr_accessor :activity_duration_after_publishing
 
-    # If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them.
+    # If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always `true` for loyalty campaigns and it cannot be changed in them.
     attr_accessor :join_once
 
     # Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.

data/lib/VoucherifySdk/models/loyalties_update_campaign_response_body.rb

@@ -36,7 +36,7 @@ module VoucherifySdk
     # Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
     attr_accessor :auto_join
 
-    # If this value is set to `true`, customers will be able to join the campaign only once.
+    # Always set to `true` for loyalty campaigns, meaning customers can join the campaign only once. It can't be changed to `false`.
     attr_accessor :join_once
 
     # Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.

data/lib/VoucherifySdk/models/loyalty_campaign.rb

@@ -35,7 +35,7 @@ module VoucherifySdk
     # Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
     attr_accessor :auto_join
 
-    # If this value is set to `true`, customers will be able to join the campaign only once.
+    # Always set to `true` for loyalty campaigns, meaning customers can join the campaign only once. It can't be changed to `false`.
     attr_accessor :join_once
 
     # Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.

data/lib/VoucherifySdk/models/loyalty_card_transaction.rb

@@ -27,7 +27,7 @@ module VoucherifySdk
     # Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.
     attr_accessor :campaign_id
 
-    # The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.
+    # The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.
     attr_accessor :source
 
     # Reason why the transaction occurred. In case of a redemption, this value is null.

data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb

@@ -25,6 +25,9 @@ module VoucherifySdk
     # The type of the object represented by the JSON.
     attr_accessor :object
 
+    # Credits added or subtracted on a gift card.
+    attr_accessor :amount
+
     # Points added or subtracted in the transaction of a loyalty card.
     attr_accessor :points
 
@@ -64,6 +67,7 @@ module VoucherifySdk
         :'type' => :'type',
         :'total' => :'total',
         :'object' => :'object',
+        :'amount' => :'amount',
         :'points' => :'points',
         :'balance' => :'balance',
         :'operation_type' => :'operation_type',
@@ -82,6 +86,7 @@ module VoucherifySdk
         :'type' => :'String',
         :'total' => :'Integer',
         :'object' => :'String',
+        :'amount' => :'Integer',
         :'points' => :'Integer',
         :'balance' => :'Integer',
         :'operation_type' => :'String',
@@ -95,6 +100,7 @@ module VoucherifySdk
         :'type',
         :'total',
         :'object',
+        :'amount',
         :'points',
         :'balance',
         :'operation_type',
@@ -124,6 +130,10 @@ module VoucherifySdk
         self.object = 'balance'
       end
 
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
       if attributes.key?(:'points')
         self.points = attributes[:'points']
       end
@@ -170,6 +180,7 @@ module VoucherifySdk
           type == o.type &&
           total == o.total &&
           object == o.object &&
+          amount == o.amount &&
           points == o.points &&
           balance == o.balance &&
           operation_type == o.operation_type &&
@@ -185,7 +196,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, total, object, points, balance, operation_type, related_object].hash
+      [type, total, object, amount, points, balance, operation_type, related_object].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalty_member_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 LoyaltyMemberLoyaltyCard
-    # 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/loyalty_member_publish.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event.  A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or <!-- [publish voucher](OpenAPI.json/paths/~1publications/post) -->[publish voucher](ref:create-publication) API method.   <!-- title: My Table Title -->  | Required | Optional | | -------- | :------: | | `type`:`LOYALTY_CARD` |  `type`:`DISCOUNT_VOUCHER`   |  | `is_referral_code`:`true`      |    `type`:`GIFT_VOUCHER`   | 
+  # This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event.  A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or   | Required | Optional | | -------- | :------: | | `type`:`LOYALTY_CARD` |  `type`:`DISCOUNT_VOUCHER`   |  | `is_referral_code`:`true`      |    `type`:`GIFT_VOUCHER`   | 
   class LoyaltyMemberPublish
     # The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the `url` attribute.
     attr_accessor :object

data/lib/VoucherifySdk/models/loyalty_points_bucket.rb

@@ -27,7 +27,7 @@ module VoucherifySdk
 
     attr_accessor :bucket
 
-    # Loyalty point point bucket status.
+    # Loyalty point bucket status.
     attr_accessor :status
 
     # Date when the number of points defined in the bucket object are due to expire.

data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all.rb

@@ -19,7 +19,7 @@ module VoucherifySdk
     # Tier qualification.     `BALANCE`: Points balance is based on the customer's current points balance. Customers qualify for the tier if their points balance is in the points range of the tier.   `POINTS_IN_PERIOD`: A customer qualifies for the tier only if the sum of the accumulated points in a **defined time interval** reaches the tier threshold.
     attr_accessor :qualification_type
 
-    # Customers can qualify for the tier if they collected enough points in a given time period. So, in addition to the customer having to reach a points range, they also need to have collected the points within a set time period.      | **Period** | **Definition** | |:---|:---| | **Calendar Month** | Points collected in one calendar month<br>January, February, March, etc. | | **Calendar Quarter** | Points collected in the quarter<br>- January - March<br>- April - June<br>- July - September<br>- October - December | | **Calendar Half-year** | Points collected in the half-year<br>- January - June<br>- July - December | | **Calendar Year** | Points collected in one calendar year<br>January - December |
+    # Customers can qualify for the tier if they collected enough points in a given time period. So, in addition to the customer having to reach a points range, they also need to have collected the points within a set time period.      | **Period** | **Definition** | |:---|:---| | **Calendar Month** | Points collected in one calendar month<br />January, February, March, etc. | | **Calendar Quarter** | Points collected in the quarter<br />- January - March<br />- April - June<br />- July - September<br />- October - December | | **Calendar Half-year** | Points collected in the half-year<br />- January - June<br />- July - December | | **Calendar Year** | Points collected in one calendar year<br />January - December |
     attr_accessor :qualification_period
 
     attr_accessor :start_date