klaviyo-api-sdk 10.0.0 → 11.1.0

data/lib/klaviyo-api-sdk/api_client.rb

@@ -32,7 +32,7 @@ module KlaviyoAPI
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "klaviyo-api-ruby/10.0.0"
+      @user_agent = "klaviyo-api-ruby/11.1.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/klaviyo-api-sdk/configuration.rb

@@ -215,15 +215,24 @@ module KlaviyoAPI
 
     # Returns Auth Settings hash for api client.
     def auth_settings
-      {
-        'Klaviyo-API-Key' =>
-          {
-            type: 'api_key',
-            in: 'header',
-            key: 'Authorization',
-            value: api_key_with_prefix('Klaviyo-API-Key')
-          },
-      }
+      auth = {}
+      if api_key_with_prefix('Klaviyo-API-Key')
+        auth['Klaviyo-API-Key'] = {
+          type: 'api_key',
+          in: 'header',
+          key: 'Authorization',
+          value: api_key_with_prefix('Klaviyo-API-Key')
+        }
+      end
+      if access_token
+        auth['OAuth'] = {
+          type: 'oauth2',
+          in: 'header',
+          key: 'Authorization',
+          value: "Bearer #{access_token}"
+        }
+      end
+      auth
     end
 
     # Returns an array of Server setting

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

@@ -18,6 +18,28 @@ module KlaviyoAPI
     # The action you would like to take with this send job from among 'cancel' and 'revert'
     attr_accessor :action
 
+    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
       {
@@ -78,9 +100,21 @@ module KlaviyoAPI
     # @return true if the model is valid
     def valid?
       return false if @action.nil?
+      action_validator = EnumAttributeValidator.new('String', ["cancel", "revert"])
+      return false unless action_validator.valid?(@action)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action Object to be assigned
+    def action=(action)
+      validator = EnumAttributeValidator.new('String', ["cancel", "revert"])
+      unless validator.valid?(action)
+        fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
+      end
+      @action = action
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

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

@@ -206,7 +206,7 @@ module KlaviyoAPI
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      klaviyo_sdk_validator = EnumAttributeValidator.new('String', ["android", "react_native", "swift"])
+      klaviyo_sdk_validator = EnumAttributeValidator.new('String', ["android", "flutter_community", "react_native", "swift"])
       return false unless klaviyo_sdk_validator.valid?(@klaviyo_sdk)
       os_name_validator = EnumAttributeValidator.new('String', ["android", "ios", "ipados", "macos", "tvos"])
       return false unless os_name_validator.valid?(@os_name)
@@ -218,7 +218,7 @@ module KlaviyoAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] klaviyo_sdk Object to be assigned
     def klaviyo_sdk=(klaviyo_sdk)
-      validator = EnumAttributeValidator.new('String', ["android", "react_native", "swift"])
+      validator = EnumAttributeValidator.new('String', ["android", "flutter_community", "react_native", "swift"])
       unless validator.valid?(klaviyo_sdk)
         fail ArgumentError, "invalid value for \"klaviyo_sdk\", must be one of #{validator.allowable_values}."
       end

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

@@ -0,0 +1,224 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2024-10-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 EmailUnsubscriptionParameters
+    attr_accessor :marketing
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'marketing' => :'marketing'
+      }
+    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
+      {
+        :'marketing' => :'UnsubscriptionParameters'
+      }
+    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::EmailUnsubscriptionParameters` 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::EmailUnsubscriptionParameters`. 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?(:'marketing')
+        self.marketing = attributes[:'marketing']
+      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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          marketing == o.marketing
+    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
+      [marketing].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/html_block_data.rb

@@ -19,14 +19,11 @@ module KlaviyoAPI
 
     attr_accessor :display_options
 
-    attr_accessor :styles
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'content' => :'content',
-        :'display_options' => :'display_options',
-        :'styles' => :'styles'
+        :'display_options' => :'display_options'
       }
     end
 
@@ -39,15 +36,13 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'content' => :'String',
-        :'display_options' => :'BlockDisplayOptions',
-        :'styles' => :'String'
+        :'display_options' => :'BlockDisplayOptions'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'styles'
       ])
     end
 
@@ -73,10 +68,6 @@ module KlaviyoAPI
       if attributes.key?(:'display_options')
         self.display_options = attributes[:'display_options']
       end
-
-      if attributes.key?(:'styles')
-        self.styles = attributes[:'styles']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -108,8 +99,7 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           content == o.content &&
-          display_options == o.display_options &&
-          styles == o.styles
+          display_options == o.display_options
     end
 
     # @see the `==` method
@@ -121,7 +111,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content, display_options, styles].hash
+      [content, display_options].hash
     end
 
     # Builds the object from hash

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

@@ -21,11 +21,14 @@ module KlaviyoAPI
     # The phone number to unsubscribe. This must be in E.164 format.
     attr_accessor :phone_number
 
+    attr_accessor :subscriptions
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'email' => :'email',
-        :'phone_number' => :'phone_number'
+        :'phone_number' => :'phone_number',
+        :'subscriptions' => :'subscriptions'
       }
     end
 
@@ -38,7 +41,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'email' => :'String',
-        :'phone_number' => :'String'
+        :'phone_number' => :'String',
+        :'subscriptions' => :'UnsubscriptionChannels'
       }
     end
 
@@ -46,7 +50,7 @@ module KlaviyoAPI
     def self.openapi_nullable
       Set.new([
         :'email',
-        :'phone_number'
+        :'phone_number',
       ])
     end
 
@@ -72,6 +76,10 @@ module KlaviyoAPI
       if attributes.key?(:'phone_number')
         self.phone_number = attributes[:'phone_number']
       end
+
+      if attributes.key?(:'subscriptions')
+        self.subscriptions = attributes[:'subscriptions']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -93,7 +101,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           email == o.email &&
-          phone_number == o.phone_number
+          phone_number == o.phone_number &&
+          subscriptions == o.subscriptions
     end
 
     # @see the `==` method
@@ -105,7 +114,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, phone_number].hash
+      [email, phone_number, subscriptions].hash
     end
 
     # Builds the object from hash

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

@@ -17,10 +17,13 @@ module KlaviyoAPI
   class SMSSubscriptionParameters
     attr_accessor :marketing
 
+    attr_accessor :transactional
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'marketing' => :'marketing'
+        :'marketing' => :'marketing',
+        :'transactional' => :'transactional'
       }
     end
 
@@ -32,7 +35,8 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'marketing' => :'SubscriptionParameters'
+        :'marketing' => :'SubscriptionParameters',
+        :'transactional' => :'SubscriptionParameters'
       }
     end
 
@@ -60,6 +64,10 @@ module KlaviyoAPI
       if attributes.key?(:'marketing')
         self.marketing = attributes[:'marketing']
       end
+
+      if attributes.key?(:'transactional')
+        self.transactional = attributes[:'transactional']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -80,7 +88,8 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          marketing == o.marketing
+          marketing == o.marketing &&
+          transactional == o.transactional
     end
 
     # @see the `==` method
@@ -92,7 +101,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [marketing].hash
+      [marketing, transactional].hash
     end
 
     # Builds the object from hash