klaviyo-api-sdk 11.1.0 → 13.0.0

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-04-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,6 +15,8 @@ require 'time'
 
 module KlaviyoAPI
   class TextBlockStyles
+    attr_accessor :background_color
+
     attr_accessor :block_background_color
 
     attr_accessor :block_border_color
@@ -53,14 +55,12 @@ module KlaviyoAPI
 
     attr_accessor :inner_padding_top
 
-    attr_accessor :mobile_stretch_content
-
-    attr_accessor :background_color
-
     attr_accessor :letter_spacing
 
     attr_accessor :line_height
 
+    attr_accessor :mobile_stretch_content
+
     # Text Alignment.
     attr_accessor :text_align
 
@@ -94,6 +94,7 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'background_color' => :'background_color',
         :'block_background_color' => :'block_background_color',
         :'block_border_color' => :'block_border_color',
         :'block_border_style' => :'block_border_style',
@@ -112,10 +113,9 @@ module KlaviyoAPI
         :'inner_padding_left' => :'inner_padding_left',
         :'inner_padding_right' => :'inner_padding_right',
         :'inner_padding_top' => :'inner_padding_top',
-        :'mobile_stretch_content' => :'mobile_stretch_content',
-        :'background_color' => :'background_color',
         :'letter_spacing' => :'letter_spacing',
         :'line_height' => :'line_height',
+        :'mobile_stretch_content' => :'mobile_stretch_content',
         :'text_align' => :'text_align',
         :'text_decoration' => :'text_decoration',
         :'text_table_layout' => :'text_table_layout'
@@ -130,6 +130,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'background_color' => :'String',
         :'block_background_color' => :'String',
         :'block_border_color' => :'String',
         :'block_border_style' => :'String',
@@ -148,10 +149,9 @@ module KlaviyoAPI
         :'inner_padding_left' => :'Integer',
         :'inner_padding_right' => :'Integer',
         :'inner_padding_top' => :'Integer',
-        :'mobile_stretch_content' => :'Boolean',
-        :'background_color' => :'String',
         :'letter_spacing' => :'Integer',
         :'line_height' => :'Float',
+        :'mobile_stretch_content' => :'Boolean',
         :'text_align' => :'String',
         :'text_decoration' => :'String',
         :'text_table_layout' => :'String'
@@ -161,6 +161,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'background_color',
         :'block_background_color',
         :'block_border_color',
         :'block_border_style',
@@ -179,10 +180,9 @@ module KlaviyoAPI
         :'inner_padding_left',
         :'inner_padding_right',
         :'inner_padding_top',
-        :'mobile_stretch_content',
-        :'background_color',
         :'letter_spacing',
         :'line_height',
+        :'mobile_stretch_content',
         :'text_align',
         :'text_decoration',
         :'text_table_layout'
@@ -204,6 +204,10 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'background_color')
+        self.background_color = attributes[:'background_color']
+      end
+
       if attributes.key?(:'block_background_color')
         self.block_background_color = attributes[:'block_background_color']
       end
@@ -276,14 +280,6 @@ module KlaviyoAPI
         self.inner_padding_top = attributes[:'inner_padding_top']
       end
 
-      if attributes.key?(:'mobile_stretch_content')
-        self.mobile_stretch_content = attributes[:'mobile_stretch_content']
-      end
-
-      if attributes.key?(:'background_color')
-        self.background_color = attributes[:'background_color']
-      end
-
       if attributes.key?(:'letter_spacing')
         self.letter_spacing = attributes[:'letter_spacing']
       end
@@ -292,6 +288,10 @@ module KlaviyoAPI
         self.line_height = attributes[:'line_height']
       end
 
+      if attributes.key?(:'mobile_stretch_content')
+        self.mobile_stretch_content = attributes[:'mobile_stretch_content']
+      end
+
       if attributes.key?(:'text_align')
         self.text_align = attributes[:'text_align']
       end
@@ -371,6 +371,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          background_color == o.background_color &&
           block_background_color == o.block_background_color &&
           block_border_color == o.block_border_color &&
           block_border_style == o.block_border_style &&
