talon_one 12.0.0 → 14.0.0

data/lib/talon_one/models/selector_value_map_ref.rb

@@ -0,0 +1,213 @@
+=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) 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#tag/Customer-sessions/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
+  # A reference to a value map by its internal ID.
+  class SelectorValueMapRef
+    # The internal ID of the referenced value map.
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer'
+      }
+    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::SelectorValueMapRef` 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::SelectorValueMapRef`. 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?(:'id')
+        self.id = attributes[:'id']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id 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 @id.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 &&
+          id == o.id
+    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
+      [id].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/set_discount_effect_props.rb

@@ -13,18 +13,18 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # The properties specific to the \"setDiscount\" effect. This gets triggered whenever a validated rule contained a \"set discount\" effect. This is a discount that should be applied on the scope of defined with it.
+  # This effect indicates that a discount should be set on the total shopping cart value of the current order with the given label and amount.  The discount should overwrite any existing discount with the same name. The most recent integration state update always returns the latest values for **all** effects, effectively overwriting any previous effects.  Enabling [partial discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches `0`. Use the `desiredValue` property to identify the original value of the discount.
   class SetDiscountEffectProps
-    # The name / description of this discount
+    # The name or description of this discount.
     attr_accessor :name
 
-    # The total monetary value of the discount.
+    # The monetary value of the effective discount.
     attr_accessor :value
 
-    # The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal).
+    # What the discount applies to. Possible values:  - `cartItems`: Discount on the price of the items. - `additionalCosts`: Discount on the [additional costs](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the items. - `sessionTotal`: Discount on the total value of the customer session.  **Note:** [Cascading discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#cascading-discounts) must be enabled for this property to be returned.
     attr_accessor :scope
 
-    # The original value of the discount.
+    # _(Partial discounts enabled only)_ The monetary value of the discount to be applied without considering budget limitations.
     attr_accessor :desired_value
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb

@@ -13,21 +13,21 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # The properties specific to the \"setDiscountPerAdditionalCost\" effect. This gets triggered whenever a validated rule contained a \"set per additional cost discount\" effect. This is a discount that should be applied on a specific additional cost.
+  # This effect indicates that a discount that should be applied on a specific additional cost. It is triggered whenever a rule containing a **Discount additional cost** effect is validated.  Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points.
   class SetDiscountPerAdditionalCostEffectProps
-    # The name / description of this discount
+    # The name of the discount.
     attr_accessor :name
 
-    # The ID of the additional cost.
+    # The identifier of the additional cost.
     attr_accessor :additional_cost_id
 
-    # The name of the additional cost.
+    # The API name of the additional cost.
     attr_accessor :additional_cost
 
-    # The total monetary value of the discount.
+    # The monetary value of the discount to apply.
     attr_accessor :value
 
-    # The original value of the discount.
+    # _(Partial discounts enabled only)_ The monetary value of the discount to be applied without considering budget limitations.
     attr_accessor :desired_value
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb

@@ -13,27 +13,27 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # The properties specific to the \"setDiscountPerAdditionalCostPerItem\" effect. This gets triggered whenever a validated rule contained a \"set discount per additional cost per item\" effect. This is a discount that should be applied on a specific additional cost in a specific item.
+  # This effect indicates that a discount of a specific additional cost within a specific item should be applied. It gets triggered whenever a rule containing a **Discount additional cost per item** effect is validated.  Use this effect when **all** items in the cart have an additional cost. If one of more items do not have an additional cost, the rule will fail.
   class SetDiscountPerAdditionalCostPerItemEffectProps
-    # The name / description of this discount
+    # The description of this discount. `#number` is appended to the name. It is equal to the `position` property.
     attr_accessor :name
 
-    # The ID of the additional cost.
+    # The identifier of the additional cost to be discounted.
     attr_accessor :additional_cost_id
 
-    # The total monetary value of the discount.
+    # The monetary value of the effective discount applied to the item's additional cost.
     attr_accessor :value
 
-    # The index of the item in the cart item list containing the additional cost to be discounted.
+    # The index of the item in the `cartItem` object containing the additional cost that this discount applies to.
     attr_accessor :position
 
-    # For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. 
+    # The index of the item unit in its line item.
     attr_accessor :sub_position
 
-    # The name of the additional cost.
+    # The API name of the additional cost to be discounted.
     attr_accessor :additional_cost
 
