klaviyo-api-sdk 17.0.0 → 19.0.0

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

@@ -0,0 +1,295 @@
+=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 Address
+    # Street address line 1.
+    attr_accessor :street_address_1
+
+    # City.
+    attr_accessor :city
+
+    # State, province, or region.
+    attr_accessor :region
+
+    # Postal code.
+    attr_accessor :postal_code
+
+    # ISO 3166-1 alpha-2 country code for the business address.
+    attr_accessor :country
+
+    # Street address line 2.
+    attr_accessor :street_address_2
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'street_address_1' => :'street_address_1',
+        :'city' => :'city',
+        :'region' => :'region',
+        :'postal_code' => :'postal_code',
+        :'country' => :'country',
+        :'street_address_2' => :'street_address_2'
+      }
+    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
+      {
+        :'street_address_1' => :'String',
+        :'city' => :'String',
+        :'region' => :'String',
+        :'postal_code' => :'String',
+        :'country' => :'String',
+        :'street_address_2' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'street_address_2'
+      ])
+    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::Address` 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::Address`. 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?(:'street_address_1')
+        self.street_address_1 = attributes[:'street_address_1']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'street_address_2')
+        self.street_address_2 = attributes[:'street_address_2']
+      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 @street_address_1.nil?
+        invalid_properties.push('invalid value for "street_address_1", street_address_1 cannot be nil.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @region.nil?
+        invalid_properties.push('invalid value for "region", region cannot be nil.')
+      end
+
+      if @postal_code.nil?
+        invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.')
+      end
+
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country 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 @street_address_1.nil?
+      return false if @city.nil?
+      return false if @region.nil?
+      return false if @postal_code.nil?
+      return false if @country.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 &&
+          street_address_1 == o.street_address_1 &&
+          city == o.city &&
+          region == o.region &&
+          postal_code == o.postal_code &&
+          country == o.country &&
+          street_address_2 == o.street_address_2
+    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
+      [street_address_1, city, region, postal_code, country, street_address_2].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/age_gate_properties.rb

@@ -16,6 +16,10 @@ module KlaviyoAPI
   class AgeGateProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
+    attr_accessor :block_animation
+
     attr_accessor :label
 
     attr_accessor :show_label
@@ -59,6 +63,8 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'label' => :'label',
         :'show_label' => :'show_label',
         :'placeholder' => :'placeholder',
@@ -79,6 +85,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'label' => :'String',
         :'show_label' => :'Boolean',
         :'placeholder' => :'String',
@@ -93,6 +101,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'label',
         :'placeholder',
       ])
@@ -119,6 +128,14 @@ module KlaviyoAPI
         end
       end
 
+      if attributes.key?(:'classname')
+        self.classname = attributes[:'classname']
+      end
+
+      if attributes.key?(:'block_animation')
+        self.block_animation = attributes[:'block_animation']
+      end
+
       if attributes.key?(:'label')
         self.label = attributes[:'label']
       end
@@ -217,6 +234,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           display_device == o.display_device &&
+          classname == o.classname &&
+          block_animation == o.block_animation &&
           label == o.label &&
           show_label == o.show_label &&
           placeholder == o.placeholder &&
@@ -236,7 +255,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, label, show_label, placeholder, error_messages, property_name, date_format, sms_country_code, required].hash
+      [display_device, classname, block_animation, label, show_label, placeholder, error_messages, property_name, date_format, sms_country_code, required].hash
     end
 
     # Builds the object from hash

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

@@ -18,11 +18,14 @@ module KlaviyoAPI
 
     attr_accessor :background_color
 
+    attr_accessor :input_styles
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'padding' => :'padding',
-        :'background_color' => :'background_color'
+        :'background_color' => :'background_color',
+        :'input_styles' => :'input_styles'
       }
     end
 
@@ -35,14 +38,15 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'padding' => :'Padding',
-        :'background_color' => :'String'
+        :'background_color' => :'String',
+        :'input_styles' => :'InputStyleOverrides'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'background_color'
+        :'background_color',
       ])
     end
 
@@ -68,6 +72,10 @@ module KlaviyoAPI
       if attributes.key?(:'background_color')
         self.background_color = attributes[:'background_color']
       end
+
+      if attributes.key?(:'input_styles')
+        self.input_styles = attributes[:'input_styles']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,7 +97,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           padding == o.padding &&
-          background_color == o.background_color
+          background_color == o.background_color &&
+          input_styles == o.input_styles
     end
 
     # @see the `==` method
