talon_one 9.0.0 → 11.0.0

data/lib/talon_one/models/effect_entity.rb

@@ -51,6 +51,15 @@ module TalonOne
     # The revision version ID of the campaign that was used when triggering the effect.
     attr_accessor :campaign_revision_version_id
 
+    # The selected price type for the SKU targeted by this effect.
+    attr_accessor :selected_price_type
+
+    # The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied.
+    attr_accessor :selected_price
+
+    # The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment.
+    attr_accessor :adjustment_reference_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -65,7 +74,10 @@ module TalonOne
         :'evaluation_group_id' => :'evaluationGroupID',
         :'evaluation_group_mode' => :'evaluationGroupMode',
         :'campaign_revision_id' => :'campaignRevisionId',
-        :'campaign_revision_version_id' => :'campaignRevisionVersionId'
+        :'campaign_revision_version_id' => :'campaignRevisionVersionId',
+        :'selected_price_type' => :'selectedPriceType',
+        :'selected_price' => :'selectedPrice',
+        :'adjustment_reference_id' => :'adjustmentReferenceId'
       }
     end
 
@@ -83,7 +95,10 @@ module TalonOne
         :'evaluation_group_id' => :'Integer',
         :'evaluation_group_mode' => :'String',
         :'campaign_revision_id' => :'Integer',
-        :'campaign_revision_version_id' => :'Integer'
+        :'campaign_revision_version_id' => :'Integer',
+        :'selected_price_type' => :'String',
+        :'selected_price' => :'Float',
+        :'adjustment_reference_id' => :'String'
       }
     end
 
@@ -155,6 +170,18 @@ module TalonOne
       if attributes.key?(:'campaign_revision_version_id')
         self.campaign_revision_version_id = attributes[:'campaign_revision_version_id']
       end
+
+      if attributes.key?(:'selected_price_type')
+        self.selected_price_type = attributes[:'selected_price_type']
+      end
+
+      if attributes.key?(:'selected_price')
+        self.selected_price = attributes[:'selected_price']
+      end
+
+      if attributes.key?(:'adjustment_reference_id')
+        self.adjustment_reference_id = attributes[:'adjustment_reference_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -211,7 +238,10 @@ module TalonOne
           evaluation_group_id == o.evaluation_group_id &&
           evaluation_group_mode == o.evaluation_group_mode &&
           campaign_revision_id == o.campaign_revision_id &&
-          campaign_revision_version_id == o.campaign_revision_version_id
+          campaign_revision_version_id == o.campaign_revision_version_id &&
+          selected_price_type == o.selected_price_type &&
+          selected_price == o.selected_price &&
+          adjustment_reference_id == o.adjustment_reference_id
     end
 
     # @see the `==` method
@@ -223,7 +253,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item, condition_index, evaluation_group_id, evaluation_group_mode, campaign_revision_id, campaign_revision_version_id].hash
+      [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item, condition_index, evaluation_group_id, evaluation_group_mode, campaign_revision_id, campaign_revision_version_id, selected_price_type, selected_price, adjustment_reference_id].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/entity.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Entity
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/environment.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Environment
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.
@@ -59,6 +59,9 @@ module TalonOne
     # The cart item filters belonging to the Application.
     attr_accessor :application_cart_item_filters
 
+    # The price types that this Application can use.
+    attr_accessor :price_types
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -76,7 +79,8 @@ module TalonOne
         :'additional_costs' => :'additionalCosts',
         :'audiences' => :'audiences',
         :'collections' => :'collections',
-        :'application_cart_item_filters' => :'applicationCartItemFilters'
+        :'application_cart_item_filters' => :'applicationCartItemFilters',
+        :'price_types' => :'priceTypes'
       }
     end
 
@@ -97,7 +101,8 @@ module TalonOne
         :'additional_costs' => :'Array<AccountAdditionalCost>',
         :'audiences' => :'Array<Audience>',
         :'collections' => :'Array<Collection>',
-        :'application_cart_item_filters' => :'Array<ApplicationCIF>'
+        :'application_cart_item_filters' => :'Array<ApplicationCIF>',
+        :'price_types' => :'Array<PriceType>'
       }
     end
 
@@ -203,6 +208,12 @@ module TalonOne
           self.application_cart_item_filters = value
         end
       end
+
+      if attributes.key?(:'price_types')
+        if (value = attributes[:'price_types']).is_a?(Array)
+          self.price_types = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -272,7 +283,8 @@ module TalonOne
           additional_costs == o.additional_costs &&
           audiences == o.audiences &&
           collections == o.collections &&
-          application_cart_item_filters == o.application_cart_item_filters
+          application_cart_item_filters == o.application_cart_item_filters &&
+          price_types == o.price_types
     end
 
     # @see the `==` method
@@ -284,7 +296,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, application_id, slots, functions, templates, variables, giveaways_pools, loyalty_programs, achievements, attributes, additional_costs, audiences, collections, application_cart_item_filters].hash
+      [id, created, application_id, slots, functions, templates, variables, giveaways_pools, loyalty_programs, achievements, attributes, additional_costs, audiences, collections, application_cart_item_filters, price_types].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/event.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Event
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/event_type.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class EventType
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/expiring_card_points_data.rb

