voucherify 8.0.3 → 8.1.0

data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb

@@ -18,14 +18,18 @@ module VoucherifySdk
     # Number assigned to the order line item in accordance with the order sent in the request.
     attr_accessor :index
 
-    # Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `\"skip_initially\": 1`, `\"repeat\": 3`. The counting of units starts from `1`.
+    # Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `\"skip_initially\": 1`, `\"repeat\": 3`. The counting of units starts from `1`. The maximum quantity of all handled units is 1000. If the quantity of all order items exceeds 1000, this array is not returned, but `units_limit_exceeded: true`. However, the discount is calculated properly for all relevant units.
     attr_accessor :units
 
+    # Returned as `true` only when the sum total of `quantity` of all order items exceeds 1000.
+    attr_accessor :units_limit_exceeded
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'index' => :'index',
-        :'units' => :'units'
+        :'units' => :'units',
+        :'units_limit_exceeded' => :'units_limit_exceeded'
       }
     end
 
@@ -38,7 +42,8 @@ module VoucherifySdk
     def self.openapi_types
       {
         :'index' => :'Integer',
-        :'units' => :'Array<Integer>'
+        :'units' => :'Array<Integer>',
+        :'units_limit_exceeded' => :'Boolean'
       }
     end
 
@@ -65,6 +70,10 @@ module VoucherifySdk
           self.units = value
         end
       end
+
+      if attributes.key?(:'units_limit_exceeded')
+        self.units_limit_exceeded = attributes[:'units_limit_exceeded']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -72,6 +81,10 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@index.nil? && @index < 0
+        invalid_properties.push('invalid value for "index", must be greater than or equal to 0.')
+      end
+
       invalid_properties
     end
 
@@ -79,6 +92,7 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@index.nil? && @index < 0
       true
     end
 
@@ -88,7 +102,8 @@ module VoucherifySdk
       return true if self.equal?(o)
       self.class == o.class &&
           index == o.index &&
-          units == o.units
+          units == o.units &&
+          units_limit_exceeded == o.units_limit_exceeded
     end
 
     # @see the `==` method
@@ -100,7 +115,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [index, units].hash
+      [index, units, units_limit_exceeded].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb

@@ -22,10 +22,10 @@ module VoucherifySdk
     # An optional field to keep any extra textual information about the campaign such as a campaign description and details.
     attr_accessor :description
 
-    # Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published
+    # Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: the campaign is a generic (standalone) one with a single voucher for public use (only for discount and gift card campaigns)
     attr_accessor :type
 
-    # If this value is set to `true`, customers will be able to join the campaign only once.
+    # If this value is set to `true`, customers will be able to join the campaign only once. For loyalty campaigns, it's forced to `true`, even if `join_once: false` is passed in the request.
     attr_accessor :join_once
 
     # Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
@@ -283,7 +283,7 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      type_validator = EnumAttributeValidator.new('String', ["AUTO_UPDATE", "STATIC"])
+      type_validator = EnumAttributeValidator.new('String', ["AUTO_UPDATE", "STATIC", "STANDALONE"])
       return false unless type_validator.valid?(@type)
       return false if !@validation_rules.nil? && @validation_rules.length > 1
       campaign_type_validator = EnumAttributeValidator.new('String', ["LOYALTY_PROGRAM"])

data/lib/VoucherifySdk/models/loyalties_create_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/loyalties_earning_rules_create_request_body_item.rb

@@ -27,12 +27,16 @@ module VoucherifySdk
     # A flag to toggle the earning rule on or off. You can disable an earning rule even though it's within the active period defined by the `start_date` and `expiration_date` of the campaign or the earning rule's own `start_date` and `expiration_date`.    - `true` indicates an *active* earning rule - `false` indicates an *inactive* earning rule
     attr_accessor :active
 
-    # Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. Earning rule is *inactive before* this date. If you don't define the start date for an earning rule, it'll inherit the campaign start date by default. 
+    # Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. Earning rule is *inactive before* this date. If you don't define the start date for an earning rule, it will inherit the campaign start date by default. 
     attr_accessor :start_date
 