@@ -101,7 +110,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [padding, background_color].hash
+      [padding, background_color, input_styles].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb}

@@ -13,15 +13,18 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class DynamicTrackingParam
-    # The type of the tracking parameter
+  class Animation
+    # Enumeration for component entrance animation types.
     attr_accessor :type
 
-    # The value of the tracking parameter
-    attr_accessor :value
+    attr_accessor :duration
 
-    # Name of the tracking param
-    attr_accessor :name
+    attr_accessor :delay
+
+    # Enumeration for component animation easing functions.
+    attr_accessor :easing
+
+    attr_accessor :repeat
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -49,8 +52,10 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'type' => :'type',
-        :'value' => :'value',
-        :'name' => :'name'
+        :'duration' => :'duration',
+        :'delay' => :'delay',
+        :'easing' => :'easing',
+        :'repeat' => :'repeat'
       }
     end
 
@@ -63,8 +68,10 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'type' => :'String',
-        :'value' => :'String',
-        :'name' => :'String'
+        :'duration' => :'Integer',
+        :'delay' => :'Integer',
+        :'easing' => :'String',
+        :'repeat' => :'Boolean'
       }
     end
 
@@ -78,27 +85,45 @@ 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::DynamicTrackingParam` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::Animation` 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::DynamicTrackingParam`. 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::Animation`. 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']
+      else
+        self.type = 'none'
       end
 
-      if attributes.key?(:'value')
-        self.value = attributes[:'value']
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      else
+        self.duration = 600
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'delay')
+        self.delay = attributes[:'delay']
+      else
+        self.delay = 0
+      end
+
+      if attributes.key?(:'easing')
+        self.easing = attributes[:'easing']
+      else
+        self.easing = 'ease-out'
+      end
+
+      if attributes.key?(:'repeat')
+        self.repeat = attributes[:'repeat']
+      else
+        self.repeat = false
       end
     end
 
@@ -106,38 +131,23 @@ module KlaviyoAPI
     # @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 @value.nil?
-        invalid_properties.push('invalid value for "value", value cannot be nil.')
-      end
-
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name 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', ["dynamic"])
+      type_validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeInUp", "none", "pulse", "slideInDown", "slideInLeft", "slideInRight", "slideInUp", "zoomIn"])
       return false unless type_validator.valid?(@type)
-      return false if @value.nil?
-      value_validator = EnumAttributeValidator.new('String', ["campaign_id", "campaign_name", "campaign_name_id", "campaign_name_send_day", "email_subject", "group_id", "group_name", "group_name_id", "link_alt_text", "message_type", "profile_external_id", "profile_id"])
-      return false unless value_validator.valid?(@value)
-      return false if @name.nil?
+      easing_validator = EnumAttributeValidator.new('String', ["ease", "ease-in", "ease-in-out", "ease-out", "linear"])
+      return false unless easing_validator.valid?(@easing)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["dynamic"])
+      validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeInUp", "none", "pulse", "slideInDown", "slideInLeft", "slideInRight", "slideInUp", "zoomIn"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -145,13 +155,13 @@ module KlaviyoAPI
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] value Object to be assigned
-    def value=(value)
-      validator = EnumAttributeValidator.new('String', ["campaign_id", "campaign_name", "campaign_name_id", "campaign_name_send_day", "email_subject", "group_id", "group_name", "group_name_id", "link_alt_text", "message_type", "profile_external_id", "profile_id"])
-      unless validator.valid?(value)
-        fail ArgumentError, "invalid value for \"value\", must be one of #{validator.allowable_values}."
+    # @param [Object] easing Object to be assigned
+    def easing=(easing)
+      validator = EnumAttributeValidator.new('String', ["ease", "ease-in", "ease-in-out", "ease-out", "linear"])
+      unless validator.valid?(easing)
+        fail ArgumentError, "invalid value for \"easing\", must be one of #{validator.allowable_values}."
       end
-      @value = value
+      @easing = easing
     end
 
     # Checks equality by comparing each attribute.
@@ -160,8 +170,10 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          value == o.value &&
-          name == o.name
+          duration == o.duration &&
+          delay == o.delay &&
+          easing == o.easing &&
+          repeat == o.repeat
     end
 
     # @see the `==` method
@@ -173,7 +185,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, value, name].hash
+      [type, duration, delay, easing, repeat].hash
     end
 
     # Builds the object from hash