-    # Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). Represents the monetary value of the discount to be applied to additional discount without considering budget limitations. 
+    # _[(Partial discounts enabled only)](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts)_. The monetary value of the discount to be applied to the additional cost without considering budget limitations.
     attr_accessor :desired_value
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/set_discount_per_item_effect_props.rb

@@ -13,42 +13,42 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # The properties specific to the `setDiscountPerItem` effect, triggered whenever a validated rule contained a \"set per item discount\" effect. This is a discount that will be applied either on a specific item, on a specific item + additional cost or on all additional costs per item. This depends on the chosen scope. 
+  # This effect schema is returned when you use the **Discount individual items**, **Discount individual items pro rata**, or **Discount individual item in bundles** effect in a rule.  It indicates that a discount per item should be applied on the specific item specified in the effect.  The properties it contains depends on:  - Whether you used a pro rata effect or not. - Whether you used an effect with bundles or not. - Whether the partial discount feature is enabled.
   class SetDiscountPerItemEffectProps
-    # The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the `position` property. 
+    # The description of this discount. `#number` is equal to the `position` property.
     attr_accessor :name
 
-    # The total monetary value of the discount.
+    # The monetary value of the effective discount applied to the item.
     attr_accessor :value
 
-    # The index of the item in the cart items list on which this discount should be applied.
+    # The index of the item in the `cartItem` object on which this discount should be applied.
     attr_accessor :position
 
-    # For cart items with `quantity` > 1, the sub position indicates which item the discount applies to. 
+    # The index of the item unit in its line item.
     attr_accessor :sub_position
 
-    # The original value of the discount.
+    # _(Partial discounts enabled only)_ The monetary value of the discount to be applied to the item without considering budget limitations.
     attr_accessor :desired_value
 
-    # The scope of the discount: - `additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item. 
+    # What the discount applies to. Possible values:  - `price`: discount on the price of the item. - `additionalCosts`: discount on the [additional cost](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the item. - `itemTotal`: discount on the sum of price + additional cost of the item.
     attr_accessor :scope
 
-    # The total discount given if this effect is a result of a prorated discount.
+    # _(Pro rata discounts only)_ The monetary value of the total effective discount
     attr_accessor :total_discount
 
-    # The original total discount to give if this effect is a result of a prorated discount.
+    # _(Pro rata discounts only)_ The monetary value of the total discount to be applied without considering budget limitations
     attr_accessor :desired_total_discount
 
-    # The position of the bundle in a list of item bundles created from the same bundle definition.
+    # _(Discounts with bundles only)_ The position of the specific item bundle in the list of bundles created from the same bundle definition.
     attr_accessor :bundle_index
 
-    # The name of the bundle definition.
+    # _(Discounts with bundles only)_ The name of the bundle definition.
     attr_accessor :bundle_name
 
-    # The index of the targeted bundle item on which the applied discount is based.
+    # _(Discounting individual item in bundles only)_ The index of the targeted bundle item on which the applied discount is based.
     attr_accessor :targeted_item_position
 
-    # The sub-position of the targeted bundle item on which the applied discount is based. 
+    # _(Discounting individual item in bundles only)_ The sub-position of the targeted bundle item on which the applied discount is based.
     attr_accessor :targeted_item_sub_position
 
     # When set to `true`, the applied discount is excluded from the item's price history.

data/lib/talon_one/models/set_loyalty_points_expiry_date_effect_props.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # The properties specific to the \"setLoyaltyPointsExpiryDate\" effect. This gets triggered when a validated rule contains the \"set expiry date\" effect. The current expiry date gets set to the date given in the effect. 
+  # This effect updates the expiry date of all active, pending, and unlimited point transactions to a specific date. 
   class SetLoyaltyPointsExpiryDateEffectProps
     # ID of the loyalty program that contains these points.
     attr_accessor :program_id

data/lib/talon_one/models/show_bundle_metadata_effect_props.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # This effect is **deprecated**. The properties specific to the \"ShowBundleMetadata\" effect. This effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from \"normal\" discounts that were not the result of a product bundle. 
+  # This effect is **deprecated**.  The `ShowBundleMetadata` effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from \"normal\" discounts that were not the result of a product bundle.
   class ShowBundleMetadataEffectProps
     # Description of the product bundle.
     attr_accessor :description