talon_one 3.0.1 → 4.0.0

data/lib/talon_one/models/cart_item.rb

@@ -20,7 +20,7 @@ module TalonOne
     # Stock keeping unit of item.
     attr_accessor :sku
 
-    # Quantity of item. **Important:** If you enabled [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening), the quantity is always one and the same cart item might receive multiple per-item discounts. Ensure you can process multiple discounts on one cart item correctly. 
+    # Number of units of this item. Due to [cart item flattening](https://docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of **per-item** effects triggered from your campaigns. 
     attr_accessor :quantity
 
     # Number of returned items, calculated internally based on returns of this item.
@@ -35,6 +35,8 @@ module TalonOne
     # Type, group or model of the item.
     attr_accessor :category
 
+    attr_accessor :product
+
     # Weight of item in grams.
     attr_accessor :weight
 
@@ -56,7 +58,7 @@ module TalonOne
     # Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). 
     attr_accessor :additional_costs
 
-    # The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-cart-item-catalogs).
+    # The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog).
     attr_accessor :catalog_item_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -69,6 +71,7 @@ module TalonOne
         :'remaining_quantity' => :'remainingQuantity',
         :'price' => :'price',
         :'category' => :'category',
+        :'product' => :'product',
         :'weight' => :'weight',
         :'height' => :'height',
         :'width' => :'width',
@@ -90,6 +93,7 @@ module TalonOne
         :'remaining_quantity' => :'Integer',
         :'price' => :'Float',
         :'category' => :'String',
+        :'product' => :'Product',
         :'weight' => :'Float',
         :'height' => :'Float',
         :'width' => :'Float',
@@ -150,6 +154,10 @@ module TalonOne
         self.category = attributes[:'category']
       end
 
+      if attributes.key?(:'product')
+        self.product = attributes[:'product']
+      end
+
       if attributes.key?(:'weight')
         self.weight = attributes[:'weight']
       end
@@ -258,6 +266,7 @@ module TalonOne
           remaining_quantity == o.remaining_quantity &&
           price == o.price &&
           category == o.category &&
+          product == o.product &&
           weight == o.weight &&
           height == o.height &&
           width == o.width &&
@@ -277,7 +286,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, sku, quantity, returned_quantity, remaining_quantity, price, category, weight, height, width, length, position, attributes, additional_costs, catalog_item_id].hash
+      [name, sku, quantity, returned_quantity, remaining_quantity, price, category, product, weight, height, width, length, position, attributes, additional_costs, catalog_item_id].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/catalog_item.rb

@@ -35,6 +35,8 @@ module TalonOne
 
     attr_accessor :attributes
 
+    attr_accessor :product
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -44,7 +46,8 @@ module TalonOne
         :'price' => :'price',
         :'catalogid' => :'catalogid',
         :'version' => :'version',
-        :'attributes' => :'attributes'
+        :'attributes' => :'attributes',
+        :'product' => :'product'
       }
     end
 
@@ -57,7 +60,8 @@ module TalonOne
         :'price' => :'Float',
         :'catalogid' => :'Integer',
         :'version' => :'Integer',
-        :'attributes' => :'Array<ItemAttribute>'
+        :'attributes' => :'Array<ItemAttribute>',
+        :'product' => :'Product'
       }
     end
 
@@ -111,6 +115,10 @@ module TalonOne
           self.attributes = value
         end
       end
+
+      if attributes.key?(:'product')
+        self.product = attributes[:'product']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -181,7 +189,8 @@ module TalonOne
           price == o.price &&
           catalogid == o.catalogid &&
           version == o.version &&
-          attributes == o.attributes
+          attributes == o.attributes &&
+          product == o.product
     end
 
     # @see the `==` method
@@ -193,7 +202,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, sku, price, catalogid, version, attributes].hash
+      [id, created, sku, price, catalogid, version, attributes, product].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/change_loyalty_tier_level_effect_props.rb

