klaviyo-api-sdk 13.0.1 → 14.0.0

data/lib/klaviyo-api-sdk/models/priority_enum.rb

@@ -0,0 +1,35 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class PriorityEnum
+    PRIORITY = "priority".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = PriorityEnum.constants.select { |c| PriorityEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #PriorityEnum" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb

@@ -0,0 +1,327 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
+    attr_accessor :type
+
+    # Possible dimension for channel affinity criterion.
+    attr_accessor :dimension
+
+    attr_accessor :measurement
+
+    # Possible channels in a channel affinity definition.
+    attr_accessor :predicted_channel
+
+    attr_accessor :filter
+
+    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
+      {
+        :'type' => :'type',
+        :'dimension' => :'dimension',
+        :'measurement' => :'measurement',
+        :'predicted_channel' => :'predicted_channel',
+        :'filter' => :'filter'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'ProfilePredictiveAnalyticsEnum',
+        :'dimension' => :'String',
+        :'measurement' => :'PriorityEnum',
+        :'predicted_channel' => :'String',
+        :'filter' => :'ProfilePredictiveAnalyticsChannelAffinityPriorityFilter'
+      }
+    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 `KlaviyoAPI::ProfilePredictiveAnalyticsChannelAffinityPriorityCondition` 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 `KlaviyoAPI::ProfilePredictiveAnalyticsChannelAffinityPriorityCondition`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'dimension')
+        self.dimension = attributes[:'dimension']
+      end
+
+      if attributes.key?(:'measurement')
+        self.measurement = attributes[:'measurement']
+      end
+
+      if attributes.key?(:'predicted_channel')
+        self.predicted_channel = attributes[:'predicted_channel']
+      end
+
+      if attributes.key?(:'filter')
+        self.filter = attributes[:'filter']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @dimension.nil?
+        invalid_properties.push('invalid value for "dimension", dimension cannot be nil.')
+      end
+
+      if @measurement.nil?
+        invalid_properties.push('invalid value for "measurement", measurement cannot be nil.')
+      end
+
+      if @predicted_channel.nil?
+        invalid_properties.push('invalid value for "predicted_channel", predicted_channel cannot be nil.')
+      end
+
+      if @filter.nil?
+        invalid_properties.push('invalid value for "filter", filter 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 @type.nil?
+      return false if @dimension.nil?
+      dimension_validator = EnumAttributeValidator.new('String', ["channel_affinity"])
+      return false unless dimension_validator.valid?(@dimension)
+      return false if @measurement.nil?
+      return false if @predicted_channel.nil?
+      predicted_channel_validator = EnumAttributeValidator.new('String', ["email", "push", "sms"])
+      return false unless predicted_channel_validator.valid?(@predicted_channel)
+      return false if @filter.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] dimension Object to be assigned
+    def dimension=(dimension)
+      validator = EnumAttributeValidator.new('String', ["channel_affinity"])
+      unless validator.valid?(dimension)
+        fail ArgumentError, "invalid value for \"dimension\", must be one of #{validator.allowable_values}."
+      end
+      @dimension = dimension
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] predicted_channel Object to be assigned
+    def predicted_channel=(predicted_channel)
+      validator = EnumAttributeValidator.new('String', ["email", "push", "sms"])
+      unless validator.valid?(predicted_channel)
+        fail ArgumentError, "invalid value for \"predicted_channel\", must be one of #{validator.allowable_values}."
+      end
+      @predicted_channel = predicted_channel
+    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 &&
+          type == o.type &&
+          dimension == o.dimension &&
+          measurement == o.measurement &&
+          predicted_channel == o.predicted_channel &&
+          filter == o.filter
+    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
+      [type, dimension, measurement, predicted_channel, filter].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = KlaviyoAPI.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/klaviyo-api-sdk/models/{custom_object_property_condition.rb → profile_predictive_analytics_channel_affinity_priority_filter.rb}

@@ -13,22 +13,19 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class CustomObjectPropertyCondition
+  class ProfilePredictiveAnalyticsChannelAffinityPriorityFilter
     attr_accessor :type
 
-    attr_accessor :custom_object_label
+    attr_accessor :operator
 
-    attr_accessor :field
-
-    attr_accessor :filter
+    attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
-        :'custom_object_label' => :'custom_object_label',
-        :'field' => :'field',
-        :'filter' => :'filter'
+        :'operator' => :'operator',
+        :'value' => :'value'
       }
     end
 
@@ -40,10 +37,9 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'CustomObjectPropertyEnum',
-        :'custom_object_label' => :'String',
-        :'field' => :'String',
-        :'filter' => :'MetricPropertyConditionFilter'
+        :'type' => :'NumericEnum',
+        :'operator' => :'EqualsEnum',
+        :'value' => :'Integer'
       }
     end
 
@@ -57,13 +53,13 @@ module KlaviyoAPI
     # @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 `KlaviyoAPI::CustomObjectPropertyCondition` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ProfilePredictiveAnalyticsChannelAffinityPriorityFilter` 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 `KlaviyoAPI::CustomObjectPropertyCondition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::ProfilePredictiveAnalyticsChannelAffinityPriorityFilter`. 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
       }
@@ -72,16 +68,12 @@ module KlaviyoAPI
         self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'custom_object_label')
-        self.custom_object_label = attributes[:'custom_object_label']
-      end
-
-      if attributes.key?(:'field')
-        self.field = attributes[:'field']
+      if attributes.key?(:'operator')
+        self.operator = attributes[:'operator']
       end
 
-      if attributes.key?(:'filter')
-        self.filter = attributes[:'filter']
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
       end
     end
 
@@ -93,16 +85,12 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
-      if @custom_object_label.nil?
-        invalid_properties.push('invalid value for "custom_object_label", custom_object_label cannot be nil.')
-      end
-
-      if @field.nil?
-        invalid_properties.push('invalid value for "field", field cannot be nil.')
+      if @operator.nil?
+        invalid_properties.push('invalid value for "operator", operator cannot be nil.')
       end
 
-      if @filter.nil?
-        invalid_properties.push('invalid value for "filter", filter cannot be nil.')
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value cannot be nil.')
       end
 
       invalid_properties
@@ -112,9 +100,8 @@ module KlaviyoAPI
     # @return true if the model is valid
     def valid?
       return false if @type.nil?
-      return false if @custom_object_label.nil?
-      return false if @field.nil?
-      return false if @filter.nil?
+      return false if @operator.nil?
+      return false if @value.nil?
       true
     end
 
@@ -124,9 +111,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          custom_object_label == o.custom_object_label &&
-          field == o.field &&
-          filter == o.filter
+          operator == o.operator &&
+          value == o.value
     end
 
     # @see the `==` method
@@ -138,7 +124,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, custom_object_label, field, filter].hash
+      [type, operator, value].hash
     end
 
     # Builds the object from hash