talon_one 3.0.2 → 4.0.0

data/lib/talon_one/models/campaign_set_branch_node.rb

@@ -17,15 +17,30 @@ module TalonOne
     # Indicates the node type.
     attr_accessor :type
 
-    # Name of the set
+    # Name of the set.
     attr_accessor :name
 
-    # How does the set operates on its elements.
+    # An indicator of how the set operates on its elements.
     attr_accessor :operator
 
     # Child elements of this set.
     attr_accessor :elements
 
+    # The ID of the campaign set.
+    attr_accessor :group_id
+
+    # An indicator of whether the campaign set is locked for modification.
+    attr_accessor :locked
+
+    # A description of the campaign set.
+    attr_accessor :description
+
+    # The mode by which campaigns in the campaign evaluation group are evaluated.
+    attr_accessor :evaluation_mode
+
+    # The evaluation scope of the campaign evaluation group.
+    attr_accessor :evaluation_scope
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -54,7 +69,12 @@ module TalonOne
         :'type' => :'type',
         :'name' => :'name',
         :'operator' => :'operator',
-        :'elements' => :'elements'
+        :'elements' => :'elements',
+        :'group_id' => :'groupId',
+        :'locked' => :'locked',
+        :'description' => :'description',
+        :'evaluation_mode' => :'evaluationMode',
+        :'evaluation_scope' => :'evaluationScope'
       }
     end
 
@@ -64,7 +84,12 @@ module TalonOne
         :'type' => :'String',
         :'name' => :'String',
         :'operator' => :'String',
-        :'elements' => :'Array<CampaignSetNode>'
+        :'elements' => :'Array<CampaignSetNode>',
+        :'group_id' => :'Integer',
+        :'locked' => :'Boolean',
+        :'description' => :'String',
+        :'evaluation_mode' => :'String',
+        :'evaluation_scope' => :'String'
       }
     end
 
@@ -106,6 +131,26 @@ module TalonOne
           self.elements = value
         end
       end
+
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'locked')
+        self.locked = attributes[:'locked']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'evaluation_mode')
+        self.evaluation_mode = attributes[:'evaluation_mode']
+      end
+
+      if attributes.key?(:'evaluation_scope')
+        self.evaluation_scope = attributes[:'evaluation_scope']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -128,6 +173,22 @@ module TalonOne
         invalid_properties.push('invalid value for "elements", elements cannot be nil.')
       end
 
+      if @group_id.nil?
+        invalid_properties.push('invalid value for "group_id", group_id cannot be nil.')
+      end
+
+      if @locked.nil?
+        invalid_properties.push('invalid value for "locked", locked cannot be nil.')
+      end
+
+      if @evaluation_mode.nil?
+        invalid_properties.push('invalid value for "evaluation_mode", evaluation_mode cannot be nil.')
+      end
+
+      if @evaluation_scope.nil?
+        invalid_properties.push('invalid value for "evaluation_scope", evaluation_scope cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -142,6 +203,14 @@ module TalonOne
       operator_validator = EnumAttributeValidator.new('String', ["ALL", "FIRST"])
       return false unless operator_validator.valid?(@operator)
       return false if @elements.nil?
+      return false if @group_id.nil?
+      return false if @locked.nil?
+      return false if @evaluation_mode.nil?
+      evaluation_mode_validator = EnumAttributeValidator.new('String', ["stackable", "listOrder", "lowestDiscount", "highestDiscount"])
+      return false unless evaluation_mode_validator.valid?(@evaluation_mode)
+      return false if @evaluation_scope.nil?
+      evaluation_scope_validator = EnumAttributeValidator.new('String', ["cartItem", "session"])
+      return false unless evaluation_scope_validator.valid?(@evaluation_scope)
       true
     end
 
@@ -165,6 +234,26 @@ module TalonOne
       @operator = operator
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] evaluation_mode Object to be assigned
+    def evaluation_mode=(evaluation_mode)
+      validator = EnumAttributeValidator.new('String', ["stackable", "listOrder", "lowestDiscount", "highestDiscount"])
+      unless validator.valid?(evaluation_mode)
+        fail ArgumentError, "invalid value for \"evaluation_mode\", must be one of #{validator.allowable_values}."
+      end
+      @evaluation_mode = evaluation_mode
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] evaluation_scope Object to be assigned
+    def evaluation_scope=(evaluation_scope)
+      validator = EnumAttributeValidator.new('String', ["cartItem", "session"])
+      unless validator.valid?(evaluation_scope)
+        fail ArgumentError, "invalid value for \"evaluation_scope\", must be one of #{validator.allowable_values}."
+      end
+      @evaluation_scope = evaluation_scope
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -173,7 +262,12 @@ module TalonOne
           type == o.type &&
           name == o.name &&
           operator == o.operator &&
-          elements == o.elements
+          elements == o.elements &&
+          group_id == o.group_id &&
+          locked == o.locked &&
+          description == o.description &&
+          evaluation_mode == o.evaluation_mode &&
+          evaluation_scope == o.evaluation_scope
     end
 
     # @see the `==` method
