voucherify 8.0.2 → 8.1.0

data/lib/VoucherifySdk/models/redeemable_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 RedeemableVoucherLoyaltyCard
-    # Total points incurred over the lifespan of the loyalty card.
+    # 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,13 +28,25 @@ module VoucherifySdk
     # The amount of points that are set to expire next.
     attr_accessor :next_expiration_points
 
+    # 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
       {
         :'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',
+        :'expired_points' => :'expired_points',
+        :'subtracted_points' => :'subtracted_points'
       }
     end
 
@@ -49,7 +61,10 @@ module VoucherifySdk
         :'points' => :'Integer',
         :'balance' => :'Integer',
         :'next_expiration_date' => :'Date',
-        :'next_expiration_points' => :'Integer'
+        :'next_expiration_points' => :'Integer',
+        :'pending_points' => :'Integer',
+        :'expired_points' => :'Integer',
+        :'subtracted_points' => :'Integer'
       }
     end
 
@@ -59,7 +74,10 @@ module VoucherifySdk
         :'points',
         :'balance',
         :'next_expiration_date',
-        :'next_expiration_points'
+        :'next_expiration_points',
+        :'pending_points',
+        :'expired_points',
+        :'subtracted_points'
       ])
     end
 
@@ -86,6 +104,18 @@ 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
+
+      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?
@@ -111,7 +141,10 @@ 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 &&
+          expired_points == o.expired_points &&
+          subtracted_points == o.subtracted_points
     end
 
     # @see the `==` method
@@ -123,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].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/redeemable_voucher_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 RedeemableVoucherPublish
     # 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/redemption.rb

@@ -46,6 +46,8 @@ module VoucherifySdk
     # Redemption status.
     attr_accessor :status
 
+    attr_accessor :session
+
     attr_accessor :related_redemptions
 
     # If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.
@@ -111,6 +113,7 @@ module VoucherifySdk
         :'redemption' => :'redemption',
         :'result' => :'result',
         :'status' => :'status',
+        :'session' => :'session',
         :'related_redemptions' => :'related_redemptions',
         :'failure_code' => :'failure_code',
         :'failure_message' => :'failure_message',
@@ -145,6 +148,7 @@ module VoucherifySdk
         :'redemption' => :'String',
         :'result' => :'String',
         :'status' => :'String',
+        :'session' => :'RedemptionSession',
         :'related_redemptions' => :'RedemptionRelatedRedemptions',
         :'failure_code' => :'String',
         :'failure_message' => :'String',
@@ -174,6 +178,7 @@ module VoucherifySdk
         :'redemption',
         :'result',
         :'status',
+        :'session',
         :'related_redemptions',
         :'failure_code',
         :'failure_message',
@@ -236,6 +241,10 @@ module VoucherifySdk
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'session')
+        self.session = attributes[:'session']
+      end
+
       if attributes.key?(:'related_redemptions')
         self.related_redemptions = attributes[:'related_redemptions']
       end
@@ -327,6 +336,7 @@ module VoucherifySdk
           redemption == o.redemption &&
           result == o.result &&
           status == o.status &&
+          session == o.session &&
           related_redemptions == o.related_redemptions &&
           failure_code == o.failure_code &&
           failure_message == o.failure_message &&
@@ -351,7 +361,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, object, date, customer_id, tracking_id, metadata, amount, redemption, result, status, related_redemptions, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, promotion_tier, reward, gift, loyalty_card, voucher].hash
+      [id, object, date, customer_id, tracking_id, metadata, amount, redemption, result, status, session, related_redemptions, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, promotion_tier, reward, gift, loyalty_card, voucher].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/redemption_entry.rb

@@ -42,6 +42,8 @@ module VoucherifySdk
 
     attr_accessor :status
 
+    attr_accessor :session
+
     attr_accessor :related_redemptions
 
     # If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.
@@ -109,6 +111,7 @@ module VoucherifySdk
         :'redemption' => :'redemption',
         :'result' => :'result',
         :'status' => :'status',
+        :'session' => :'session',
         :'related_redemptions' => :'related_redemptions',
         :'failure_code' => :'failure_code',
         :'failure_message' => :'failure_message',
