klaviyo-api-sdk 18.0.0 → 19.0.0

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

@@ -0,0 +1,237 @@
+=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 MultiBranchSplitBranchLinkOnly
+    attr_accessor :branch_id
+
+    attr_accessor :links
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'branch_id' => :'branch_id',
+        :'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
+      {
+        :'branch_id' => :'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::MultiBranchSplitBranchLinkOnly` 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::MultiBranchSplitBranchLinkOnly`. 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?(:'branch_id')
+        self.branch_id = attributes[:'branch_id']
+      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 @branch_id.nil?
+        invalid_properties.push('invalid value for "branch_id", branch_id 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 @branch_id.nil?
+      return false if @links.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 &&
+          branch_id == o.branch_id &&
+          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
+      [branch_id, 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/onsite_profile_create_query_resource_object.rb

@@ -43,7 +43,7 @@ module KlaviyoAPI
       {
         :'type' => :'ProfileEnum',
         :'id' => :'String',
-        :'attributes' => :'OnsiteProfileCreateQueryResourceObjectAttributes',
+        :'attributes' => :'EventProfileCreateQueryResourceObjectAttributes',
         :'meta' => :'OnsiteProfileMeta'
       }
     end

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

@@ -16,6 +16,8 @@ module KlaviyoAPI
   class OptInCodeProperties
     attr_accessor :classname
 
+    attr_accessor :block_animation
+
     attr_accessor :label
 
     attr_accessor :show_label
@@ -56,6 +58,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'label' => :'label',
         :'show_label' => :'show_label',
         :'placeholder' => :'placeholder',
@@ -75,6 +78,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'label' => :'String',
         :'show_label' => :'Boolean',
         :'placeholder' => :'String',
@@ -113,6 +117,10 @@ module KlaviyoAPI
         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
@@ -193,6 +201,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           classname == o.classname &&
+          block_animation == o.block_animation &&
           label == o.label &&
           show_label == o.show_label &&
           placeholder == o.placeholder &&
@@ -211,7 +220,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [classname, label, show_label, placeholder, error_messages, property_name, required, display_device].hash
+      [classname, block_animation, label, show_label, placeholder, error_messages, property_name, required, display_device].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/opt_in_code_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/phone_number_properties.rb

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :classname
 
+    attr_accessor :block_animation
+
     attr_accessor :label
 
     attr_accessor :show_label
@@ -61,6 +63,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'display_device',
         :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'label' => :'label',
         :'show_label' => :'show_label',
         :'placeholder' => :'placeholder',
@@ -82,6 +85,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'Array<String>',
         :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'label' => :'String',
         :'show_label' => :'Boolean',
         :'placeholder' => :'String',
@@ -129,6 +133,10 @@ module KlaviyoAPI
         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
@@ -190,6 +198,7 @@ module KlaviyoAPI
       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 &&
@@ -209,7 +218,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, classname, label, show_label, placeholder, required, error_messages, property_name, sms_consent_type, channel_settings].hash
+      [display_device, classname, block_animation, label, show_label, placeholder, required, error_messages, property_name, sms_consent_type, channel_settings].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/phone_number_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/profile_event_tracked_properties.rb

@@ -18,11 +18,14 @@ module KlaviyoAPI
 
     attr_accessor :property_filters
 
+    attr_accessor :delay_seconds
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'metric' => :'metric',
-        :'property_filters' => :'property_filters'
+        :'property_filters' => :'property_filters',
+        :'delay_seconds' => :'delay_seconds'
       }
     end
 
@@ -35,7 +38,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'metric' => :'String',
-        :'property_filters' => :'Array<PropertyFilter>'
+        :'property_filters' => :'Array<PropertyFilter>',
+        :'delay_seconds' => :'Integer'
       }
     end
 
@@ -43,7 +47,8 @@ module KlaviyoAPI
     def self.openapi_nullable
       Set.new([
         :'metric',
-        :'property_filters'
+        :'property_filters',
+        :'delay_seconds'
       ])
     end
 
@@ -73,6 +78,10 @@ module KlaviyoAPI
           self.property_filters = value
         end
       end
+
+      if attributes.key?(:'delay_seconds')
+        self.delay_seconds = attributes[:'delay_seconds']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,7 +103,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           metric == o.metric &&
-          property_filters == o.property_filters
+          property_filters == o.property_filters &&
+          delay_seconds == o.delay_seconds
     end
 
     # @see the `==` method
@@ -106,7 +116,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [metric, property_filters].hash
+      [metric, property_filters, delay_seconds].hash
     end
 
     # Builds the object from hash

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

@@ -20,6 +20,8 @@ module KlaviyoAPI
         [
           :'BooleanFilter',
           :'ExistenceOperatorExistenceFilter',
+          :'ListContainsOperatorListContainsFilter',
+          :'ListLengthFilter',
           :'NumericOperatorNumericFilter',
           :'NumericRangeFilter',
           :'RelativeAnniversaryDateFilter',

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

@@ -42,7 +42,6 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'filter'
       ])
     end
 
@@ -78,6 +77,10 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "property", property cannot be nil.')
       end
 
+      if @filter.nil?
+        invalid_properties.push('invalid value for "filter", filter cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -85,6 +88,7 @@ module KlaviyoAPI
     # @return true if the model is valid
     def valid?
       return false if @property.nil?
+      return false if @filter.nil?
       true
     end
 

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

@@ -127,7 +127,7 @@ module KlaviyoAPI
       return false unless type_validator.valid?(@type)
       return false if @permission.nil?
       return false if @channel.nil?
-      channel_validator = EnumAttributeValidator.new('String', ["whatsapp_marketing", "whatsapp_transactional"])
+      channel_validator = EnumAttributeValidator.new('String', ["email_click_tracking", "email_open_tracking", "whatsapp_marketing", "whatsapp_transactional"])
       return false unless channel_validator.valid?(@channel)
       true
     end
@@ -145,7 +145,7 @@ module KlaviyoAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] channel Object to be assigned
     def channel=(channel)
-      validator = EnumAttributeValidator.new('String', ["whatsapp_marketing", "whatsapp_transactional"])
+      validator = EnumAttributeValidator.new('String', ["email_click_tracking", "email_open_tracking", "whatsapp_marketing", "whatsapp_transactional"])
       unless validator.valid?(channel)
         fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
       end

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

@@ -16,6 +16,7 @@ module KlaviyoAPI
   class ProfilePropertyCondition
     attr_accessor :type
 
+    # The profile property to check. Use one of the well-known property names (e.g. `email`, `first_name`) or, for custom profile properties, the form `properties['property name']`.
     attr_accessor :property
 
     attr_accessor :filter