klaviyo-api-sdk 18.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/{mobile_push_badge.rb → dynamic_sms_image.rb}

@@ -13,11 +13,11 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class MobilePushBadge
-    # Whether to display a badge on the app icon
-    attr_accessor :display
+  class DynamicSMSImage
+    attr_accessor :dynamic
 
-    attr_accessor :badge_options
+    # Dynamic image template URL (e.g., {{product.image_url}}).
+    attr_accessor :dynamic_image_template
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -44,8 +44,8 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'display' => :'display',
-        :'badge_options' => :'badge_options'
+        :'dynamic' => :'dynamic',
+        :'dynamic_image_template' => :'dynamic_image_template'
       }
     end
 
@@ -57,15 +57,14 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'display' => :'Boolean',
-        :'badge_options' => :'MobilePushBadgeBadgeOptions'
+        :'dynamic' => :'Boolean',
+        :'dynamic_image_template' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'badge_options'
       ])
     end
 
@@ -73,23 +72,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::MobilePushBadge` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::DynamicSMSImage` 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::MobilePushBadge`. 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::DynamicSMSImage`. 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?(:'display')
-        self.display = attributes[:'display']
+      if attributes.key?(:'dynamic')
+        self.dynamic = attributes[:'dynamic']
+      else
+        self.dynamic = true
       end
 
-      if attributes.key?(:'badge_options')
-        self.badge_options = attributes[:'badge_options']
+      if attributes.key?(:'dynamic_image_template')
+        self.dynamic_image_template = attributes[:'dynamic_image_template']
       end
     end
 
@@ -97,8 +98,8 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @display.nil?
-        invalid_properties.push('invalid value for "display", display cannot be nil.')
+      if @dynamic_image_template.nil?
+        invalid_properties.push('invalid value for "dynamic_image_template", dynamic_image_template cannot be nil.')
       end
 
       invalid_properties
@@ -107,20 +108,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 @display.nil?
-      display_validator = EnumAttributeValidator.new('Boolean', ["true"])
-      return false unless display_validator.valid?(@display)
+      dynamic_validator = EnumAttributeValidator.new('Boolean', ["true"])
+      return false unless dynamic_validator.valid?(@dynamic)
+      return false if @dynamic_image_template.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] display Object to be assigned
-    def display=(display)
+    # @param [Object] dynamic Object to be assigned
+    def dynamic=(dynamic)
       validator = EnumAttributeValidator.new('Boolean', ["true"])
-      unless validator.valid?(display)
-        fail ArgumentError, "invalid value for \"display\", must be one of #{validator.allowable_values}."
+      unless validator.valid?(dynamic)
+        fail ArgumentError, "invalid value for \"dynamic\", must be one of #{validator.allowable_values}."
       end
-      @display = display
+      @dynamic = dynamic
     end
 
     # Checks equality by comparing each attribute.
@@ -128,8 +129,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          display == o.display &&
-          badge_options == o.badge_options
+          dynamic == o.dynamic &&
+          dynamic_image_template == o.dynamic_image_template
     end
 
     # @see the `==` method
@@ -141,7 +142,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display, badge_options].hash
+      [dynamic, dynamic_image_template].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{email_content.rb → email_channel_details.rb}

@@ -13,38 +13,59 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class EmailContent
-    # The subject of the message
-    attr_accessor :subject
-
-    # Preview text associated with the message
-    attr_accessor :preview_text
+  class EmailChannelDetails
+    attr_accessor :channel
 
-    # The email the message should be sent from
-    attr_accessor :from_email
+    attr_accessor :template_id
 
-    # The label associated with the from_email
     attr_accessor :from_label
 
-    # Optional Reply-To email address
+    attr_accessor :from_email
+
     attr_accessor :reply_to_email
 
-    # Optional CC email address
     attr_accessor :cc_email
 
-    # Optional BCC email address
     attr_accessor :bcc_email
 
+    attr_accessor :subject
+
+    attr_accessor :preview_text
+
+    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
       {
-        :'subject' => :'subject',
-        :'preview_text' => :'preview_text',
-        :'from_email' => :'from_email',
+        :'channel' => :'channel',
+        :'template_id' => :'template_id',
         :'from_label' => :'from_label',
+        :'from_email' => :'from_email',
         :'reply_to_email' => :'reply_to_email',
         :'cc_email' => :'cc_email',
-        :'bcc_email' => :'bcc_email'
+        :'bcc_email' => :'bcc_email',
+        :'subject' => :'subject',
+        :'preview_text' => :'preview_text'
       }
     end
 
@@ -56,26 +77,22 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subject' => :'String',
-        :'preview_text' => :'String',
-        :'from_email' => :'String',
+        :'channel' => :'String',
+        :'template_id' => :'String',
         :'from_label' => :'String',
+        :'from_email' => :'String',
         :'reply_to_email' => :'String',
         :'cc_email' => :'String',
-        :'bcc_email' => :'String'
+        :'bcc_email' => :'String',
+        :'subject' => :'String',
+        :'preview_text' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subject',
-        :'preview_text',
-        :'from_email',
-        :'from_label',
-        :'reply_to_email',
-        :'cc_email',
-        :'bcc_email'
+        :'template_id',
       ])
     end
 
