klaviyo-api-sdk 18.0.0 → 19.0.0

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

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :classname
 
+    attr_accessor :block_animation
+
     attr_accessor :property_name
 
     attr_accessor :label
@@ -57,6 +59,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'display_device',
         :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'property_name' => :'property_name',
         :'label' => :'label',
         :'show_label' => :'show_label',
@@ -76,6 +79,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'Array<String>',
         :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'property_name' => :'String',
         :'label' => :'String',
         :'show_label' => :'Boolean',
@@ -120,6 +124,10 @@ module KlaviyoAPI
         self.classname = attributes[:'classname']
       end
 
+      if attributes.key?(:'block_animation')
+        self.block_animation = attributes[:'block_animation']
+      end
+
       if attributes.key?(:'property_name')
         self.property_name = attributes[:'property_name']
       end
@@ -174,6 +182,7 @@ module KlaviyoAPI
       self.class == o.class &&
           display_device == o.display_device &&
           classname == o.classname &&
+          block_animation == o.block_animation &&
           property_name == o.property_name &&
           label == o.label &&
           show_label == o.show_label &&
@@ -191,7 +200,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, classname, property_name, label, show_label, placeholder, required, error_messages].hash
+      [display_device, classname, block_animation, property_name, label, show_label, placeholder, required, error_messages].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → text_style_overrides.rb}

@@ -13,12 +13,17 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class ButtonBlockV0
-    attr_accessor :content_type
+  class TextStyleOverrides
+    attr_accessor :font_family
 
-    attr_accessor :type
+    attr_accessor :font_size
 
-    attr_accessor :data
+    # Font weight enumeration.
+    attr_accessor :font_weight
+
+    attr_accessor :character_spacing
+
+    attr_accessor :text_color
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -45,9 +50,11 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'content_type' => :'content_type',
-        :'type' => :'type',
-        :'data' => :'data'
+        :'font_family' => :'font_family',
+        :'font_size' => :'font_size',
+        :'font_weight' => :'font_weight',
+        :'character_spacing' => :'character_spacing',
+        :'text_color' => :'text_color'
       }
     end
 
@@ -59,16 +66,22 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'content_type' => :'String',
-        :'type' => :'String',
-        :'data' => :'Object'
+        :'font_family' => :'TextStyleOverridesFontFamily',
+        :'font_size' => :'Integer',
+        :'font_weight' => :'Integer',
+        :'character_spacing' => :'Integer',
+        :'text_color' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'data'
+        :'font_family',
+        :'font_size',
+        :'font_weight',
+        :'character_spacing',
+        :'text_color'
       ])
     end
 
@@ -76,27 +89,35 @@ 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::ButtonBlockV0` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::TextStyleOverrides` 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::ButtonBlockV0`. 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::TextStyleOverrides`. 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?(:'content_type')
-        self.content_type = attributes[:'content_type']
+      if attributes.key?(:'font_family')
+        self.font_family = attributes[:'font_family']
+      end
+
+      if attributes.key?(:'font_size')
+        self.font_size = attributes[:'font_size']
       end
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'font_weight')
+        self.font_weight = attributes[:'font_weight']
       end
 
-      if attributes.key?(:'data')
-        self.data = attributes[:'data']
+      if attributes.key?(:'character_spacing')
+        self.character_spacing = attributes[:'character_spacing']
+      end
+
+      if attributes.key?(:'text_color')
+        self.text_color = attributes[:'text_color']
       end
     end
 
