klaviyo-api-sdk 17.0.0 → 19.0.0

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

@@ -0,0 +1,271 @@
+=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 AbTestActionLinkOnly
+    attr_accessor :type
+
+    attr_accessor :links
+
+    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',
+        :'links' => :'links'
+      }
+    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' => :'String',
+        :'links' => :'Link'
+      }
+    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::AbTestActionLinkOnly` 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::AbTestActionLinkOnly`. 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?(:'links')
+        self.links = attributes[:'links']
+      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 @links.nil?
+        invalid_properties.push('invalid value for "links", links 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?
+      type_validator = EnumAttributeValidator.new('String', ["ab-test"])
+      return false unless type_validator.valid?(@type)
+      return false if @links.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["ab-test"])
+      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)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          links == o.links
+    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, links].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/{campaign_message_property.rb → ab_test_settings.rb}

@@ -13,10 +13,15 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class CampaignMessageProperty
-    attr_accessor :badge_config
+  class ABTestSettings
+    # The metric used to pick the winning variation.
+    attr_accessor :winner_metric
 
-    attr_accessor :set_from_property
+    # The percentage of the audience that receives the winning variation. The remainder is split evenly across the variations under test.
+    attr_accessor :winner_percentage
+
+    # How long to collect results before picking a winner, in hours.
+    attr_accessor :winner_wait_hours
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -43,8 +48,9 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'badge_config' => :'badge_config',
-        :'set_from_property' => :'set_from_property'
+        :'winner_metric' => :'winner_metric',
+        :'winner_percentage' => :'winner_percentage',
+        :'winner_wait_hours' => :'winner_wait_hours'
       }
     end
 
@@ -56,14 +62,18 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'badge_config' => :'String',
-        :'set_from_property' => :'String'
+        :'winner_metric' => :'String',
+        :'winner_percentage' => :'Integer',
+        :'winner_wait_hours' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'winner_metric',
+        :'winner_percentage',
+        :'winner_wait_hours'
       ])
     end
 
@@ -71,23 +81,27 @@ 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::CampaignMessageProperty` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ABTestSettings` 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::CampaignMessageProperty`. 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::ABTestSettings`. 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?(:'badge_config')
-        self.badge_config = attributes[:'badge_config']
+      if attributes.key?(:'winner_metric')
+        self.winner_metric = attributes[:'winner_metric']
+      end
+
+      if attributes.key?(:'winner_percentage')
+        self.winner_percentage = attributes[:'winner_percentage']
       end
 
-      if attributes.key?(:'set_from_property')
-        self.set_from_property = attributes[:'set_from_property']
+      if attributes.key?(:'winner_wait_hours')
+        self.winner_wait_hours = attributes[:'winner_wait_hours']
       end
     end
 
@@ -95,35 +109,25 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @badge_config.nil?
-        invalid_properties.push('invalid value for "badge_config", badge_config cannot be nil.')
-      end
-
-      if @set_from_property.nil?
-        invalid_properties.push('invalid value for "set_from_property", set_from_property 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 @badge_config.nil?
-      badge_config_validator = EnumAttributeValidator.new('String', ["set_property"])
-      return false unless badge_config_validator.valid?(@badge_config)
-      return false if @set_from_property.nil?
+      winner_metric_validator = EnumAttributeValidator.new('String', ["clicks_unique", "opens_unique", "placed_orders_unique"])
+      return false unless winner_metric_validator.valid?(@winner_metric)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] badge_config Object to be assigned
-    def badge_config=(badge_config)
-      validator = EnumAttributeValidator.new('String', ["set_property"])
-      unless validator.valid?(badge_config)
-        fail ArgumentError, "invalid value for \"badge_config\", must be one of #{validator.allowable_values}."
+    # @param [Object] winner_metric Object to be assigned
+    def winner_metric=(winner_metric)
+      validator = EnumAttributeValidator.new('String', ["clicks_unique", "opens_unique", "placed_orders_unique"])
+      unless validator.valid?(winner_metric)
+        fail ArgumentError, "invalid value for \"winner_metric\", must be one of #{validator.allowable_values}."
       end
-      @badge_config = badge_config
+      @winner_metric = winner_metric
     end
 
     # Checks equality by comparing each attribute.
@@ -131,8 +135,9 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          badge_config == o.badge_config &&
-          set_from_property == o.set_from_property
+          winner_metric == o.winner_metric &&
+          winner_percentage == o.winner_percentage &&
+          winner_wait_hours == o.winner_wait_hours
     end
 
     # @see the `==` method
@@ -144,7 +149,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [badge_config, set_from_property].hash
+      [winner_metric, winner_percentage, winner_wait_hours].hash
     end
 
     # Builds the object from hash

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

@@ -65,7 +65,7 @@ module KlaviyoAPI
         :'type' => :'String',
         :'output_config_id' => :'Integer',
         :'field' => :'String',
-        :'filter' => :'ActionOutputConditionFilter2'
+        :'filter' => :'ActionOutputConditionFilter'
       }
     end