klaviyo-api-sdk 18.0.0 → 19.0.0

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

@@ -0,0 +1,35 @@
+=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 CampaignVariationEnum
+    CAMPAIGN_VARIATION = "campaign-variation".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 = CampaignVariationEnum.constants.select { |c| CampaignVariationEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #CampaignVariationEnum" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :classname
 
+    attr_accessor :block_animation
+
     attr_accessor :property_name
 
     attr_accessor :label
@@ -59,6 +61,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'display_device',
         :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'property_name' => :'property_name',
         :'label' => :'label',
         :'show_label' => :'show_label',
@@ -79,6 +82,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'Array<String>',
         :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'property_name' => :'String',
         :'label' => :'String',
         :'show_label' => :'Boolean',
@@ -124,6 +128,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
@@ -189,6 +197,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 &&
@@ -207,7 +216,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, classname, property_name, label, show_label, required, error_messages, options, placeholder].hash
+      [display_device, classname, block_animation, property_name, label, show_label, required, error_messages, options, placeholder].hash
     end
 
     # Builds the object from hash

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

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :background_color
 
+    attr_accessor :input_styles
+
     # Arrangement enumeration.
     attr_accessor :arrangement
 
@@ -51,6 +53,7 @@ module KlaviyoAPI
       {
         :'padding' => :'padding',
         :'background_color' => :'background_color',
+        :'input_styles' => :'input_styles',
         :'arrangement' => :'arrangement',
         :'alignment' => :'alignment'
       }
@@ -66,6 +69,7 @@ module KlaviyoAPI
       {
         :'padding' => :'Padding',
         :'background_color' => :'String',
+        :'input_styles' => :'InputStyleOverrides',
         :'arrangement' => :'String',
         :'alignment' => :'String'
       }
@@ -101,6 +105,10 @@ module KlaviyoAPI
         self.background_color = attributes[:'background_color']
       end
 
+      if attributes.key?(:'input_styles')
+        self.input_styles = attributes[:'input_styles']
+      end
+
       if attributes.key?(:'arrangement')
         self.arrangement = attributes[:'arrangement']
       else
@@ -158,6 +166,7 @@ module KlaviyoAPI
       self.class == o.class &&
           padding == o.padding &&
           background_color == o.background_color &&
+          input_styles == o.input_styles &&
           arrangement == o.arrangement &&
           alignment == o.alignment
     end
@@ -171,7 +180,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [padding, background_color, arrangement, alignment].hash
+      [padding, background_color, input_styles, arrangement, alignment].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → click_tracking_subscription_parameters.rb}

@@ -13,9 +13,9 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class MobilePushNoBadge
-    # Whether to display a badge on the app icon
-    attr_accessor :display
+  class ClickTrackingSubscriptionParameters
+    # The click-tracking consent to grant. Currently supports \"SUBSCRIBED\".
+    attr_accessor :consent
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -42,7 +42,7 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'display' => :'display'
+        :'consent' => :'consent'
       }
     end
 
@@ -54,7 +54,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'display' => :'Boolean'
+        :'consent' => :'String'
       }
     end
 
@@ -68,19 +68,19 @@ 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::MobilePushNoBadge` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ClickTrackingSubscriptionParameters` 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::MobilePushNoBadge`. 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::ClickTrackingSubscriptionParameters`. 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?(:'consent')
+        self.consent = attributes[:'consent']
       end
     end
 
@@ -88,8 +88,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 @consent.nil?
+        invalid_properties.push('invalid value for "consent", consent cannot be nil.')
       end
 
       invalid_properties
@@ -98,20 +98,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', ["false"])
-      return false unless display_validator.valid?(@display)
+      return false if @consent.nil?
+      consent_validator = EnumAttributeValidator.new('String', ["SUBSCRIBED"])
+      return false unless consent_validator.valid?(@consent)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] display Object to be assigned
-    def display=(display)
-      validator = EnumAttributeValidator.new('Boolean', ["false"])
-      unless validator.valid?(display)
-        fail ArgumentError, "invalid value for \"display\", must be one of #{validator.allowable_values}."
+    # @param [Object] consent Object to be assigned
+    def consent=(consent)
+      validator = EnumAttributeValidator.new('String', ["SUBSCRIBED"])
+      unless validator.valid?(consent)
+        fail ArgumentError, "invalid value for \"consent\", must be one of #{validator.allowable_values}."
       end
-      @display = display
+      @consent = consent
     end
 
     # Checks equality by comparing each attribute.
@@ -119,7 +119,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          display == o.display
+          consent == o.consent
     end
 
     # @see the `==` method
@@ -131,7 +131,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display].hash
+      [consent].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_unsubscription_parameters.rb}

@@ -13,8 +13,9 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class CampaignMessageIncrement
-    attr_accessor :badge_config
+  class ClickTrackingUnsubscriptionParameters
+    # The click-tracking consent to revoke. Currently supports \"UNSUBSCRIBED\".
+    attr_accessor :consent
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -41,7 +42,7 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'badge_config' => :'badge_config'
+        :'consent' => :'consent'
       }
     end
 
@@ -53,7 +54,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'badge_config' => :'String'
+        :'consent' => :'String'
       }
     end
 