@@ -0,0 +1,278 @@
+=begin
+#Talon.One API
+
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  # The properties specific to the \"changeLoyaltyTierLevel\" effect. This is triggered whenever the user's loyalty tier is upgraded due to a validated rule that contained an \"addLoyaltyPoints\" effect. 
+  class ChangeLoyaltyTierLevelEffectProps
+    # The title of the rule that triggered the tier upgrade.
+    attr_accessor :rule_title
+
+    # The ID of the loyalty program where these points were added.
+    attr_accessor :program_id
+
+    # The ID of the subledger within the loyalty program where these points were added.
+    attr_accessor :sub_ledger_id
+
+    # The name of the tier from which the user was upgraded.
+    attr_accessor :previous_tier_name
+
+    # The name of the tier to which the user has been upgraded.
+    attr_accessor :new_tier_name
+
+    # The expiration date of the new tier.
+    attr_accessor :expiry_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rule_title' => :'ruleTitle',
+        :'program_id' => :'programId',
+        :'sub_ledger_id' => :'subLedgerId',
+        :'previous_tier_name' => :'previousTierName',
+        :'new_tier_name' => :'newTierName',
+        :'expiry_date' => :'expiryDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'rule_title' => :'String',
+        :'program_id' => :'Integer',
+        :'sub_ledger_id' => :'String',
+        :'previous_tier_name' => :'String',
+        :'new_tier_name' => :'String',
+        :'expiry_date' => :'DateTime'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::ChangeLoyaltyTierLevelEffectProps` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::ChangeLoyaltyTierLevelEffectProps`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'rule_title')
+        self.rule_title = attributes[:'rule_title']
+      end
+
+      if attributes.key?(:'program_id')
+        self.program_id = attributes[:'program_id']
+      end
+
+      if attributes.key?(:'sub_ledger_id')
+        self.sub_ledger_id = attributes[:'sub_ledger_id']
+      end
+
+      if attributes.key?(:'previous_tier_name')
+        self.previous_tier_name = attributes[:'previous_tier_name']
+      end
+
+      if attributes.key?(:'new_tier_name')
+        self.new_tier_name = attributes[:'new_tier_name']
+      end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      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
+      invalid_properties = Array.new
+      if @rule_title.nil?
+        invalid_properties.push('invalid value for "rule_title", rule_title cannot be nil.')
+      end
+
+      if @program_id.nil?
+        invalid_properties.push('invalid value for "program_id", program_id cannot be nil.')
+      end
+
+      if @sub_ledger_id.nil?
+        invalid_properties.push('invalid value for "sub_ledger_id", sub_ledger_id cannot be nil.')
+      end
+
+      if @new_tier_name.nil?
+        invalid_properties.push('invalid value for "new_tier_name", new_tier_name cannot be nil.')
+      end
+
+      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?
+      return false if @rule_title.nil?
+      return false if @program_id.nil?
+      return false if @sub_ledger_id.nil?
+      return false if @new_tier_name.nil?
+      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 &&
+          rule_title == o.rule_title &&
+          program_id == o.program_id &&
+          sub_ledger_id == o.sub_ledger_id &&
+          previous_tier_name == o.previous_tier_name &&
+          new_tier_name == o.new_tier_name &&
+          expiry_date == o.expiry_date
+    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
+      [rule_title, program_id, sub_ledger_id, previous_tier_name, new_tier_name, expiry_date].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        TalonOne.const_get(type).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/talon_one/models/coupon.rb

@@ -78,6 +78,9 @@ module TalonOne
     # Whether the reservation effect actually created a new reservation.
     attr_accessor :is_reservation_mandatory
 
+    # An indication of whether the coupon is implicitly reserved for all customers.
+    attr_accessor :implicitly_reserved
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -101,7 +104,8 @@ module TalonOne
         :'import_id' => :'importId',
         :'reservation' => :'reservation',
         :'batch_id' => :'batchId',