-    # Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format.  Earning rule is *inactive after* this date.If you don't define the expiration date for an earning rule, it'll inherit the campaign expiration date by default.
+    # Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format.  Earning rule is *inactive after* this date.If you don't define the expiration date for an earning rule, it will inherit the campaign expiration date by default.
     attr_accessor :expiration_date
 
+    attr_accessor :pending_points
+
+    attr_accessor :expiration_rules
+
     attr_accessor :validity_timeframe
 
     # Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday
@@ -81,6 +85,8 @@ module VoucherifySdk
         :'active' => :'active',
         :'start_date' => :'start_date',
         :'expiration_date' => :'expiration_date',
+        :'pending_points' => :'pending_points',
+        :'expiration_rules' => :'expiration_rules',
         :'validity_timeframe' => :'validity_timeframe',
         :'validity_day_of_week' => :'validity_day_of_week',
         :'validity_hours' => :'validity_hours',
@@ -106,6 +112,8 @@ module VoucherifySdk
         :'active' => :'Boolean',
         :'start_date' => :'Time',
         :'expiration_date' => :'Time',
+        :'pending_points' => :'LoyaltiesEarningRulesCreateRequestBodyItemPendingPoints',
+        :'expiration_rules' => :'EarningRuleExpirationRules',
         :'validity_timeframe' => :'ValidityTimeframe',
         :'validity_day_of_week' => :'Array<Integer>',
         :'validity_hours' => :'ValidityHours',
@@ -123,6 +131,7 @@ module VoucherifySdk
         :'active',
         :'start_date',
         :'expiration_date',
+        :'pending_points',
         :'metadata',
         :'segment',
         :'custom_event',
@@ -166,6 +175,14 @@ module VoucherifySdk
         self.expiration_date = attributes[:'expiration_date']
       end
 
+      if attributes.key?(:'pending_points')
+        self.pending_points = attributes[:'pending_points']
+      end
+
+      if attributes.key?(:'expiration_rules')
+        self.expiration_rules = attributes[:'expiration_rules']
+      end
+
       if attributes.key?(:'validity_timeframe')
         self.validity_timeframe = attributes[:'validity_timeframe']
       end
@@ -224,6 +241,8 @@ module VoucherifySdk
           active == o.active &&
           start_date == o.start_date &&
           expiration_date == o.expiration_date &&
+          pending_points == o.pending_points &&
+          expiration_rules == o.expiration_rules &&
           validity_timeframe == o.validity_timeframe &&
           validity_day_of_week == o.validity_day_of_week &&
           validity_hours == o.validity_hours &&
@@ -242,7 +261,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [validation_rule_id, loyalty, event, source, active, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, metadata, segment, custom_event, loyalty_tier].hash
+      [validation_rule_id, loyalty, event, source, active, start_date, expiration_date, pending_points, expiration_rules, validity_timeframe, validity_day_of_week, validity_hours, metadata, segment, custom_event, loyalty_tier].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb

@@ -20,6 +20,9 @@ module VoucherifySdk
     # Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points.
     attr_accessor :points
 
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
     attr_accessor :calculation_type
 
     attr_accessor :order