@@ -0,0 +1,342 @@
+=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
+  class ExpiringCardPointsData
+    # The expiration date of loyalty points.
+    attr_accessor :expiry_date
+
+    # The ID of the loyalty program.
+    attr_accessor :loyalty_program_id
+
+    # The amount of loyalty points that will be expired soon.
+    attr_accessor :amount_of_expiring_points
+
+    # The ID of the subledger within the loyalty program where these points were added.
+    attr_accessor :subledger_id
+
+    # The alphanumeric identifier of the loyalty card.
+    attr_accessor :card_identifier
+
+    # The maximum number of customer profiles with which a card can be shared. This can be set to `0` for no limit. 
+    attr_accessor :users_per_card_limit
+
+    # The integration IDs of the customer profiles linked to the card.
+    attr_accessor :profiles
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expiry_date' => :'ExpiryDate',
+        :'loyalty_program_id' => :'LoyaltyProgramID',
+        :'amount_of_expiring_points' => :'AmountOfExpiringPoints',
+        :'subledger_id' => :'SubledgerID',
+        :'card_identifier' => :'CardIdentifier',
+        :'users_per_card_limit' => :'UsersPerCardLimit',
+        :'profiles' => :'Profiles'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'expiry_date' => :'Date',
+        :'loyalty_program_id' => :'Integer',
+        :'amount_of_expiring_points' => :'Float',
+        :'subledger_id' => :'String',
+        :'card_identifier' => :'String',
+        :'users_per_card_limit' => :'Integer',
+        :'profiles' => :'Array<String>'
+      }
+    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::ExpiringCardPointsData` 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::ExpiringCardPointsData`. 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?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'loyalty_program_id')
+        self.loyalty_program_id = attributes[:'loyalty_program_id']
+      end
+
+      if attributes.key?(:'amount_of_expiring_points')
+        self.amount_of_expiring_points = attributes[:'amount_of_expiring_points']
+      end
+
+      if attributes.key?(:'subledger_id')
+        self.subledger_id = attributes[:'subledger_id']
+      end
+
+      if attributes.key?(:'card_identifier')
+        self.card_identifier = attributes[:'card_identifier']
+      end
+
+      if attributes.key?(:'users_per_card_limit')
+        self.users_per_card_limit = attributes[:'users_per_card_limit']
+      end
+
+      if attributes.key?(:'profiles')
+        if (value = attributes[:'profiles']).is_a?(Array)
+          self.profiles = value
+        end
+      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 @expiry_date.nil?
+        invalid_properties.push('invalid value for "expiry_date", expiry_date cannot be nil.')
+      end
+
+      if @loyalty_program_id.nil?
+        invalid_properties.push('invalid value for "loyalty_program_id", loyalty_program_id cannot be nil.')
+      end
+
+      if @loyalty_program_id < 1
+        invalid_properties.push('invalid value for "loyalty_program_id", must be greater than or equal to 1.')
+      end
+
+      if @amount_of_expiring_points.nil?
+        invalid_properties.push('invalid value for "amount_of_expiring_points", amount_of_expiring_points cannot be nil.')
+      end
+
+      if @subledger_id.nil?
+        invalid_properties.push('invalid value for "subledger_id", subledger_id cannot be nil.')
+      end
+
+      if @card_identifier.nil?
+        invalid_properties.push('invalid value for "card_identifier", card_identifier cannot be nil.')
+      end
+
+      if @users_per_card_limit.nil?
+        invalid_properties.push('invalid value for "users_per_card_limit", users_per_card_limit cannot be nil.')
+      end
+
+      if @users_per_card_limit < 0
+        invalid_properties.push('invalid value for "users_per_card_limit", must be greater than or equal to 0.')
+      end
+
+      if @profiles.nil?
+        invalid_properties.push('invalid value for "profiles", profiles 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 @expiry_date.nil?
+      return false if @loyalty_program_id.nil?
+      return false if @loyalty_program_id < 1
+      return false if @amount_of_expiring_points.nil?
+      return false if @subledger_id.nil?
+      return false if @card_identifier.nil?
+      return false if @users_per_card_limit.nil?
+      return false if @users_per_card_limit < 0
+      return false if @profiles.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] loyalty_program_id Value to be assigned
+    def loyalty_program_id=(loyalty_program_id)
+      if loyalty_program_id.nil?
+        fail ArgumentError, 'loyalty_program_id cannot be nil'
+      end
+
+      if loyalty_program_id < 1
+        fail ArgumentError, 'invalid value for "loyalty_program_id", must be greater than or equal to 1.'
+      end
+
+      @loyalty_program_id = loyalty_program_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] users_per_card_limit Value to be assigned
+    def users_per_card_limit=(users_per_card_limit)
+      if users_per_card_limit.nil?
+        fail ArgumentError, 'users_per_card_limit cannot be nil'
+      end
+
+      if users_per_card_limit < 0
+        fail ArgumentError, 'invalid value for "users_per_card_limit", must be greater than or equal to 0.'
+      end
+
+      @users_per_card_limit = users_per_card_limit
+    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 &&
+          expiry_date == o.expiry_date &&
+          loyalty_program_id == o.loyalty_program_id &&
+          amount_of_expiring_points == o.amount_of_expiring_points &&
+          subledger_id == o.subledger_id &&
+          card_identifier == o.card_identifier &&
+          users_per_card_limit == o.users_per_card_limit &&
+          profiles == o.profiles
+    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
+      [expiry_date, loyalty_program_id, amount_of_expiring_points, subledger_id, card_identifier, users_per_card_limit, profiles].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