talon_one 3.0.1 → 4.0.0

data/lib/talon_one/models/update_application_api_key.rb

@@ -0,0 +1,212 @@
+=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 UpdateApplicationAPIKey
+    # A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. 
+    attr_accessor :time_offset
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'time_offset' => :'timeOffset'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'time_offset' => :'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::UpdateApplicationAPIKey` 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::UpdateApplicationAPIKey`. 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?(:'time_offset')
+        self.time_offset = attributes[:'time_offset']
+      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 @time_offset.nil?
+        invalid_properties.push('invalid value for "time_offset", time_offset 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 @time_offset.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 &&
+          time_offset == o.time_offset
+    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
+      [time_offset].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/update_campaign.rb

@@ -32,7 +32,7 @@ module TalonOne
     # A disabled or archived campaign is not evaluated for rules or coupons. 
     attr_accessor :state
 
-    # ID of Ruleset this campaign applies on customer session evaluation.
+    # [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. 
     attr_accessor :active_ruleset_id
 
     # A list of tags for the campaign.
@@ -48,9 +48,18 @@ module TalonOne
     # The set of limits that will operate for this campaign.
     attr_accessor :limits
 
-    # The IDs of the campaign groups that own this entity.
+    # The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. 
     attr_accessor :campaign_groups
 
+    # The ID of the campaign evaluation group the campaign belongs to.
+    attr_accessor :evaluation_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 :type
+
+    # A list of store IDs that you want to link to the campaign.  **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. 
+    attr_accessor :linked_store_ids
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -88,7 +97,10 @@ module TalonOne
         :'coupon_settings' => :'couponSettings',
         :'referral_settings' => :'referralSettings',
         :'limits' => :'limits',
-        :'campaign_groups' => :'campaignGroups'
+        :'campaign_groups' => :'campaignGroups',
+        :'evaluation_group_id' => :'evaluationGroupId',
+        :'type' => :'type',
+        :'linked_store_ids' => :'linkedStoreIds'
       }
     end
 
@@ -107,7 +119,10 @@ module TalonOne
         :'coupon_settings' => :'CodeGeneratorSettings',
         :'referral_settings' => :'CodeGeneratorSettings',
         :'limits' => :'Array<LimitConfig>',
-        :'campaign_groups' => :'Array<Integer>'
+        :'campaign_groups' => :'Array<Integer>',
+        :'evaluation_group_id' => :'Integer',
+        :'type' => :'String',
+        :'linked_store_ids' => :'Array<Integer>'
       }
     end
 
@@ -193,6 +208,22 @@ module TalonOne
           self.campaign_groups = value
         end
       end
+
+      if attributes.key?(:'evaluation_group_id')
+        self.evaluation_group_id = attributes[:'evaluation_group_id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'advanced'
+      end
+
+      if attributes.key?(:'linked_store_ids')
+        if (value = attributes[:'linked_store_ids']).is_a?(Array)
+          self.linked_store_ids = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -232,6 +263,8 @@ module TalonOne
       return false if @tags.nil?
       return false if @features.nil?
       return false if @limits.nil?
+      type_validator = EnumAttributeValidator.new('String', ["cartItem", "advanced"])
+      return false unless type_validator.valid?(@type)
       true
     end
 
@@ -259,6 +292,16 @@ module TalonOne
       @state = state
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["cartItem", "advanced"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -276,7 +319,10 @@ module TalonOne
           coupon_settings == o.coupon_settings &&
           referral_settings == o.referral_settings &&
           limits == o.limits &&
-          campaign_groups == o.campaign_groups
+          campaign_groups == o.campaign_groups &&
+          evaluation_group_id == o.evaluation_group_id &&
+          type == o.type &&
+          linked_store_ids == o.linked_store_ids
     end
 
     # @see the `==` method
@@ -288,7 +334,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, start_time, end_time, attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits, campaign_groups].hash
+      [name, description, start_time, end_time, attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits, campaign_groups, evaluation_group_id, type, linked_store_ids].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/update_campaign_evaluation_group.rb

@@ -0,0 +1,348 @@
+=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 UpdateCampaignEvaluationGroup
+    # The name of the campaign evaluation group.
+    attr_accessor :name
+
+    # The ID of the parent group that contains the campaign evaluation group.
+    attr_accessor :parent_id
+
+    # A description of the campaign evaluation group.
+    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
+
+    # An indicator of whether the campaign evaluation group is locked for modification.
+    attr_accessor :locked
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'parent_id' => :'parentId',
+        :'description' => :'description',
+        :'evaluation_mode' => :'evaluationMode',
+        :'evaluation_scope' => :'evaluationScope',
+        :'locked' => :'locked'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'parent_id' => :'Integer',
+        :'description' => :'String',
+        :'evaluation_mode' => :'String',
+        :'evaluation_scope' => :'String',
+        :'locked' => :'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::UpdateCampaignEvaluationGroup` 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::UpdateCampaignEvaluationGroup`. 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?(:'parent_id')
+        self.parent_id = attributes[:'parent_id']
+      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
+
+      if attributes.key?(:'locked')
+        self.locked = attributes[:'locked']
+      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 @parent_id.nil?
+        invalid_properties.push('invalid value for "parent_id", parent_id cannot be nil.')
+      end
+
+      if @parent_id < 1
+        invalid_properties.push('invalid value for "parent_id", must be greater than or equal to 1.')
+      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
+
+      if @locked.nil?
+        invalid_properties.push('invalid value for "locked", locked 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 @parent_id.nil?
+      return false if @parent_id < 1
+      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)
+      return false if @locked.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] parent_id Value to be assigned
+    def parent_id=(parent_id)
+      if parent_id.nil?
+        fail ArgumentError, 'parent_id cannot be nil'
+      end
+
+      if parent_id < 1
+        fail ArgumentError, 'invalid value for "parent_id", must be greater than or equal to 1.'
+      end
+
+      @parent_id = parent_id
+    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)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          parent_id == o.parent_id &&
+          description == o.description &&
+          evaluation_mode == o.evaluation_mode &&
+          evaluation_scope == o.evaluation_scope &&
+          locked == o.locked
+    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, parent_id, description, evaluation_mode, evaluation_scope, locked].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/update_campaign_group.rb

@@ -15,16 +15,16 @@ require 'date'
 module TalonOne
   # 
   class UpdateCampaignGroup
-    # The name of this campaign group.
+    # The name of the campaign access group.
     attr_accessor :name
 
-    # A longer description of the campaign group.
+    # A longer description of the campaign access group.
     attr_accessor :description
 
-    # A list of the IDs of the applications that this campaign group is enabled for.
+    # A list of IDs of the Applications that this campaign access group is enabled for.
     attr_accessor :subscribed_applications_ids
 
-    # A list of the IDs of the campaigns that this campaign group owns.
+    # A list of IDs of the campaigns that are part of the campaign access group.
     attr_accessor :campaign_ids
 
     # Attribute mapping from ruby-style variable name to JSON key.