klaviyo-api-sdk 17.0.0 → 19.0.0

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

@@ -0,0 +1,265 @@
+=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 SpacingStyles
+    attr_accessor :padding_top
+
+    attr_accessor :padding_right
+
+    attr_accessor :padding_bottom
+
+    attr_accessor :padding_left
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'padding_top' => :'padding_top',
+        :'padding_right' => :'padding_right',
+        :'padding_bottom' => :'padding_bottom',
+        :'padding_left' => :'padding_left'
+      }
+    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
+      {
+        :'padding_top' => :'Integer',
+        :'padding_right' => :'Integer',
+        :'padding_bottom' => :'Integer',
+        :'padding_left' => :'Integer'
+      }
+    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::SpacingStyles` 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::SpacingStyles`. 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?(:'padding_top')
+        self.padding_top = attributes[:'padding_top']
+      end
+
+      if attributes.key?(:'padding_right')
+        self.padding_right = attributes[:'padding_right']
+      end
+
+      if attributes.key?(:'padding_bottom')
+        self.padding_bottom = attributes[:'padding_bottom']
+      end
+
+      if attributes.key?(:'padding_left')
+        self.padding_left = attributes[:'padding_left']
+      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 @padding_top.nil?
+        invalid_properties.push('invalid value for "padding_top", padding_top cannot be nil.')
+      end
+
+      if @padding_right.nil?
+        invalid_properties.push('invalid value for "padding_right", padding_right cannot be nil.')
+      end
+
+      if @padding_bottom.nil?
+        invalid_properties.push('invalid value for "padding_bottom", padding_bottom cannot be nil.')
+      end
+
+      if @padding_left.nil?
+        invalid_properties.push('invalid value for "padding_left", padding_left 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 @padding_top.nil?
+      return false if @padding_right.nil?
+      return false if @padding_bottom.nil?
+      return false if @padding_left.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 &&
+          padding_top == o.padding_top &&
+          padding_right == o.padding_right &&
+          padding_bottom == o.padding_bottom &&
+          padding_left == o.padding_left
+    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
+      [padding_top, padding_right, padding_bottom, padding_left].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/spin_to_win_properties.rb

@@ -16,6 +16,10 @@ module KlaviyoAPI
   class SpinToWinProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
+    attr_accessor :block_animation
+
     attr_accessor :duplicate_slices
 
     attr_accessor :slices
@@ -46,6 +50,8 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'duplicate_slices' => :'duplicate_slices',
         :'slices' => :'slices'
       }
@@ -60,6 +66,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'duplicate_slices' => :'Boolean',
         :'slices' => :'Array<SpinToWinSliceConfig>'
       }
@@ -68,6 +76,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
       ])
     end
 
@@ -92,6 +101,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?(:'duplicate_slices')
         self.duplicate_slices = attributes[:'duplicate_slices']
       else
@@ -129,6 +146,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 &&
           duplicate_slices == o.duplicate_slices &&
           slices == o.slices
     end
@@ -142,7 +161,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, duplicate_slices, slices].hash
+      [display_device, classname, block_animation, duplicate_slices, slices].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,270 @@
+=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 StaticSMSImage
+    attr_accessor :dynamic
+
+    # The ID of the static image asset to include.
+    attr_accessor :static_image_asset_id
+
+    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
+      {
+        :'dynamic' => :'dynamic',
+        :'static_image_asset_id' => :'static_image_asset_id'
+      }
+    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
+      {
+        :'dynamic' => :'Boolean',
+        :'static_image_asset_id' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'dynamic',
+      ])
+    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::StaticSMSImage` 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::StaticSMSImage`. 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?(:'dynamic')
+        self.dynamic = attributes[:'dynamic']
+      else
+        self.dynamic = false
+      end
+
+      if attributes.key?(:'static_image_asset_id')
+        self.static_image_asset_id = attributes[:'static_image_asset_id']
+      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 @static_image_asset_id.nil?
+        invalid_properties.push('invalid value for "static_image_asset_id", static_image_asset_id 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?
+      dynamic_validator = EnumAttributeValidator.new('Boolean', ["false"])
+      return false unless dynamic_validator.valid?(@dynamic)
+      return false if @static_image_asset_id.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] dynamic Object to be assigned
+    def dynamic=(dynamic)
+      validator = EnumAttributeValidator.new('Boolean', ["false"])
+      unless validator.valid?(dynamic)
+        fail ArgumentError, "invalid value for \"dynamic\", must be one of #{validator.allowable_values}."
+      end
+      @dynamic = dynamic
+    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 &&
+          dynamic == o.dynamic &&
+          static_image_asset_id == o.static_image_asset_id
+    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
+      [dynamic, static_image_asset_id].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/string_phone_operator_string_array_filter.rb

