klaviyo-api-sdk 17.0.0 → 19.0.0

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

@@ -0,0 +1,258 @@
+=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 OpenTrackingUnsubscriptionParameters
+    # The open-tracking consent to revoke. Currently supports \"UNSUBSCRIBED\".
+    attr_accessor :consent
+
+    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
+      {
+        :'consent' => :'consent'
+      }
+    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
+      {
+        :'consent' => :'String'
+      }
+    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::OpenTrackingUnsubscriptionParameters` 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::OpenTrackingUnsubscriptionParameters`. 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?(:'consent')
+        self.consent = attributes[:'consent']
+      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 @consent.nil?
+        invalid_properties.push('invalid value for "consent", consent 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 @consent.nil?
+      consent_validator = EnumAttributeValidator.new('String', ["UNSUBSCRIBED"])
+      return false unless consent_validator.valid?(@consent)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] consent Object to be assigned
+    def consent=(consent)
+      validator = EnumAttributeValidator.new('String', ["UNSUBSCRIBED"])
+      unless validator.valid?(consent)
+        fail ArgumentError, "invalid value for \"consent\", must be one of #{validator.allowable_values}."
+      end
+      @consent = consent
+    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 &&
+          consent == o.consent
+    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
+      [consent].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/opt_in_code_properties.rb

@@ -14,6 +14,10 @@ require 'time'
 
 module KlaviyoAPI
   class OptInCodeProperties
+    attr_accessor :classname
+
+    attr_accessor :block_animation
+
     attr_accessor :label
 
     attr_accessor :show_label
@@ -53,6 +57,8 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'label' => :'label',
         :'show_label' => :'show_label',
         :'placeholder' => :'placeholder',
@@ -71,6 +77,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'label' => :'String',
         :'show_label' => :'Boolean',
         :'placeholder' => :'String',
@@ -84,6 +92,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'label',
         :'placeholder',
       ])
@@ -104,6 +113,14 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
+      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
@@ -183,6 +200,8 @@ module KlaviyoAPI
     def ==(o)
       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 &&
@@ -201,7 +220,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [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/{email_send_options.rb → patch_identifiers.rb}

@@ -13,14 +13,16 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class EmailSendOptions
-    # Use smart sending.
-    attr_accessor :use_smart_sending
+  class PatchIdentifiers
+    attr_accessor :append
+
+    attr_accessor :unappend
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'use_smart_sending' => :'use_smart_sending'
+        :'append' => :'append',
+        :'unappend' => :'unappend'
       }
     end
 
@@ -32,14 +34,14 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'use_smart_sending' => :'Boolean'
+        :'append' => :'Object',
+        :'unappend' => :'Object'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'use_smart_sending'
       ])
     end
 
@@ -47,21 +49,23 @@ 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::EmailSendOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::PatchIdentifiers` 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::EmailSendOptions`. 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::PatchIdentifiers`. 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?(:'use_smart_sending')
-        self.use_smart_sending = attributes[:'use_smart_sending']
-      else
-        self.use_smart_sending = true
+      if attributes.key?(:'append')
+        self.append = attributes[:'append']
+      end
+
+      if attributes.key?(:'unappend')
+        self.unappend = attributes[:'unappend']
       end
     end
 
@@ -83,7 +87,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          use_smart_sending == o.use_smart_sending
+          append == o.append &&
+          unappend == o.unappend
     end
 
     # @see the `==` method
@@ -95,7 +100,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [use_smart_sending].hash
+      [append, unappend].hash
     end
 
     # Builds the object from hash

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

@@ -16,6 +16,10 @@ module KlaviyoAPI
   class PhoneNumberProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
+    attr_accessor :block_animation
+
     attr_accessor :label
 
     attr_accessor :show_label
@@ -58,6 +62,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',
@@ -78,6 +84,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'label' => :'String',
         :'show_label' => :'Boolean',
         :'placeholder' => :'String',
@@ -92,6 +100,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'label',
         :'placeholder',
         :'required',
@@ -120,6 +129,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
@@ -180,6 +197,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 &&
@@ -199,7 +218,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, 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/price_drop_condition.rb

@@ -65,7 +65,7 @@ module KlaviyoAPI
         :'type' => :'String',
         :'metric_id' => :'String',
         :'field' => :'String',
-        :'filter' => :'PriceDropConditionFilter2'
+        :'filter' => :'MetricPropertyConditionFilter'
       }
     end
 

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

@@ -74,7 +74,7 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'type' => :'String',
-        :'trigger_filter' => :'PriceDropConditionFilter',
+        :'trigger_filter' => :'PriceDropTriggerTriggerFilter',
         :'price_drop_amount_value' => :'NumericOperatorNumericFilterValue',
         :'price_drop_amount_unit' => :'String',
         :'audience' => :'Array<String>',
@@ -86,6 +86,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'trigger_filter',
       ])
     end
 
@@ -149,10 +150,6 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
-      if @trigger_filter.nil?
-        invalid_properties.push('invalid value for "trigger_filter", trigger_filter cannot be nil.')
-      end
-
       if @price_drop_amount_value.nil?
         invalid_properties.push('invalid value for "price_drop_amount_value", price_drop_amount_value cannot be nil.')
       end
@@ -170,7 +167,6 @@ module KlaviyoAPI
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["price-drop"])
       return false unless type_validator.valid?(@type)
-      return false if @trigger_filter.nil?
       return false if @price_drop_amount_value.nil?
       price_drop_amount_unit_validator = EnumAttributeValidator.new('String', ["currency", "percent"])
       return false unless price_drop_amount_unit_validator.valid?(@price_drop_amount_unit)

data/lib/klaviyo-api-sdk/models/{price_drop_condition_filter.rb → price_drop_trigger_trigger_filter.rb}

@@ -13,7 +13,7 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class PriceDropConditionFilter
+  class PriceDropTriggerTriggerFilter
     attr_accessor :condition_groups
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -31,7 +31,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'condition_groups' => :'Array<PriceDropConditionConditionGroup>'
+        :'condition_groups' => :'Array<PriceDropTriggerTriggerFilterConditionGroupsInner>'
       }
     end
 
@@ -45,13 +45,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::PriceDropConditionFilter` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::PriceDropTriggerTriggerFilter` 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::PriceDropConditionFilter`. 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::PriceDropTriggerTriggerFilter`. 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
       }