@@ -57,6 +60,7 @@ module VoucherifySdk
       {
         :'type' => :'type',
         :'points' => :'points',
+        :'points_formula' => :'points_formula',
         :'calculation_type' => :'calculation_type',
         :'order' => :'order',
         :'order_items' => :'order_items',
@@ -75,6 +79,7 @@ module VoucherifySdk
       {
         :'type' => :'String',
         :'points' => :'Integer',
+        :'points_formula' => :'String',
         :'calculation_type' => :'String',
         :'order' => :'LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrder',
         :'order_items' => :'LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems',
@@ -87,6 +92,7 @@ module VoucherifySdk
     def self.openapi_nullable
       Set.new([
         :'points',
+        :'points_formula',
         :'customer',
         :'custom_event'
       ])
@@ -108,6 +114,10 @@ module VoucherifySdk
         self.points = attributes[:'points']
       end
 
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
+
       if attributes.key?(:'calculation_type')
         self.calculation_type = attributes[:'calculation_type']
       end
@@ -155,6 +165,7 @@ module VoucherifySdk
       self.class == o.class &&
           type == o.type &&
           points == o.points &&
+          points_formula == o.points_formula &&
           calculation_type == o.calculation_type &&
           order == o.order &&
           order_items == o.order_items &&
@@ -171,7 +182,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, points, calculation_type, order, order_items, customer, custom_event].hash
+      [type, points, points_formula, calculation_type, order, order_items, customer, custom_event].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_custom_event_metadata.rb

@@ -22,6 +22,9 @@ module VoucherifySdk
     # Number of points to be awarded, i.e. how many points to be added to the loyalty card.
     attr_accessor :points
 
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
     #  Custom event metadata property.
     attr_accessor :property
 
@@ -30,6 +33,7 @@ module VoucherifySdk
       {
         :'every' => :'every',
         :'points' => :'points',
+        :'points_formula' => :'points_formula',
         :'property' => :'property'
       }
     end
@@ -44,6 +48,7 @@ module VoucherifySdk
       {
         :'every' => :'Integer',
         :'points' => :'Integer',
+        :'points_formula' => :'String',
         :'property' => :'String'
       }
     end
@@ -53,6 +58,7 @@ module VoucherifySdk
       Set.new([
         :'every',
         :'points',
+        :'points_formula',
         :'property'
       ])
     end
@@ -73,6 +79,10 @@ module VoucherifySdk
         self.points = attributes[:'points']
       end
 
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
+
       if attributes.key?(:'property')
         self.property = attributes[:'property']
       end
@@ -100,6 +110,7 @@ module VoucherifySdk
       self.class == o.class &&
           every == o.every &&
           points == o.points &&
+          points_formula == o.points_formula &&
           property == o.property
     end
 
@@ -112,7 +123,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [every, points, property].hash
+      [every, points, points_formula, property].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_customer_metadata.rb

@@ -22,6 +22,9 @@ module VoucherifySdk
     # Number of points to be awarded, i.e. how many points to be added to the loyalty card.
     attr_accessor :points
 
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
     # Customer metadata property.
     attr_accessor :property
 
@@ -30,6 +33,7 @@ module VoucherifySdk
       {
         :'every' => :'every',
         :'points' => :'points',
+        :'points_formula' => :'points_formula',
         :'property' => :'property'
       }
     end
@@ -44,6 +48,7 @@ module VoucherifySdk
       {
         :'every' => :'Integer',
         :'points' => :'Integer',
+        :'points_formula' => :'String',
         :'property' => :'String'
       }
     end
@@ -53,6 +58,7 @@ module VoucherifySdk
       Set.new([
         :'every',
         :'points',
+        :'points_formula',
         :'property'
       ])
     end
@@ -73,6 +79,10 @@ module VoucherifySdk
         self.points = attributes[:'points']
       end
 
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
+
       if attributes.key?(:'property')
         self.property = attributes[:'property']
       end
@@ -100,6 +110,7 @@ module VoucherifySdk
       self.class == o.class &&
           every == o.every &&
           points == o.points &&
+          points_formula == o.points_formula &&
           property == o.property
     end
 
@@ -112,7 +123,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [every, points, property].hash
+      [every, points, points_formula, property].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_amount.rb

@@ -22,11 +22,15 @@ module VoucherifySdk
     # Number of points to be awarded, i.e. how many points to be added to the loyalty card.
     attr_accessor :points
 
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'every' => :'every',
-        :'points' => :'points'
+        :'points' => :'points',
+        :'points_formula' => :'points_formula'
       }
     end
 
@@ -39,7 +43,8 @@ module VoucherifySdk
     def self.openapi_types
       {
         :'every' => :'Integer',
-        :'points' => :'Integer'
+        :'points' => :'Integer',
+        :'points_formula' => :'String'
       }
     end
 