@@ -144,6 +147,7 @@ module VoucherifySdk
         :'redemption' => :'String',
         :'result' => :'String',
         :'status' => :'String',
+        :'session' => :'RedemptionEntrySession',
         :'related_redemptions' => :'RedemptionEntryRelatedRedemptions',
         :'failure_code' => :'String',
         :'failure_message' => :'String',
@@ -174,6 +178,7 @@ module VoucherifySdk
         :'redemption',
         :'result',
         :'status',
+        :'session',
         :'related_redemptions',
         :'failure_code',
         :'failure_message',
@@ -238,6 +243,10 @@ module VoucherifySdk
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'session')
+        self.session = attributes[:'session']
+      end
+
       if attributes.key?(:'related_redemptions')
         self.related_redemptions = attributes[:'related_redemptions']
       end
@@ -333,6 +342,7 @@ module VoucherifySdk
           redemption == o.redemption &&
           result == o.result &&
           status == o.status &&
+          session == o.session &&
           related_redemptions == o.related_redemptions &&
           failure_code == o.failure_code &&
           failure_message == o.failure_message &&
@@ -358,7 +368,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, object, date, customer_id, tracking_id, metadata, amount, redemption, result, status, related_redemptions, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, promotion_tier, reward, gift, loyalty_card, voucher, reason].hash
+      [id, object, date, customer_id, tracking_id, metadata, amount, redemption, result, status, session, related_redemptions, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, promotion_tier, reward, gift, loyalty_card, voucher, reason].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/redemption_entry_order.rb

@@ -24,36 +24,33 @@ module VoucherifySdk
     # The order status.
     attr_accessor :status
 
-    # A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
+    # This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :amount
 
-    # A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
+    # This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :initial_amount
 
-    # Sum of all order-level discounts applied to the order.
+    # Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :discount_amount
 
-    # Sum of all product-specific discounts applied to the order.
+    # Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :items_discount_amount
 
-    # Sum of all order-level AND all product-specific discounts applied to the order.
+    # Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :total_discount_amount
 
-    # Order amount after undoing all the discounts through the rollback redemption.
+    # Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :total_amount
 
-    # This field shows the order-level discount applied.
+    # This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
     attr_accessor :applied_discount_amount
 
-    # Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)`
+    # Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).   `sum(items, i => i.applied_discount_amount)`
     attr_accessor :items_applied_discount_amount
 
-    # Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`
+    # Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`
     attr_accessor :total_applied_discount_amount
 
-    # 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. It can be used to define business validation rules or discount formulas.
     attr_accessor :metadata
 
@@ -66,7 +63,7 @@ module VoucherifySdk
     # Timestamp representing the date and time when the order was last updated in ISO 8601 format.
     attr_accessor :updated_at
 
-    # Unique customer ID of the customer making the purchase.
+    # Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
     attr_accessor :customer_id
 
     # Unique referrer ID.
@@ -78,6 +75,9 @@ module VoucherifySdk
 
     attr_accessor :redemptions
 
+    # Array of items applied to the order. It can include up 500 items.
+    attr_accessor :items
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -115,7 +115,6 @@ module VoucherifySdk
         :'applied_discount_amount' => :'applied_discount_amount',
         :'items_applied_discount_amount' => :'items_applied_discount_amount',
         :'total_applied_discount_amount' => :'total_applied_discount_amount',
-        :'items' => :'items',
         :'metadata' => :'metadata',
         :'object' => :'object',
         :'created_at' => :'created_at',
@@ -124,7 +123,8 @@ module VoucherifySdk
         :'referrer_id' => :'referrer_id',
         :'customer' => :'customer',
         :'referrer' => :'referrer',
-        :'redemptions' => :'redemptions'
+        :'redemptions' => :'redemptions',
+        :'items' => :'items'
       }
     end
 
@@ -148,7 +148,6 @@ module VoucherifySdk
         :'applied_discount_amount' => :'Integer',
         :'items_applied_discount_amount' => :'Integer',
         :'total_applied_discount_amount' => :'Integer',
-        :'items' => :'Array<OrderCalculatedItem>',
         :'metadata' => :'Object',
         :'object' => :'String',
         :'created_at' => :'Time',
@@ -157,7 +156,8 @@ module VoucherifySdk
         :'referrer_id' => :'String',
         :'customer' => :'RedemptionEntryOrderCustomer',
         :'referrer' => :'RedemptionEntryOrderReferrer',
