klaviyo-api-sdk 17.0.0 → 19.0.0

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

@@ -20,6 +20,8 @@ module KlaviyoAPI
         [
           :'Close',
           :'GoToInbox',
+          :'IafDeeplinkToScreen',
+          :'IafOpenUrl',
           :'NextStep',
           :'OpenForm',
           :'PromotionalSMSSubscription',

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

@@ -0,0 +1,409 @@
+=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 ImageAsset
+    # The unique identifier for this image asset. Not allowed on update.
+    attr_accessor :id
+
+    # The file path of the image in Klaviyo's storage.
+    attr_accessor :file_path
+
+    # The human-readable name of the image.
+    attr_accessor :name
+
+    # The image file format.
+    attr_accessor :format
+
+    # The size of the image file in bytes.
+    attr_accessor :file_size
+
+    # Timestamp when the image was last updated.
+    attr_accessor :updated
+
+    # The origin/source of the image (e.g., UI, API, AI, etc.).
+    attr_accessor :origin
+
+    # The full URL to access the image.
+    attr_accessor :url
+
+    # The type of image (static or dynamic).
+    attr_accessor :image_type
+
+    # Localization key for this image asset, if applicable.
+    attr_accessor :l10n_key
+
+    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
+      {
+        :'id' => :'id',
+        :'file_path' => :'file_path',
+        :'name' => :'name',
+        :'format' => :'format',
+        :'file_size' => :'file_size',
+        :'updated' => :'updated',
+        :'origin' => :'origin',
+        :'url' => :'url',
+        :'image_type' => :'image_type',
+        :'l10n_key' => :'l10n_key'
+      }
+    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
+      {
+        :'id' => :'Integer',
+        :'file_path' => :'String',
+        :'name' => :'String',
+        :'format' => :'String',
+        :'file_size' => :'Integer',
+        :'updated' => :'Time',
+        :'origin' => :'String',
+        :'url' => :'String',
+        :'image_type' => :'String',
+        :'l10n_key' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'origin',
+        :'l10n_key'
+      ])
+    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::ImageAsset` 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::ImageAsset`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'file_path')
+        self.file_path = attributes[:'file_path']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'format')
+        self.format = attributes[:'format']
+      end
+
+      if attributes.key?(:'file_size')
+        self.file_size = attributes[:'file_size']
+      end
+
+      if attributes.key?(:'updated')
+        self.updated = attributes[:'updated']
+      end
+
+      if attributes.key?(:'origin')
+        self.origin = attributes[:'origin']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'image_type')
+        self.image_type = attributes[:'image_type']
+      end
+
+      if attributes.key?(:'l10n_key')
+        self.l10n_key = attributes[:'l10n_key']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @file_path.nil?
+        invalid_properties.push('invalid value for "file_path", file_path cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @format.nil?
+        invalid_properties.push('invalid value for "format", format cannot be nil.')
+      end
+
+      if @file_size.nil?
+        invalid_properties.push('invalid value for "file_size", file_size cannot be nil.')
+      end
+
+      if @updated.nil?
+        invalid_properties.push('invalid value for "updated", updated cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @image_type.nil?
+        invalid_properties.push('invalid value for "image_type", image_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 @id.nil?
+      return false if @file_path.nil?
+      return false if @name.nil?
+      return false if @format.nil?
+      format_validator = EnumAttributeValidator.new('String', ["gif", "jpeg", "jpg", "png", "webp"])
+      return false unless format_validator.valid?(@format)
+      return false if @file_size.nil?
+      return false if @updated.nil?
+      origin_validator = EnumAttributeValidator.new('String', ["ADOPTION_SMS_FORM_FROM_EMAIL_FORM", "ADOPTION_SMS_MULTI_STEP_FORM_FROM_EMAIL_FORM", "AI", "API", "APPLICATION", "CLONED", "COMPOSER", "COMPOSER_AI_EDITED", "COMPOSER_AI_GENERATED", "COMPOSER_USED_IN_KLAVIYO_OBJECT", "COMPOSER_USER_UPLOADED", "COMPOSER_WEB_SCRAPED", "INTEGRATION", "KLAVIYO", "LIBRARY", "MARKETING_AGENT", "SANDBOX", "SOCIAL_INSTAGRAM", "SOCIAL_INSTAGRAM_OVERLAID", "UI", "WEB_SCRAPE"])
+      return false unless origin_validator.valid?(@origin)
+      return false if @url.nil?
+      return false if @image_type.nil?
+      image_type_validator = EnumAttributeValidator.new('String', ["dynamic", "static"])
+      return false unless image_type_validator.valid?(@image_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] format Object to be assigned
+    def format=(format)
+      validator = EnumAttributeValidator.new('String', ["gif", "jpeg", "jpg", "png", "webp"])
+      unless validator.valid?(format)
+        fail ArgumentError, "invalid value for \"format\", must be one of #{validator.allowable_values}."
+      end
+      @format = format
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] origin Object to be assigned
+    def origin=(origin)
+      validator = EnumAttributeValidator.new('String', ["ADOPTION_SMS_FORM_FROM_EMAIL_FORM", "ADOPTION_SMS_MULTI_STEP_FORM_FROM_EMAIL_FORM", "AI", "API", "APPLICATION", "CLONED", "COMPOSER", "COMPOSER_AI_EDITED", "COMPOSER_AI_GENERATED", "COMPOSER_USED_IN_KLAVIYO_OBJECT", "COMPOSER_USER_UPLOADED", "COMPOSER_WEB_SCRAPED", "INTEGRATION", "KLAVIYO", "LIBRARY", "MARKETING_AGENT", "SANDBOX", "SOCIAL_INSTAGRAM", "SOCIAL_INSTAGRAM_OVERLAID", "UI", "WEB_SCRAPE"])
+      unless validator.valid?(origin)
+        fail ArgumentError, "invalid value for \"origin\", must be one of #{validator.allowable_values}."
+      end
+      @origin = origin
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] image_type Object to be assigned
+    def image_type=(image_type)
+      validator = EnumAttributeValidator.new('String', ["dynamic", "static"])
+      unless validator.valid?(image_type)
+        fail ArgumentError, "invalid value for \"image_type\", must be one of #{validator.allowable_values}."
+      end
+      @image_type = image_type
+    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 &&
+          id == o.id &&
+          file_path == o.file_path &&
+          name == o.name &&
+          format == o.format &&
+          file_size == o.file_size &&
+          updated == o.updated &&
+          origin == o.origin &&
+          url == o.url &&
+          image_type == o.image_type &&
+          l10n_key == o.l10n_key
+    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
+      [id, file_path, name, format, file_size, updated, origin, url, image_type, l10n_key].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/image_block_cropping_properties.rb

@@ -14,7 +14,6 @@ require 'time'
 
 module KlaviyoAPI
   class ImageBlockCroppingProperties
-    # Aspect ratio options.
     attr_accessor :aspect_ratio
 
     attr_accessor :asset_id
@@ -29,28 +28,6 @@ module KlaviyoAPI
 
     attr_accessor :y
 
-    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
       {
@@ -149,21 +126,9 @@ module KlaviyoAPI
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      aspect_ratio_validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      return false unless aspect_ratio_validator.valid?(@aspect_ratio)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] aspect_ratio Object to be assigned
-    def aspect_ratio=(aspect_ratio)
-      validator = EnumAttributeValidator.new('String', ["16:9", "1:1", "2:3", "3:4", "4:3", "circle", "custom", "original"])
-      unless validator.valid?(aspect_ratio)
-        fail ArgumentError, "invalid value for \"aspect_ratio\", must be one of #{validator.allowable_values}."
-      end
-      @aspect_ratio = aspect_ratio
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

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

@@ -36,6 +36,8 @@ module KlaviyoAPI
 
     attr_accessor :block_padding_top
 
+    attr_accessor :border_radius
+
     attr_accessor :full_width_mobile
 
     attr_accessor :height
@@ -89,6 +91,7 @@ module KlaviyoAPI
         :'block_padding_left' => :'block_padding_left',
         :'block_padding_right' => :'block_padding_right',
         :'block_padding_top' => :'block_padding_top',
+        :'border_radius' => :'border_radius',
         :'full_width_mobile' => :'full_width_mobile',
         :'height' => :'height',
         :'inner_padding_bottom' => :'inner_padding_bottom',
@@ -119,6 +122,7 @@ module KlaviyoAPI
         :'block_padding_left' => :'Integer',
         :'block_padding_right' => :'Integer',
         :'block_padding_top' => :'Integer',
+        :'border_radius' => :'Integer',
         :'full_width_mobile' => :'Boolean',
         :'height' => :'Integer',
         :'inner_padding_bottom' => :'Integer',
@@ -144,6 +148,7 @@ module KlaviyoAPI
         :'block_padding_left',
         :'block_padding_right',
         :'block_padding_top',
+        :'border_radius',
         :'full_width_mobile',
         :'height',
         :'inner_padding_bottom',
@@ -211,6 +216,10 @@ module KlaviyoAPI
         self.block_padding_top = attributes[:'block_padding_top']
       end
 
+      if attributes.key?(:'border_radius')
+        self.border_radius = attributes[:'border_radius']
+      end
+
       if attributes.key?(:'full_width_mobile')
         self.full_width_mobile = attributes[:'full_width_mobile']
       end
@@ -300,6 +309,7 @@ module KlaviyoAPI
           block_padding_left == o.block_padding_left &&
           block_padding_right == o.block_padding_right &&
           block_padding_top == o.block_padding_top &&
+          border_radius == o.border_radius &&
           full_width_mobile == o.full_width_mobile &&
           height == o.height &&
           inner_padding_bottom == o.inner_padding_bottom &&
@@ -320,7 +330,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [align, 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, full_width_mobile, height, inner_padding_bottom, inner_padding_left, inner_padding_right, inner_padding_top, max_width, mobile_stretch_content, width].hash
+      [align, 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, border_radius, full_width_mobile, height, inner_padding_bottom, inner_padding_left, inner_padding_right, inner_padding_top, max_width, mobile_stretch_content, width].hash
     end
 
     # Builds the object from hash

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

@@ -16,6 +16,10 @@ module KlaviyoAPI
   class ImageProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
+    attr_accessor :block_animation
+
     attr_accessor :image
 
     attr_accessor :additional_fields
@@ -46,6 +50,8 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'image' => :'image',
         :'additional_fields' => :'additional_fields'
       }
@@ -60,6 +66,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'image' => :'ImageAssetProperties',
         :'additional_fields' => :'Array<AdditionalField>'
       }
@@ -68,6 +76,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'additional_fields'
       ])
     end
@@ -93,6 +102,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?(:'image')
         self.image = attributes[:'image']
       end
@@ -128,6 +145,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 &&
           image == o.image &&
           additional_fields == o.additional_fields
     end
@@ -141,7 +160,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, image, additional_fields].hash
+      [display_device, classname, block_animation, image, additional_fields].hash
     end
 
     # Builds the object from hash