@@ -47,7 +52,8 @@ module VoucherifySdk
     def self.openapi_nullable
       Set.new([
         :'every',
-        :'points'
+        :'points',
+        :'points_formula'
       ])
     end
 
@@ -66,6 +72,10 @@ module VoucherifySdk
       if attributes.key?(:'points')
         self.points = attributes[:'points']
       end
+
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,7 +99,8 @@ module VoucherifySdk
       return true if self.equal?(o)
       self.class == o.class &&
           every == o.every &&
-          points == o.points
+          points == o.points &&
+          points_formula == o.points_formula
     end
 
     # @see the `==` method
@@ -101,7 +112,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [every, points].hash
+      [every, points, points_formula].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount.rb

@@ -22,12 +22,18 @@ module VoucherifySdk
     # Number of points to be awarded, i.e. how many points to be added to the loyalty card.
     attr_accessor :points
 
-    # Type of object taken under consideration.
+    # Formula used to dynamically calculate the rewarded points.
+    attr_accessor :points_formula
+
+    # Type of object which will be covered by the earning rule. This is required together with `id`. Can be replaced by the `applicable_to` array. In response, the value of the first object is returned even if `applicable_to` array was used.
     attr_accessor :object
 
-    # Unique ID of the resource, i.e. pc_75U0dHlr7u75BJodrW1AE3t6, prod_0bae32322150fd0546, or sku_0b7d7dfb090be5c619.
+    # Unique ID of the resource assigned by Voucherify. This is required together with `object`. Can be replaced by the `applicable_to` array. In response, the value of the first object is returned even if `applicable_to` array was used. Values are, for example, `pc_75U0dHlr7u75BJodrW1AE3t6` for product collection, `prod_0bae32322150fd0546` for a product, or `sku_0b7d7dfb090be5c619` for a SKU.
     attr_accessor :id
 
+    # Defines products, SKUs, or product collections covered by the earning rule. Can be replaced by `object` and `id` to define only one object.
+    attr_accessor :applicable_to
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -55,8 +61,10 @@ module VoucherifySdk
       {
         :'every' => :'every',
         :'points' => :'points',
+        :'points_formula' => :'points_formula',
         :'object' => :'object',
-        :'id' => :'id'
+        :'id' => :'id',
+        :'applicable_to' => :'applicable_to'
       }
     end
 
@@ -70,8 +78,10 @@ module VoucherifySdk
       {
         :'every' => :'Integer',
         :'points' => :'Integer',
+        :'points_formula' => :'String',
         :'object' => :'String',
-        :'id' => :'String'
+        :'id' => :'String',
+        :'applicable_to' => :'Array<LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmountApplicableToItem>'
       }
     end
 
@@ -80,8 +90,10 @@ module VoucherifySdk
       Set.new([
         :'every',
         :'points',
+        :'points_formula',
         :'object',
-        :'id'
+        :'id',
+        :'applicable_to'
       ])
     end
 
@@ -101,6 +113,10 @@ module VoucherifySdk
         self.points = attributes[:'points']
       end
 
+      if attributes.key?(:'points_formula')
+        self.points_formula = attributes[:'points_formula']
+      end
+
       if attributes.key?(:'object')
         self.object = attributes[:'object']
       end
@@ -108,6 +124,12 @@ module VoucherifySdk
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
+
+      if attributes.key?(:'applicable_to')
+        if (value = attributes[:'applicable_to']).is_a?(Array)
+          self.applicable_to = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -134,8 +156,10 @@ module VoucherifySdk
       self.class == o.class &&
           every == o.every &&
           points == o.points &&
+          points_formula == o.points_formula &&
           object == o.object &&
-          id == o.id
+          id == o.id &&
+          applicable_to == o.applicable_to
     end
 
     # @see the `==` method
@@ -147,7 +171,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [every, points, object, id].hash
+      [every, points, points_formula, object, id, applicable_to].hash
     end
 
     # Builds the object from hash