klaviyo-api-sdk 17.0.0 → 19.0.0

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/email_header_link.rb

@@ -0,0 +1,237 @@
+=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 EmailHeaderLink
+    attr_accessor :text
+
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'text' => :'text',
+        :'url' => :'url'
+      }
+    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
+      {
+        :'text' => :'String',
+        :'url' => :'String'
+      }
+    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::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::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?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      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 @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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          text == o.text &&
+          url == o.url
+    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
+      [text, url].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/email_properties.rb

@@ -16,6 +16,10 @@ module KlaviyoAPI
   class EmailProperties
     attr_accessor :display_device
 
+    attr_accessor :classname
+
+    attr_accessor :block_animation
+
     attr_accessor :label
 
     attr_accessor :show_label
@@ -54,6 +58,8 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'display_device' => :'display_device',
+        :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'label' => :'label',
         :'show_label' => :'show_label',
         :'placeholder' => :'placeholder',
@@ -72,6 +78,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'display_device' => :'Array<String>',
+        :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'label' => :'String',
         :'show_label' => :'Boolean',
         :'placeholder' => :'String',
@@ -84,6 +92,7 @@ module KlaviyoAPI
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'classname',
         :'label',
         :'placeholder',
         :'required',
@@ -111,6 +120,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?(:'label')
         self.label = attributes[:'label']
       end
@@ -173,6 +190,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 &&
           label == o.label &&
           show_label == o.show_label &&
           placeholder == o.placeholder &&
@@ -190,7 +209,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, 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

@@ -16,10 +16,16 @@ module KlaviyoAPI
   class EmailSubscriptionParameters
     attr_accessor :marketing
 
+    attr_accessor :open_tracking
+
+    attr_accessor :click_tracking
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'marketing' => :'marketing'
+        :'marketing' => :'marketing',
+        :'open_tracking' => :'open_tracking',
+        :'click_tracking' => :'click_tracking'
       }
     end
 
@@ -31,7 +37,9 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'marketing' => :'SubscriptionParameters'
+        :'marketing' => :'SubscriptionParameters',
+        :'open_tracking' => :'OpenTrackingSubscriptionParameters',
+        :'click_tracking' => :'ClickTrackingSubscriptionParameters'
       }
     end
 
@@ -59,23 +67,26 @@ module KlaviyoAPI
       if attributes.key?(:'marketing')
         self.marketing = attributes[:'marketing']
       end
+
+      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?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @marketing.nil?
-        invalid_properties.push('invalid value for "marketing", marketing 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 @marketing.nil?
       true
     end
 
@@ -84,7 +95,9 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          marketing == o.marketing
+          marketing == o.marketing &&
+          open_tracking == o.open_tracking &&
+          click_tracking == o.click_tracking
     end
 
     # @see the `==` method
@@ -96,7 +109,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [marketing].hash
+      [marketing, open_tracking, click_tracking].hash
     end
 
     # Builds the object from hash