-        :'is_reservation_mandatory' => :'isReservationMandatory'
+        :'is_reservation_mandatory' => :'isReservationMandatory',
+        :'implicitly_reserved' => :'implicitlyReserved'
       }
     end
 
@@ -128,7 +132,8 @@ module TalonOne
         :'import_id' => :'Integer',
         :'reservation' => :'Boolean',
         :'batch_id' => :'String',
-        :'is_reservation_mandatory' => :'Boolean'
+        :'is_reservation_mandatory' => :'Boolean',
+        :'implicitly_reserved' => :'Boolean'
       }
     end
 
@@ -240,7 +245,11 @@ module TalonOne
       if attributes.key?(:'is_reservation_mandatory')
         self.is_reservation_mandatory = attributes[:'is_reservation_mandatory']
       else
-        self.is_reservation_mandatory = true
+        self.is_reservation_mandatory = false
+      end
+
+      if attributes.key?(:'implicitly_reserved')
+        self.implicitly_reserved = attributes[:'implicitly_reserved']
       end
     end
 
@@ -422,7 +431,8 @@ module TalonOne
           import_id == o.import_id &&
           reservation == o.reservation &&
           batch_id == o.batch_id &&
-          is_reservation_mandatory == o.is_reservation_mandatory
+          is_reservation_mandatory == o.is_reservation_mandatory &&
+          implicitly_reserved == o.implicitly_reserved
     end
 
     # @see the `==` method
@@ -434,7 +444,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, campaign_id, value, usage_limit, discount_limit, reservation_limit, start_date, expiry_date, limits, usage_counter, discount_counter, discount_remainder, reservation_counter, attributes, referral_id, recipient_integration_id, import_id, reservation, batch_id, is_reservation_mandatory].hash
+      [id, created, campaign_id, value, usage_limit, discount_limit, reservation_limit, start_date, expiry_date, limits, usage_counter, discount_counter, discount_remainder, reservation_counter, attributes, referral_id, recipient_integration_id, import_id, reservation, batch_id, is_reservation_mandatory, implicitly_reserved].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/coupon_creation_job.rb

@@ -56,7 +56,7 @@ module TalonOne
     # The batch ID coupons created by this job will bear.
     attr_accessor :batch_id
 
-    # The current status of this request. Possible values: - `pending` - `completed` - `failed` - `coupon pattern full` 
+    # The current status of this request. Possible values: - `pending verification` - `pending` - `completed` - `failed` - `coupon pattern full` 
     attr_accessor :status
 
     # The number of coupon codes that were already created for this request.

data/lib/talon_one/models/coupons_notification_policy.rb

@@ -19,6 +19,9 @@ module TalonOne
 
     attr_accessor :scopes
 
+    # Indicates whether batching is activated.
+    attr_accessor :batching_enabled
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -45,7 +48,8 @@ module TalonOne
     def self.attribute_map
       {
         :'name' => :'name',
-        :'scopes' => :'scopes'
+        :'scopes' => :'scopes',
+        :'batching_enabled' => :'batchingEnabled'
       }
     end
 
@@ -53,7 +57,8 @@ module TalonOne
     def self.openapi_types
       {
         :'name' => :'String',
-        :'scopes' => :'Array<String>'
+        :'scopes' => :'Array<String>',
+        :'batching_enabled' => :'Boolean'
       }
     end
 
@@ -87,6 +92,12 @@ module TalonOne
           self.scopes = value
         end
       end
+
+      if attributes.key?(:'batching_enabled')
+        self.batching_enabled = attributes[:'batching_enabled']
+      else
+        self.batching_enabled = true
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -137,7 +148,8 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          scopes == o.scopes
+          scopes == o.scopes &&
+          batching_enabled == o.batching_enabled
     end
 
     # @see the `==` method
@@ -149,7 +161,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, scopes].hash
+      [name, scopes, batching_enabled].hash
     end
 
     # Builds the object from hash