@@ -389,10 +390,9 @@ module KlaviyoAPI
           inner_padding_left == o.inner_padding_left &&
           inner_padding_right == o.inner_padding_right &&
           inner_padding_top == o.inner_padding_top &&
-          mobile_stretch_content == o.mobile_stretch_content &&
-          background_color == o.background_color &&
           letter_spacing == o.letter_spacing &&
           line_height == o.line_height &&
+          mobile_stretch_content == o.mobile_stretch_content &&
           text_align == o.text_align &&
           text_decoration == o.text_decoration &&
           text_table_layout == o.text_table_layout
@@ -407,7 +407,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [block_background_color, block_border_color, block_border_style, block_border_width, block_padding_bottom, block_padding_left, block_padding_right, block_padding_top, color, extra_css_class, font_family, font_size, font_style, font_weight, inner_padding_bottom, inner_padding_left, inner_padding_right, inner_padding_top, mobile_stretch_content, background_color, letter_spacing, line_height, text_align, text_decoration, text_table_layout].hash
+      [background_color, block_background_color, block_border_color, block_border_style, block_border_width, block_padding_bottom, block_padding_left, block_padding_right, block_padding_top, color, extra_css_class, font_family, font_size, font_style, font_weight, inner_padding_bottom, inner_padding_left, inner_padding_right, inner_padding_top, letter_spacing, line_height, mobile_stretch_content, text_align, text_decoration, text_table_layout].hash
     end
 
     # Builds the object from hash

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-04-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -0,0 +1,36 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2025-04-15
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class ThrottledEnum
+    THROTTLED = "throttled".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = ThrottledEnum.constants.select { |c| ThrottledEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #ThrottledEnum" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -0,0 +1,288 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2025-04-15
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class ThrottledSendStrategy
+    attr_accessor :method
+
+    # The time to send at
+    attr_accessor :datetime
+
+    # The percentage of recipients per hour to send to.
+    attr_accessor :throttle_percentage
+
+    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
+      {
+        :'method' => :'method',
+        :'datetime' => :'datetime',
+        :'throttle_percentage' => :'throttle_percentage'
+      }
+    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
+      {
+        :'method' => :'ThrottledEnum',
+        :'datetime' => :'Time',
+        :'throttle_percentage' => :'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::ThrottledSendStrategy` 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::ThrottledSendStrategy`. 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?(:'method')
+        self.method = attributes[:'method']
+      end
+
+      if attributes.key?(:'datetime')
+        self.datetime = attributes[:'datetime']
+      end
+
+      if attributes.key?(:'throttle_percentage')
+        self.throttle_percentage = attributes[:'throttle_percentage']
+      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 @method.nil?
+        invalid_properties.push('invalid value for "method", method cannot be nil.')
+      end
+
+      if @datetime.nil?
+        invalid_properties.push('invalid value for "datetime", datetime cannot be nil.')
+      end
+
+      if @throttle_percentage.nil?
+        invalid_properties.push('invalid value for "throttle_percentage", throttle_percentage 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 @method.nil?
+      return false if @datetime.nil?
+      return false if @throttle_percentage.nil?
+      throttle_percentage_validator = EnumAttributeValidator.new('Integer', [10, 11, 13, 14, 17, 20, 25, 33, 50])
+      return false unless throttle_percentage_validator.valid?(@throttle_percentage)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] throttle_percentage Object to be assigned
+    def throttle_percentage=(throttle_percentage)
+      validator = EnumAttributeValidator.new('Integer', [10, 11, 13, 14, 17, 20, 25, 33, 50])
+      unless validator.valid?(throttle_percentage)
+        fail ArgumentError, "invalid value for \"throttle_percentage\", must be one of #{validator.allowable_values}."
+      end
+      @throttle_percentage = throttle_percentage
+    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 &&
+          method == o.method &&
+          datetime == o.datetime &&
+          throttle_percentage == o.throttle_percentage
+    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
+      [method, datetime, throttle_percentage].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