@@ -83,43 +100,67 @@ 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::EmailContent` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::EmailChannelDetails` 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::EmailContent`. 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::EmailChannelDetails`. 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?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
-      if attributes.key?(:'preview_text')
-        self.preview_text = attributes[:'preview_text']
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      else
+        self.channel = 'email'
       end
 
-      if attributes.key?(:'from_email')
-        self.from_email = attributes[:'from_email']
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_id']
       end
 
       if attributes.key?(:'from_label')
         self.from_label = attributes[:'from_label']
+      else
+        self.from_label = ''
+      end
+
+      if attributes.key?(:'from_email')
+        self.from_email = attributes[:'from_email']
+      else
+        self.from_email = ''
       end
 
       if attributes.key?(:'reply_to_email')
         self.reply_to_email = attributes[:'reply_to_email']
+      else
+        self.reply_to_email = ''
       end
 
       if attributes.key?(:'cc_email')
         self.cc_email = attributes[:'cc_email']
+      else
+        self.cc_email = ''
       end
 
       if attributes.key?(:'bcc_email')
         self.bcc_email = attributes[:'bcc_email']
+      else
+        self.bcc_email = ''
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      else
+        self.subject = ''
+      end
+
+      if attributes.key?(:'preview_text')
+        self.preview_text = attributes[:'preview_text']
+      else
+        self.preview_text = ''
       end
     end
 
@@ -133,21 +174,35 @@ module KlaviyoAPI
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      channel_validator = EnumAttributeValidator.new('String', ["email"])
+      return false unless channel_validator.valid?(@channel)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["email"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    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 &&
-          subject == o.subject &&
-          preview_text == o.preview_text &&
-          from_email == o.from_email &&
+          channel == o.channel &&
+          template_id == o.template_id &&
           from_label == o.from_label &&
+          from_email == o.from_email &&
           reply_to_email == o.reply_to_email &&
           cc_email == o.cc_email &&
-          bcc_email == o.bcc_email
+          bcc_email == o.bcc_email &&
+          subject == o.subject &&
+          preview_text == o.preview_text
     end
 
     # @see the `==` method
@@ -159,7 +214,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subject, preview_text, from_email, from_label, reply_to_email, cc_email, bcc_email].hash
+      [channel, template_id, from_label, from_email, reply_to_email, cc_email, bcc_email, subject, preview_text].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{push_send_options.rb → email_header_link.rb}

@@ -13,14 +13,16 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class PushSendOptions
-    # Use smart sending.
-    attr_accessor :use_smart_sending
+  class EmailHeaderLink
+    attr_accessor :text
+
+    attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'use_smart_sending' => :'use_smart_sending'
+        :'text' => :'text',
+        :'url' => :'url'
       }
     end
 
@@ -32,14 +34,14 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'use_smart_sending' => :'Boolean'
+        :'text' => :'String',
+        :'url' => :'String'
       }
     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::PushSendOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::EmailHeaderLink` 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::PushSendOptions`. 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::EmailHeaderLink`. 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?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
       end
     end
 
@@ -69,12 +73,22 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @text.nil?
+        invalid_properties.push('invalid value for "text", text cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url 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 @text.nil?
+      return false if @url.nil?
       true
     end
 
@@ -83,7 +97,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          use_smart_sending == o.use_smart_sending
+          text == o.text &&
+          url == o.url
     end
 
     # @see the `==` method
@@ -95,7 +110,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [use_smart_sending].hash
+      [text, url].hash
     end
 
     # Builds the object from hash

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

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

data/lib/klaviyo-api-sdk/models/email_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_subscription_parameters.rb

@@ -18,11 +18,14 @@ module KlaviyoAPI
 
     attr_accessor :open_tracking
 
+    attr_accessor :click_tracking
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'marketing' => :'marketing',
-        :'open_tracking' => :'open_tracking'
+        :'open_tracking' => :'open_tracking',
+        :'click_tracking' => :'click_tracking'
       }
     end
 
@@ -35,7 +38,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'marketing' => :'SubscriptionParameters',
-        :'open_tracking' => :'OpenTrackingSubscriptionParameters'
+        :'open_tracking' => :'OpenTrackingSubscriptionParameters',
+        :'click_tracking' => :'ClickTrackingSubscriptionParameters'
       }
     end
 
@@ -67,6 +71,10 @@ module KlaviyoAPI
       if attributes.key?(:'open_tracking')
         self.open_tracking = attributes[:'open_tracking']
       end
+
+      if attributes.key?(:'click_tracking')
+        self.click_tracking = attributes[:'click_tracking']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,7 +96,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           marketing == o.marketing &&
-          open_tracking == o.open_tracking
+          open_tracking == o.open_tracking &&
+          click_tracking == o.click_tracking
     end
 
     # @see the `==` method
@@ -100,7 +109,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [marketing, open_tracking].hash
+      [marketing, open_tracking, click_tracking].hash
     end
 
     # Builds the object from hash