-        :'redemptions' => :'Hash<String, OrderRedemptionsEntry>'
+        :'redemptions' => :'Hash<String, OrderRedemptionsEntry>',
+        :'items' => :'Array<OrderCalculatedItem>'
       }
     end
 
@@ -176,7 +176,6 @@ module VoucherifySdk
         :'applied_discount_amount',
         :'items_applied_discount_amount',
         :'total_applied_discount_amount',
-        :'items',
         :'metadata',
         :'object',
         :'created_at',
@@ -185,7 +184,8 @@ module VoucherifySdk
         :'referrer_id',
         :'customer',
         :'referrer',
-        :'redemptions'
+        :'redemptions',
+        :'items'
       ])
     end
 
@@ -245,12 +245,6 @@ module VoucherifySdk
         self.total_applied_discount_amount = attributes[:'total_applied_discount_amount']
       end
 
-      if attributes.key?(:'items')
-        if (value = attributes[:'items']).is_a?(Array)
-          self.items = value
-        end
-      end
-
       if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
@@ -290,6 +284,12 @@ module VoucherifySdk
           self.redemptions = value
         end
       end
+
+      if attributes.key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -328,7 +328,6 @@ module VoucherifySdk
           applied_discount_amount == o.applied_discount_amount &&
           items_applied_discount_amount == o.items_applied_discount_amount &&
           total_applied_discount_amount == o.total_applied_discount_amount &&
-          items == o.items &&
           metadata == o.metadata &&
           object == o.object &&
           created_at == o.created_at &&
@@ -337,7 +336,8 @@ module VoucherifySdk
           referrer_id == o.referrer_id &&
           customer == o.customer &&
           referrer == o.referrer &&
-          redemptions == o.redemptions
+          redemptions == o.redemptions &&
+          items == o.items
     end
 
     # @see the `==` method
@@ -349,7 +349,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, source_id, status, amount, initial_amount, discount_amount, items_discount_amount, total_discount_amount, total_amount, applied_discount_amount, items_applied_discount_amount, total_applied_discount_amount, items, metadata, object, created_at, updated_at, customer_id, referrer_id, customer, referrer, redemptions].hash
+      [id, source_id, status, amount, initial_amount, discount_amount, items_discount_amount, total_discount_amount, total_amount, applied_discount_amount, items_applied_discount_amount, total_applied_discount_amount, metadata, object, created_at, updated_at, customer_id, referrer_id, customer, referrer, redemptions, items].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb

@@ -31,7 +31,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/redemption_entry_related_redemptions_rollbacks_item.rb

@@ -20,11 +20,37 @@ module VoucherifySdk
     # Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
     attr_accessor :date
 
+    # Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values. This is returned only in GET `v1/redemptions/` and GET `v1/redemptions/{redemptionId}` endpoints.
+    attr_accessor :rollback_order_mode
+
+    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',
-        :'date' => :'date'
+        :'date' => :'date',
+        :'rollback_order_mode' => :'rollback_order_mode'
       }
     end
 
@@ -37,7 +63,8 @@ module VoucherifySdk
     def self.openapi_types
       {
         :'id' => :'String',
-        :'date' => :'Time'
+        :'date' => :'Time',
+        :'rollback_order_mode' => :'String'
       }
     end
 
@@ -62,6 +89,10 @@ module VoucherifySdk
       if attributes.key?(:'date')
         self.date = attributes[:'date']
       end
+
+      if attributes.key?(:'rollback_order_mode')
+        self.rollback_order_mode = attributes[:'rollback_order_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -76,6 +107,8 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      rollback_order_mode_validator = EnumAttributeValidator.new('String', ["WITH_ORDER", "WITHOUT_ORDER"])
+      return false unless rollback_order_mode_validator.valid?(@rollback_order_mode)
       true
     end
 
@@ -85,7 +118,8 @@ module VoucherifySdk
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          date == o.date
+          date == o.date &&
+          rollback_order_mode == o.rollback_order_mode
     end
 
     # @see the `==` method
@@ -97,7 +131,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, date].hash
+      [id, date, rollback_order_mode].hash
     end
 
     # Builds the object from hash