@@ -16,7 +16,7 @@ module KlaviyoAPI
   class StringPhoneOperatorStringArrayFilter
     attr_accessor :type
 
-    # Operators for phone string array filters.  Example condition using this filter:         {
+    # Operators for phone string array filters.  Example condition using this filter:         {             \"type\": \"profile-property\",             \"field\": \"phone\",             \"filter\": {                 \"type\": \"string\",                 \"operator\": \"phone-country-code-in\",                 \"value\": [\"US\", \"GB\"]             }         }
     attr_accessor :operator
 
     attr_accessor :value

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

@@ -45,7 +45,6 @@ module KlaviyoAPI
 
     attr_accessor :cropped_src
 
-    # Aspect ratio options.
     attr_accessor :cropping_aspect_ratio
 
     attr_accessor :cropping_height
@@ -287,8 +286,6 @@ module KlaviyoAPI
       return false unless show_on_validator.valid?(@show_on)
       cell_text_align_validator = EnumAttributeValidator.new('String', ["center", "left", "right"])
       return false unless cell_text_align_validator.valid?(@cell_text_align)
-      cropping_aspect_ratio_validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      return false unless cropping_aspect_ratio_validator.valid?(@cropping_aspect_ratio)
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["table_fallback_image"])
       return false unless type_validator.valid?(@type)
@@ -325,16 +322,6 @@ module KlaviyoAPI
       @cell_text_align = cell_text_align
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] cropping_aspect_ratio Object to be assigned
-    def cropping_aspect_ratio=(cropping_aspect_ratio)
-      validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      unless validator.valid?(cropping_aspect_ratio)
-        fail ArgumentError, "invalid value for \"cropping_aspect_ratio\", must be one of #{validator.allowable_values}."
-      end
-      @cropping_aspect_ratio = cropping_aspect_ratio
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)

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

@@ -45,7 +45,6 @@ module KlaviyoAPI
 
     attr_accessor :cropped_src
 
-    # Aspect ratio options.
     attr_accessor :cropping_aspect_ratio
 
     attr_accessor :cropping_height
@@ -287,8 +286,6 @@ module KlaviyoAPI
       return false unless show_on_validator.valid?(@show_on)
       cell_text_align_validator = EnumAttributeValidator.new('String', ["center", "left", "right"])
       return false unless cell_text_align_validator.valid?(@cell_text_align)
-      cropping_aspect_ratio_validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      return false unless cropping_aspect_ratio_validator.valid?(@cropping_aspect_ratio)
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["table_image"])
       return false unless type_validator.valid?(@type)
@@ -325,16 +322,6 @@ module KlaviyoAPI
       @cell_text_align = cell_text_align
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] cropping_aspect_ratio Object to be assigned
-    def cropping_aspect_ratio=(cropping_aspect_ratio)
-      validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      unless validator.valid?(cropping_aspect_ratio)
-        fail ArgumentError, "invalid value for \"cropping_aspect_ratio\", must be one of #{validator.allowable_values}."
-      end
-      @cropping_aspect_ratio = cropping_aspect_ratio
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)