klaviyo-api-sdk 10.0.0 → 11.1.0

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

@@ -0,0 +1,259 @@
+=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 UnsubscriptionParameters
+    # The Consent status to be set as part of the unsubscribe call. Currently supports \"UNSUBSCRIBED\".
+    attr_accessor :consent
+
+    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
+      {
+        :'consent' => :'consent'
+      }
+    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
+      {
+        :'consent' => :'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::UnsubscriptionParameters` 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::UnsubscriptionParameters`. 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?(:'consent')
+        self.consent = attributes[:'consent']
+      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 @consent.nil?
+        invalid_properties.push('invalid value for "consent", consent 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 @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] 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
+      @consent = consent
+    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 &&
+          consent == o.consent
+    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
+      [consent].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.rb

@@ -213,6 +213,7 @@ require 'klaviyo-api-sdk/models/email_send_options_sub_object'
 require 'klaviyo-api-sdk/models/email_subscription_parameters'
 require 'klaviyo-api-sdk/models/email_tracking_options_sub_object'
 require 'klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner'
+require 'klaviyo-api-sdk/models/email_unsubscription_parameters'
 require 'klaviyo-api-sdk/models/equals_enum'
 require 'klaviyo-api-sdk/models/equals_string_filter'
 require 'klaviyo-api-sdk/models/event_bulk_create_enum'
@@ -447,6 +448,7 @@ require 'klaviyo-api-sdk/models/sms_content_sub_object_create'
 require 'klaviyo-api-sdk/models/sms_send_options_sub_object'
 require 'klaviyo-api-sdk/models/sms_subscription_parameters'
 require 'klaviyo-api-sdk/models/sms_tracking_options_sub_object'
+require 'klaviyo-api-sdk/models/sms_unsubscription_parameters'
 require 'klaviyo-api-sdk/models/sto_schedule_options'
 require 'klaviyo-api-sdk/models/segment_create_query'
 require 'klaviyo-api-sdk/models/segment_create_query_resource_object'
@@ -590,6 +592,8 @@ require 'klaviyo-api-sdk/models/universal_content_partial_update_query_resource_
 require 'klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes'
 require 'klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition'
 require 'klaviyo-api-sdk/models/unsubscribed_enum'
+require 'klaviyo-api-sdk/models/unsubscription_channels'
+require 'klaviyo-api-sdk/models/unsubscription_parameters'
 require 'klaviyo-api-sdk/models/webhook_create_query'
 require 'klaviyo-api-sdk/models/webhook_create_query_resource_object'
 require 'klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes'
@@ -660,25 +664,10 @@ module KlaviyoAPI
             # recreate methods
             original_class.public_instance_methods(false).each do |m|
               wrapper_class.class_eval { 
-                define_singleton_method m do |*arg| 
-                  # max_delay=60, max_retries=3
-                  # retry_codes = [429,503,504]
-                  # only add retriable if both of these are not set
-                  max_retries = Configuration.default.max_retries
-                  max_delay = Configuration.default.max_delay
-
-                  if (max_retries != nil && max_delay != nil)
-                    Retriable.configure do |c|
-                      c.tries = max_retries
-                      c.max_elapsed_time = max_delay
-                      c.on = {
-                        KlaviyoAPI::ApiError => [/429/, /503/, /504/]
-                      }
-                    end
-                    Retriable.retriable do
-                      KlaviyoAPI.const_get(c).new.send(m, *arg)
-                    end
-                  else
+                define_singleton_method m do |*arg|
+                  max_retries = Configuration.default.max_retries || 3
+                  max_delay = Configuration.default.max_delay || 60
+                  KlaviyoAPI.with_retry(max_retries, max_delay) do
                     KlaviyoAPI.const_get(c).new.send(m, *arg)
                   end
                 end
@@ -689,5 +678,33 @@ module KlaviyoAPI
         @is_initialized = true
       end
     end
+
+    def with_retry(tries, max_elapsed_time)
+      start_time = Time.now
+      elapsed_time = -> { Time.now - start_time }
+      last_request_retry_after = nil
+      last_request_timestamp = nil
+      index = 0
+      attempt = 0
+      last_exception = nil
+      while true
+        begin
+          retry_after_value_elapsed = last_request_retry_after == nil || Time.now - last_request_timestamp > Integer(last_request_retry_after)
+          if retry_after_value_elapsed
+              attempt += 1
+              return yield
+          end
+        rescue KlaviyoAPI::ApiError => exception
+          last_exception = exception
+          last_request_retry_after = exception.response_headers[:'Retry-After']
+          last_request_timestamp = Time.now
+          raise unless [429, 503, 504, 524].include? exception.code
+        end
+        interval = Retriable::ExponentialBackoff.new(tries: index + 1).intervals[index]
+        raise last_exception if attempt >= tries || (elapsed_time.call + interval) > max_elapsed_time
+        sleep interval
+        index += 1
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo-api-sdk
 version: !ruby/object:Gem::Version
-  version: 10.0.0
+  version: 11.1.0
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retriable
@@ -825,6 +825,7 @@ files:
 - lib/klaviyo-api-sdk/models/email_subscription_parameters.rb
 - lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb
 - lib/klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner.rb
+- lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb
 - lib/klaviyo-api-sdk/models/equals_enum.rb
 - lib/klaviyo-api-sdk/models/equals_string_filter.rb
 - lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb
@@ -1090,6 +1091,7 @@ files:
 - lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb
 - lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb
 - lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb
+- lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb
 - lib/klaviyo-api-sdk/models/spam_complaint_enum.rb
 - lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb
 - lib/klaviyo-api-sdk/models/static_date_filter.rb
@@ -1202,6 +1204,8 @@ files:
 - lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb
 - lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb
 - lib/klaviyo-api-sdk/models/unsubscribed_enum.rb
+- lib/klaviyo-api-sdk/models/unsubscription_channels.rb
+- lib/klaviyo-api-sdk/models/unsubscription_parameters.rb
 - lib/klaviyo-api-sdk/models/webhook_create_query.rb
 - lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb
 - lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb