talon_one 9.0.0 → 11.0.0

data/lib/talon_one/models/set_loyalty_points_expiry_date_effect_props.rb

@@ -0,0 +1,255 @@
+=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 \"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. 
+  class SetLoyaltyPointsExpiryDateEffectProps
+    # ID of the loyalty program that contains these points.
+    attr_accessor :program_id
+
+    # API name of the loyalty program subledger that contains these points.
+    attr_accessor :sub_ledger_id
+
+    # The specified expiry date and time for all active and pending point transactions in the loyalty program subledger.
+    attr_accessor :new_expiry_date
+
+    # List of transactions affected by the expiry date update.
+    attr_accessor :affected_transactions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'program_id' => :'programId',
+        :'sub_ledger_id' => :'subLedgerId',
+        :'new_expiry_date' => :'newExpiryDate',
+        :'affected_transactions' => :'affectedTransactions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'program_id' => :'Integer',
+        :'sub_ledger_id' => :'String',
+        :'new_expiry_date' => :'DateTime',
+        :'affected_transactions' => :'Array<LoyaltyLedgerEntryExpiryDateChange>'
+      }
+    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::SetLoyaltyPointsExpiryDateEffectProps` 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::SetLoyaltyPointsExpiryDateEffectProps`. 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?(:'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?(:'new_expiry_date')
+        self.new_expiry_date = attributes[:'new_expiry_date']
+      end
+
+      if attributes.key?(:'affected_transactions')
+        if (value = attributes[:'affected_transactions']).is_a?(Array)
+          self.affected_transactions = 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 @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_expiry_date.nil?
+        invalid_properties.push('invalid value for "new_expiry_date", new_expiry_date 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 @program_id.nil?
+      return false if @sub_ledger_id.nil?
+      return false if @new_expiry_date.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 &&
+          program_id == o.program_id &&
+          sub_ledger_id == o.sub_ledger_id &&
+          new_expiry_date == o.new_expiry_date &&
+          affected_transactions == o.affected_transactions
+    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
+      [program_id, sub_ledger_id, new_expiry_date, affected_transactions].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/store.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Store
-    # 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/strikethrough_changed_item.rb

@@ -30,6 +30,9 @@ module TalonOne
     # The price of the changed item.
     attr_accessor :price
 
+    # A map of keys and values representing the price types and related price adjustment details for this cart item.       The keys correspond to the `priceType` names. 
+    attr_accessor :prices
+
     # The evaluation time of the changed item.
     attr_accessor :evaluated_at
 
@@ -43,6 +46,7 @@ module TalonOne
         :'sku' => :'sku',
         :'version' => :'version',
         :'price' => :'price',
+        :'prices' => :'prices',
         :'evaluated_at' => :'evaluatedAt',
         :'effects' => :'effects'
       }
@@ -56,6 +60,7 @@ module TalonOne
         :'sku' => :'String',
         :'version' => :'Integer',
         :'price' => :'Float',
+        :'prices' => :'Hash<String, PriceDetail>',
         :'evaluated_at' => :'DateTime',
         :'effects' => :'Array<StrikethroughEffect>'
       }
@@ -102,6 +107,12 @@ module TalonOne
         self.price = attributes[:'price']
       end
 
+      if attributes.key?(:'prices')
+        if (value = attributes[:'prices']).is_a?(Hash)
+          self.prices = value
+        end
+      end
+
       if attributes.key?(:'evaluated_at')
         self.evaluated_at = attributes[:'evaluated_at']
       end
@@ -185,6 +196,7 @@ module TalonOne
           sku == o.sku &&
           version == o.version &&
           price == o.price &&
+          prices == o.prices &&
           evaluated_at == o.evaluated_at &&
           effects == o.effects
     end
@@ -198,7 +210,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, catalog_id, sku, version, price, evaluated_at, effects].hash
+      [id, catalog_id, sku, version, price, prices, evaluated_at, effects].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/strikethrough_effect.rb

@@ -38,6 +38,18 @@ module TalonOne
     # The end of the time frame where the effect is active in UTC.
     attr_accessor :end_time
 
+    # The selected price type for this cart item (e.g. the price for members only).
+    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 cart item.
+    attr_accessor :adjustment_reference_id
+
+    # A list of entities (e.g. audiences) targeted by this effect.
+    attr_accessor :targets
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +60,11 @@ module TalonOne
         :'type' => :'type',
         :'props' => :'props',
         :'start_time' => :'startTime',
-        :'end_time' => :'endTime'
+        :'end_time' => :'endTime',
+        :'selected_price_type' => :'selectedPriceType',
+        :'selected_price' => :'selectedPrice',
+        :'adjustment_reference_id' => :'adjustmentReferenceId',
+        :'targets' => :'targets'
       }
     end
 
@@ -62,7 +78,11 @@ module TalonOne
         :'type' => :'String',
         :'props' => :'Object',
         :'start_time' => :'DateTime',
-        :'end_time' => :'DateTime'
+        :'end_time' => :'DateTime',
+        :'selected_price_type' => :'String',
+        :'selected_price' => :'Float',
+        :'adjustment_reference_id' => :'String',
+        :'targets' => :'Array<Object>'
       }
     end
 
@@ -118,6 +138,24 @@ module TalonOne
       if attributes.key?(:'end_time')
         self.end_time = attributes[:'end_time']
       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
+
+      if attributes.key?(:'targets')
+        if (value = attributes[:'targets']).is_a?(Array)
+          self.targets = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -175,7 +213,11 @@ module TalonOne
           type == o.type &&
           props == o.props &&
           start_time == o.start_time &&
-          end_time == o.end_time
+          end_time == o.end_time &&
+          selected_price_type == o.selected_price_type &&
+          selected_price == o.selected_price &&
+          adjustment_reference_id == o.adjustment_reference_id &&
+          targets == o.targets
     end
 
     # @see the `==` method
@@ -187,7 +229,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign_id, ruleset_id, rule_index, rule_name, type, props, start_time, end_time].hash
+      [campaign_id, ruleset_id, rule_index, rule_name, type, props, start_time, end_time, selected_price_type, selected_price, adjustment_reference_id, targets].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/strikethrough_labeling_notification.rb

@@ -34,6 +34,9 @@ module TalonOne
 
     attr_accessor :changed_items
 
+    # The type of the notification
+    attr_accessor :notification_type
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -65,7 +68,8 @@ module TalonOne
         :'current_batch' => :'currentBatch',
         :'total_batches' => :'totalBatches',
         :'trigger' => :'trigger',
-        :'changed_items' => :'changedItems'
+        :'changed_items' => :'changedItems',
+        :'notification_type' => :'NotificationType'
       }
     end
 
@@ -78,7 +82,8 @@ module TalonOne
         :'current_batch' => :'Integer',
         :'total_batches' => :'Integer',
         :'trigger' => :'StrikethroughTrigger',
-        :'changed_items' => :'Array<StrikethroughChangedItem>'
+        :'changed_items' => :'Array<StrikethroughChangedItem>',
+        :'notification_type' => :'String'
       }
     end
 
@@ -132,6 +137,10 @@ module TalonOne
           self.changed_items = value
         end
       end
+
+      if attributes.key?(:'notification_type')
+        self.notification_type = attributes[:'notification_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -158,6 +167,10 @@ module TalonOne
         invalid_properties.push('invalid value for "changed_items", changed_items cannot be nil.')
       end
 
+      if @notification_type.nil?
+        invalid_properties.push('invalid value for "notification_type", notification_type cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -171,6 +184,7 @@ module TalonOne
       return false if @total_batches.nil?
       return false if @trigger.nil?
       return false if @changed_items.nil?
+      return false if @notification_type.nil?
       true
     end
 
@@ -195,7 +209,8 @@ module TalonOne
           current_batch == o.current_batch &&
           total_batches == o.total_batches &&
           trigger == o.trigger &&
-          changed_items == o.changed_items
+          changed_items == o.changed_items &&
+          notification_type == o.notification_type
     end
 
     # @see the `==` method
@@ -207,7 +222,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [version, valid_from, application_id, current_batch, total_batches, trigger, changed_items].hash
+      [version, valid_from, application_id, current_batch, total_batches, trigger, changed_items, notification_type].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/template_def.rb

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