@@ -104,47 +125,25 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @content_type.nil?
-        invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
-      end
-
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type 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 @content_type.nil?
-      content_type_validator = EnumAttributeValidator.new('String', ["block"])
-      return false unless content_type_validator.valid?(@content_type)
-      return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["button"])
-      return false unless type_validator.valid?(@type)
+      font_weight_validator = EnumAttributeValidator.new('Integer', [100, 200, 300, 400, 500, 600, 700, 800, 900])
+      return false unless font_weight_validator.valid?(@font_weight)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] content_type Object to be assigned
-    def content_type=(content_type)
-      validator = EnumAttributeValidator.new('String', ["block"])
-      unless validator.valid?(content_type)
-        fail ArgumentError, "invalid value for \"content_type\", must be one of #{validator.allowable_values}."
-      end
-      @content_type = content_type
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ["button"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+    # @param [Object] font_weight Object to be assigned
+    def font_weight=(font_weight)
+      validator = EnumAttributeValidator.new('Integer', [100, 200, 300, 400, 500, 600, 700, 800, 900])
+      unless validator.valid?(font_weight)
+        fail ArgumentError, "invalid value for \"font_weight\", must be one of #{validator.allowable_values}."
       end
-      @type = type
+      @font_weight = font_weight
     end
 
     # Checks equality by comparing each attribute.
@@ -152,9 +151,11 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          content_type == o.content_type &&
-          type == o.type &&
-          data == o.data
+          font_family == o.font_family &&
+          font_size == o.font_size &&
+          font_weight == o.font_weight &&
+          character_spacing == o.character_spacing &&
+          text_color == o.text_color
     end
 
     # @see the `==` method
@@ -166,7 +167,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_type, type, data].hash
+      [font_family, font_size, font_weight, character_spacing, text_color].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,103 @@
+=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
+  module TextStyleOverridesFontFamily
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = KlaviyoAPI.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise unless (data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model && model.valid?
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/klaviyo-api-sdk/models/text_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/{campaign_message_property.rb → throttled_options.rb}

@@ -13,10 +13,12 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class CampaignMessageProperty
-    attr_accessor :badge_config
+  class ThrottledOptions
+    # Percentage of recipients to send to per throttle unit (1, 2, 5, 10, 11, 13, 14, 17, 20, 25, 33, or 50)
+    attr_accessor :throttling_percentage
 
-    attr_accessor :set_from_property
+    # The time unit each batch of recipients is sent over: 'hour' or 'minute'.
+    attr_accessor :throttle_unit
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -43,8 +45,8 @@ 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'
+        :'throttling_percentage' => :'throttling_percentage',
+        :'throttle_unit' => :'throttle_unit'
       }
     end
 
@@ -56,8 +58,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'badge_config' => :'String',
-        :'set_from_property' => :'String'
+        :'throttling_percentage' => :'Integer',
+        :'throttle_unit' => :'String'
       }
     end
 
@@ -71,23 +73,25 @@ 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::ThrottledOptions` 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::ThrottledOptions`. 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?(:'throttling_percentage')
+        self.throttling_percentage = attributes[:'throttling_percentage']
       end
 
-      if attributes.key?(:'set_from_property')
-        self.set_from_property = attributes[:'set_from_property']
+      if attributes.key?(:'throttle_unit')
+        self.throttle_unit = attributes[:'throttle_unit']
+      else
+        self.throttle_unit = 'hour'
       end
     end
 
@@ -95,12 +99,8 @@ 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.')
+      if @throttling_percentage.nil?
+        invalid_properties.push('invalid value for "throttling_percentage", throttling_percentage cannot be nil.')
       end
 
       invalid_properties
@@ -109,21 +109,20 @@ module KlaviyoAPI
     # 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?
+      return false if @throttling_percentage.nil?
+      throttle_unit_validator = EnumAttributeValidator.new('String', ["hour", "minute"])
+      return false unless throttle_unit_validator.valid?(@throttle_unit)
       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] throttle_unit Object to be assigned
+    def throttle_unit=(throttle_unit)
+      validator = EnumAttributeValidator.new('String', ["hour", "minute"])
+      unless validator.valid?(throttle_unit)
+        fail ArgumentError, "invalid value for \"throttle_unit\", must be one of #{validator.allowable_values}."
       end
-      @badge_config = badge_config
+      @throttle_unit = throttle_unit
     end
 
     # Checks equality by comparing each attribute.
@@ -131,8 +130,8 @@ 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
+          throttling_percentage == o.throttling_percentage &&
+          throttle_unit == o.throttle_unit
     end
 
     # @see the `==` method
@@ -144,7 +143,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [badge_config, set_from_property].hash
+      [throttling_percentage, throttle_unit].hash
     end
 
     # Builds the object from hash