@@ -185,7 +279,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, name, operator, elements].hash
+      [type, name, operator, elements, group_id, locked, description, evaluation_mode, evaluation_scope].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/campaign_template.rb

@@ -73,6 +73,9 @@ module TalonOne
     # The default campaign group ID.
     attr_accessor :default_campaign_group_id
 
+    # The campaign type. Possible type values:   - `cartItem`: Type of campaign that can apply effects only to cart items.   - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. 
+    attr_accessor :campaign_type
+
     # Timestamp of the most recent update to the campaign template or any of its elements.
     attr_accessor :updated
 
@@ -127,6 +130,7 @@ module TalonOne
         :'applications_ids' => :'applicationsIds',
         :'campaign_collections' => :'campaignCollections',
         :'default_campaign_group_id' => :'defaultCampaignGroupId',
+        :'campaign_type' => :'campaignType',
         :'updated' => :'updated',
         :'updated_by' => :'updatedBy',
         :'valid_application_ids' => :'validApplicationIds'
@@ -156,6 +160,7 @@ module TalonOne
         :'applications_ids' => :'Array<Integer>',
         :'campaign_collections' => :'Array<CampaignTemplateCollection>',
         :'default_campaign_group_id' => :'Integer',
+        :'campaign_type' => :'String',
         :'updated' => :'DateTime',
         :'updated_by' => :'String',
         :'valid_application_ids' => :'Array<Integer>'
@@ -275,6 +280,12 @@ module TalonOne
         self.default_campaign_group_id = attributes[:'default_campaign_group_id']
       end
 
+      if attributes.key?(:'campaign_type')
+        self.campaign_type = attributes[:'campaign_type']
+      else
+        self.campaign_type = 'advanced'
+      end
+
       if attributes.key?(:'updated')
         self.updated = attributes[:'updated']
       end
@@ -334,6 +345,10 @@ module TalonOne
         invalid_properties.push('invalid value for "applications_ids", applications_ids cannot be nil.')
       end
 
+      if @campaign_type.nil?
+        invalid_properties.push('invalid value for "campaign_type", campaign_type cannot be nil.')
+      end
+
       if @valid_application_ids.nil?
         invalid_properties.push('invalid value for "valid_application_ids", valid_application_ids cannot be nil.')
       end
@@ -356,6 +371,9 @@ module TalonOne
       state_validator = EnumAttributeValidator.new('String', ["draft", "enabled", "disabled"])
       return false unless state_validator.valid?(@state)
       return false if @applications_ids.nil?
+      return false if @campaign_type.nil?
+      campaign_type_validator = EnumAttributeValidator.new('String', ["cartItem", "advanced"])
+      return false unless campaign_type_validator.valid?(@campaign_type)
       return false if @valid_application_ids.nil?
       true
     end
@@ -384,6 +402,16 @@ module TalonOne
       @state = state
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] campaign_type Object to be assigned
+    def campaign_type=(campaign_type)
+      validator = EnumAttributeValidator.new('String', ["cartItem", "advanced"])
+      unless validator.valid?(campaign_type)
+        fail ArgumentError, "invalid value for \"campaign_type\", must be one of #{validator.allowable_values}."
+      end
+      @campaign_type = campaign_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -409,6 +437,7 @@ module TalonOne
           applications_ids == o.applications_ids &&
           campaign_collections == o.campaign_collections &&
           default_campaign_group_id == o.default_campaign_group_id &&
+          campaign_type == o.campaign_type &&
           updated == o.updated &&
           updated_by == o.updated_by &&
           valid_application_ids == o.valid_application_ids
@@ -423,7 +452,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, account_id, user_id, name, description, instructions, campaign_attributes, coupon_attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits, template_params, applications_ids, campaign_collections, default_campaign_group_id, updated, updated_by, valid_application_ids].hash
+      [id, created, account_id, user_id, name, description, instructions, campaign_attributes, coupon_attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits, template_params, applications_ids, campaign_collections, default_campaign_group_id, campaign_type, updated, updated_by, valid_application_ids].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/card_expiring_points_notification_policy.rb

@@ -0,0 +1,259 @@
+=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 CardExpiringPointsNotificationPolicy
+    # Notification name.
+    attr_accessor :name
+
+    attr_accessor :triggers
+
+    # Indicates whether batching is activated.
+    attr_accessor :batching_enabled
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'triggers' => :'triggers',
+        :'batching_enabled' => :'batchingEnabled'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'triggers' => :'Array<CardExpiringPointsNotificationTrigger>',
+        :'batching_enabled' => :'Boolean'
+      }
+    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::CardExpiringPointsNotificationPolicy` 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::CardExpiringPointsNotificationPolicy`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'triggers')
+        if (value = attributes[:'triggers']).is_a?(Array)
+          self.triggers = 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?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if @triggers.nil?
+        invalid_properties.push('invalid value for "triggers", triggers 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 @name.nil?
+      return false if @name.to_s.length < 1
+      return false if @triggers.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    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 &&
+          name == o.name &&
+          triggers == o.triggers &&
+          batching_enabled == o.batching_enabled
+    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
+      [name, triggers, batching_enabled].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