@@ -67,19 +68,19 @@ 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::CampaignMessageIncrement` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ClickTrackingUnsubscriptionParameters` 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::CampaignMessageIncrement`. 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::ClickTrackingUnsubscriptionParameters`. 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?(:'consent')
+        self.consent = attributes[:'consent']
       end
     end
 
@@ -87,8 +88,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.')
+      if @consent.nil?
+        invalid_properties.push('invalid value for "consent", consent cannot be nil.')
       end
 
       invalid_properties
@@ -97,20 +98,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', ["increment_one"])
-      return false unless badge_config_validator.valid?(@badge_config)
+      return false if @consent.nil?
+      consent_validator = EnumAttributeValidator.new('String', ["UNSUBSCRIBED"])
+      return false unless consent_validator.valid?(@consent)
       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', ["increment_one"])
-      unless validator.valid?(badge_config)
-        fail ArgumentError, "invalid value for \"badge_config\", must be one of #{validator.allowable_values}."
+    # @param [Object] consent Object to be assigned
+    def consent=(consent)
+      validator = EnumAttributeValidator.new('String', ["UNSUBSCRIBED"])
+      unless validator.valid?(consent)
+        fail ArgumentError, "invalid value for \"consent\", must be one of #{validator.allowable_values}."
       end
-      @badge_config = badge_config
+      @consent = consent
     end
 
     # Checks equality by comparing each attribute.
@@ -118,7 +119,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          badge_config == o.badge_config
+          consent == o.consent
     end
 
     # @see the `==` method
@@ -130,7 +131,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [badge_config].hash
+      [consent].hash
     end
 
     # Builds the object from hash

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

@@ -26,6 +26,31 @@ module KlaviyoAPI
 
     attr_accessor :margin
 
+    # Horizontal position of the close button.
+    attr_accessor :position
+
+    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
       {
@@ -34,7 +59,8 @@ module KlaviyoAPI
         :'color' => :'color',
         :'stroke' => :'stroke',
         :'size' => :'size',
-        :'margin' => :'margin'
+        :'margin' => :'margin',
+        :'position' => :'position'
       }
     end
 
@@ -51,13 +77,15 @@ module KlaviyoAPI
         :'color' => :'String',
         :'stroke' => :'Float',
         :'size' => :'Integer',
-        :'margin' => :'Margin'
+        :'margin' => :'Margin',
+        :'position' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'position'
       ])
     end
 
@@ -109,6 +137,10 @@ module KlaviyoAPI
       if attributes.key?(:'margin')
         self.margin = attributes[:'margin']
       end
+
+      if attributes.key?(:'position')
+        self.position = attributes[:'position']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -121,9 +153,21 @@ module KlaviyoAPI
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      position_validator = EnumAttributeValidator.new('String', ["left", "right"])
+      return false unless position_validator.valid?(@position)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] position Object to be assigned
+    def position=(position)
+      validator = EnumAttributeValidator.new('String', ["left", "right"])
+      unless validator.valid?(position)
+        fail ArgumentError, "invalid value for \"position\", must be one of #{validator.allowable_values}."
+      end
+      @position = position
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -134,7 +178,8 @@ module KlaviyoAPI
           color == o.color &&
           stroke == o.stroke &&
           size == o.size &&
-          margin == o.margin
+          margin == o.margin &&
+          position == o.position
     end
 
     # @see the `==` method
@@ -146,7 +191,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [background_color, outline_color, color, stroke, size, margin].hash
+      [background_color, outline_color, color, stroke, size, margin, position].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{push_on_open_web_url.rb → code_action_link_only.rb}

@@ -13,11 +13,10 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class PushOnOpenWebUrl
+  class CodeActionLinkOnly
     attr_accessor :type
 
-    # External url to open when push notification is triggered
-    attr_accessor :web_url
+    attr_accessor :links
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -45,7 +44,7 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'type' => :'type',
-        :'web_url' => :'web_url'
+        :'links' => :'links'
       }
     end
 
@@ -58,14 +57,13 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'type' => :'String',
-        :'web_url' => :'String'
+        :'links' => :'Link'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'web_url'
       ])
     end
 
@@ -73,13 +71,13 @@ 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::PushOnOpenWebUrl` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CodeActionLinkOnly` 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::PushOnOpenWebUrl`. 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::CodeActionLinkOnly`. 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
       }
@@ -88,8 +86,8 @@ module KlaviyoAPI
         self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'web_url')
-        self.web_url = attributes[:'web_url']
+      if attributes.key?(:'links')
+        self.links = attributes[:'links']
       end
     end
 
@@ -101,6 +99,10 @@ module KlaviyoAPI
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
+      if @links.nil?
+        invalid_properties.push('invalid value for "links", links cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -108,15 +110,16 @@ module KlaviyoAPI
     # @return true if the model is valid
     def valid?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["open_web_url"])
+      type_validator = EnumAttributeValidator.new('String', ["code"])
       return false unless type_validator.valid?(@type)
+      return false if @links.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["open_web_url"])
+      validator = EnumAttributeValidator.new('String', ["code"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -129,7 +132,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          web_url == o.web_url
+          links == o.links
     end
 
     # @see the `==` method
@@ -141,7 +144,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, web_url].hash
+      [type, links].hash
     end
 
     # Builds the object from hash