talon_one 9.0.0 → 11.0.0

data/lib/talon_one/models/best_prior_price_request.rb

@@ -0,0 +1,268 @@
+=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 BestPriorPriceRequest
+    # List of product SKUs to check when determining the best prior price.
+    attr_accessor :skus
+
+    # The end date and time that defines the latest time for retrieving historical SKU prices.
+    attr_accessor :timeframe_end_date
+
+    # The number of days prior to the timeframeEndDate. Only prices within this look back period are considered for the best prior price evaluation.
+    attr_accessor :timeframe
+
+    # Indicates whether the timeframe includes the start of the current sale. - When `false`, the timeframe includes the start date of the current sale. - When `true`, the timeframe striclty uses the number of days specified in `timeframe`. 
+    attr_accessor :strict_end_date
+
+    attr_accessor :target
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'skus' => :'skus',
+        :'timeframe_end_date' => :'timeframeEndDate',
+        :'timeframe' => :'timeframe',
+        :'strict_end_date' => :'strictEndDate',
+        :'target' => :'target'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'skus' => :'Array<String>',
+        :'timeframe_end_date' => :'DateTime',
+        :'timeframe' => :'Integer',
+        :'strict_end_date' => :'Boolean',
+        :'target' => :'BestPriorPriceRequestTarget'
+      }
+    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::BestPriorPriceRequest` 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::BestPriorPriceRequest`. 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?(:'skus')
+        if (value = attributes[:'skus']).is_a?(Array)
+          self.skus = value
+        end
+      end
+
+      if attributes.key?(:'timeframe_end_date')
+        self.timeframe_end_date = attributes[:'timeframe_end_date']
+      end
+
+      if attributes.key?(:'timeframe')
+        self.timeframe = attributes[:'timeframe']
+      end
+
+      if attributes.key?(:'strict_end_date')
+        self.strict_end_date = attributes[:'strict_end_date']
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      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 @skus.nil?
+        invalid_properties.push('invalid value for "skus", skus cannot be nil.')
+      end
+
+      if @timeframe_end_date.nil?
+        invalid_properties.push('invalid value for "timeframe_end_date", timeframe_end_date cannot be nil.')
+      end
+
+      if @timeframe.nil?
+        invalid_properties.push('invalid value for "timeframe", timeframe cannot be nil.')
+      end
+
+      if @strict_end_date.nil?
+        invalid_properties.push('invalid value for "strict_end_date", strict_end_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 @skus.nil?
+      return false if @timeframe_end_date.nil?
+      return false if @timeframe.nil?
+      return false if @strict_end_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 &&
+          skus == o.skus &&
+          timeframe_end_date == o.timeframe_end_date &&
+          timeframe == o.timeframe &&
+          strict_end_date == o.strict_end_date &&
+          target == o.target
+    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
+      [skus, timeframe_end_date, timeframe, strict_end_date, target].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/best_prior_price_request_target.rb

@@ -0,0 +1,257 @@
+=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
+  # Specifies the target for which the best prior price calculation is taken into consideration.
+  class BestPriorPriceRequestTarget
+    # The type of price target.
+    attr_accessor :target_type
+
+    # The AudienceID of an audience. Must be used with \"AUDIENCE\" target type.
+    attr_accessor :audience_id
+
+    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
+      {
+        :'target_type' => :'targetType',
+        :'audience_id' => :'audienceID'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'target_type' => :'String',
+        :'audience_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::BestPriorPriceRequestTarget` 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::BestPriorPriceRequestTarget`. 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?(:'target_type')
+        self.target_type = attributes[:'target_type']
+      end
+
+      if attributes.key?(:'audience_id')
+        self.audience_id = attributes[:'audience_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 @target_type.nil?
+        invalid_properties.push('invalid value for "target_type", target_type 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 @target_type.nil?
+      target_type_validator = EnumAttributeValidator.new('String', ["NONE", "AUDIENCE"])
+      return false unless target_type_validator.valid?(@target_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] target_type Object to be assigned
+    def target_type=(target_type)
+      validator = EnumAttributeValidator.new('String', ["NONE", "AUDIENCE"])
+      unless validator.valid?(target_type)
+        fail ArgumentError, "invalid value for \"target_type\", must be one of #{validator.allowable_values}."
+      end
+      @target_type = target_type
+    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 &&
+          target_type == o.target_type &&
+          audience_id == o.audience_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
+      [target_type, audience_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/binding.rb

@@ -26,13 +26,29 @@ module TalonOne
     # Can be one of the following: - `string` - `number` - `boolean` 
     attr_accessor :value_type
 
+    # The minimum value allowed for this placeholder.
+    attr_accessor :min_value
+
+    # The maximum value allowed for this placeholder.
+    attr_accessor :max_value
+
+    # Id of the attribute attached to the placeholder.
+    attr_accessor :attribute_id
+
+    # Describes the placeholder field and value in the template. This description can be used when creating campaigns from this template.
+    attr_accessor :description
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'type' => :'type',
         :'expression' => :'expression',
-        :'value_type' => :'valueType'
+        :'value_type' => :'valueType',
+        :'min_value' => :'minValue',
+        :'max_value' => :'maxValue',
+        :'attribute_id' => :'attributeId',
+        :'description' => :'description'
       }
     end
 
@@ -42,7 +58,11 @@ module TalonOne
         :'name' => :'String',
         :'type' => :'String',
         :'expression' => :'Array<Object>',
-        :'value_type' => :'String'
+        :'value_type' => :'String',
+        :'min_value' => :'Float',
+        :'max_value' => :'Float',
+        :'attribute_id' => :'Integer',
+        :'description' => :'String'
       }
     end
 
@@ -84,6 +104,22 @@ module TalonOne
       if attributes.key?(:'value_type')
         self.value_type = attributes[:'value_type']
       end
+
+      if attributes.key?(:'min_value')
+        self.min_value = attributes[:'min_value']
+      end
+
+      if attributes.key?(:'max_value')
+        self.max_value = attributes[:'max_value']
+      end
+
+      if attributes.key?(:'attribute_id')
+        self.attribute_id = attributes[:'attribute_id']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,7 +153,11 @@ module TalonOne
           name == o.name &&
           type == o.type &&
           expression == o.expression &&
-          value_type == o.value_type
+          value_type == o.value_type &&
+          min_value == o.min_value &&
+          max_value == o.max_value &&
+          attribute_id == o.attribute_id &&
+          description == o.description
     end
 
     # @see the `==` method
@@ -129,7 +169,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, type, expression, value_type].hash
+      [name, type, expression, value_type, min_value, max_value, attribute_id, description].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/campaign_collection.rb

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