v11.0.0 (#32)

* version 11.0.0

* Update CHANGELOG.md

---------

Co-authored-by: klaviyo-sdk <[email protected]>
Co-authored-by: Ben Horgan <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [11.0.0] - revision 2024-10-15
+### Changed
+  - Improved Retry Logic
+    - To address 429 status codes, we have modified the retry logic to use exponential backoff and the `Retry-After` header.
+    - **Breaking:** Retry logic is now enabled by default. To disable it, set `config.max_retries` to `0`.
+
 ## [10.0.0] - 2024-10-15
 ### Added
 - Universal Content API

README.md

@@ -1,6 +1,6 @@
 # Klaviyo Ruby SDK
 
-- SDK version: 10.0.0
+- SDK version: 11.0.0
 - API revision: 2024-10-15
 
 ## Helpful Resources
@@ -110,13 +110,13 @@ gem build klaviyo-api-sdk.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./klaviyo-api-sdk-10.0.0.gem
+gem install ./klaviyo-api-sdk-11.0.0.gem
 ```
 
 
 Finally add this to the Gemfile:
 
-    gem 'klaviyo-api-sdk', '~> 10.0.0'
+    gem 'klaviyo-api-sdk', '~> 11.0.0'
 
 To install directly from rubygems:
 
@@ -152,8 +152,10 @@ end
 
 NOTE: 
 * The SDK retries on resolvable errors, namely: rate limits (common) and server errors on klaviyo (rare).
-* `max_retry` denotes number of attempts the client will make in order to execute the request successfully.
-* `max_delay` denotes total delay (in seconds) across all attempts.
+* `max_retries` denotes the number of attempts the client will make in order to execute the request successfully.
+  * Set to 0 to disable automatic retries
+* `max_delay` denotes the maximum amount of time (in seconds) that will be spent retrying a request across all attempts.
+* The time interval between retries is calculated using exponential backoff and the `Retry-After` header.
 
 ### To call the `get_catalog_items` operation:
 
@@ -2619,11 +2621,11 @@ KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body)
 #### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/create_or_update_profile)
 
 ```ruby
-KlaviyoAPI::Profiles.create_or_update_profile(body)
+KlaviyoAPI::Profiles.create_or_update_profile(body, opts)
 ```
 ##### Method alias:
 ```ruby
-KlaviyoAPI::Profiles.create_profile_import(body)
+KlaviyoAPI::Profiles.create_profile_import(body, opts)
 ```
 
 
@@ -2633,7 +2635,7 @@ KlaviyoAPI::Profiles.create_profile_import(body)
 #### [Create Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/create_profile)
 
 ```ruby
-KlaviyoAPI::Profiles.create_profile(body)
+KlaviyoAPI::Profiles.create_profile(body, opts)
 ```
 
 
@@ -2943,7 +2945,7 @@ KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
 #### [Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/update_profile)
 
 ```ruby
-KlaviyoAPI::Profiles.update_profile(id, body)
+KlaviyoAPI::Profiles.update_profile(id, body, opts)
 ```
 
 

klaviyo-api-sdk.gemspec

@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
 
 Gem::Specification.new do |s|
   s.name        = "klaviyo-api-sdk"
-  s.version     = "10.0.0"
+  s.version     = "11.0.0"
   s.authors     = ['Klaviyo Team']
   s.email       = ['[email protected]']
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'

lib/klaviyo-api-sdk.rb

@@ -660,25 +660,10 @@ def configure
             # 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 +674,33 @@ def configure
         @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

lib/klaviyo-api-sdk/api/profiles_api.rb

@@ -351,6 +351,7 @@ def bulk_unsuppress_profiles_with_http_info(suppression_delete_job_create_query,
     # Given a set of profile attributes and optionally an ID, create or update a profile.  Returns 201 if a new profile was created, 200 if an existing profile was updated.  Note that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:write`
     # @param profile_upsert_query [ProfileUpsertQuery] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
     # @return [Hash<String, Object>]
     def create_or_update_profile(profile_upsert_query, opts = {})
       data, _status_code, _headers = create_or_update_profile_with_http_info(profile_upsert_query, opts)
@@ -364,6 +365,7 @@ def create_or_update_profile(profile_upsert_query, opts = {})
     # Given a set of profile attributes and optionally an ID, create or update a profile.  Returns 201 if a new profile was created, 200 if an existing profile was updated.  Note that setting a field to &#x60;null&#x60; will clear out the field, whereas not including a field in your request will leave it unchanged.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;  **Scopes:** &#x60;profiles:write&#x60;
     # @param profile_upsert_query [ProfileUpsertQuery] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
     # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
     def create_or_update_profile_with_http_info(profile_upsert_query, opts = {})
       if @api_client.config.debugging
@@ -373,11 +375,16 @@ def create_or_update_profile_with_http_info(profile_upsert_query, opts = {})
       if @api_client.config.client_side_validation && profile_upsert_query.nil?
         fail ArgumentError, "Missing the required parameter 'profile_upsert_query' when calling ProfilesApi.create_or_update_profile"
       end
+      allowable_values = ["subscriptions", "predictive_analytics"]
+      if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/api/profile-import'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -427,6 +434,7 @@ def create_or_update_profile_with_http_info(profile_upsert_query, opts = {})
     # Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:write`
     # @param profile_create_query [ProfileCreateQuery] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
     # @return [Hash<String, Object>]
     def create_profile(profile_create_query, opts = {})
       data, _status_code, _headers = create_profile_with_http_info(profile_create_query, opts)
@@ -437,6 +445,7 @@ def create_profile(profile_create_query, opts = {})
     # Create a new profile.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;  **Scopes:** &#x60;profiles:write&#x60;
     # @param profile_create_query [ProfileCreateQuery] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
     # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
     def create_profile_with_http_info(profile_create_query, opts = {})
       if @api_client.config.debugging
@@ -446,11 +455,16 @@ def create_profile_with_http_info(profile_create_query, opts = {})
       if @api_client.config.client_side_validation && profile_create_query.nil?
         fail ArgumentError, "Missing the required parameter 'profile_create_query' when calling ProfilesApi.create_profile"
       end
+      allowable_values = ["subscriptions", "predictive_analytics"]
+      if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/api/profiles'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -1498,7 +1512,7 @@ def get_lists_for_profile_with_http_info(id, opts = {})
     alias get_profile_lists_with_http_info get_lists_for_profile_with_http_info
 
     # Get Profile
-    # Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `profiles:read`
+    # Get the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-10-15/docs/rate_limits_and_error_handling) guide.  **Scopes:** `profiles:read`
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
@@ -1513,7 +1527,7 @@ def get_profile(id, opts = {})
     end
 
     # Get Profile
-    # Get the profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;  **Scopes:** &#x60;profiles:read&#x60;
+    # Get the profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;include&#x3D;list&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;include&#x3D;segment&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;include&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-10-15/docs/rate_limits_and_error_handling) guide.  **Scopes:** &#x60;profiles:read&#x60;
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
@@ -2202,6 +2216,7 @@ def spawn_bulk_profile_import_job_with_http_info(profile_import_job_create_query
     # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
     # @param profile_partial_update_query [ProfilePartialUpdateQuery] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
     # @return [Hash<String, Object>]
     def update_profile(id, profile_partial_update_query, opts = {})
       data, _status_code, _headers = update_profile_with_http_info(id, profile_partial_update_query, opts)
@@ -2213,6 +2228,7 @@ def update_profile(id, profile_partial_update_query, opts = {})
     # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
     # @param profile_partial_update_query [ProfilePartialUpdateQuery] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
     # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
     def update_profile_with_http_info(id, profile_partial_update_query, opts = {})
       if @api_client.config.debugging
@@ -2226,11 +2242,16 @@ def update_profile_with_http_info(id, profile_partial_update_query, opts = {})
       if @api_client.config.client_side_validation && profile_partial_update_query.nil?
         fail ArgumentError, "Missing the required parameter 'profile_partial_update_query' when calling ProfilesApi.update_profile"
       end
+      allowable_values = ["subscriptions", "predictive_analytics"]
+      if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/api/profiles/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'additional-fields[profile]'] = @api_client.build_collection_param(opts[:'additional_fields_profile'], :csv) if !opts[:'additional_fields_profile'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

lib/klaviyo-api-sdk/api_client.rb

@@ -32,7 +32,7 @@ class ApiClient
     # @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.0.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

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

@@ -206,7 +206,7 @@ def list_invalid_properties
     # 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 @@ def valid?
     # 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

lib/klaviyo-api-sdk/models/html_block_data.rb

@@ -19,14 +19,11 @@ class HTMLBlockData
 
     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 @@ def self.acceptable_attributes
     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 @@ def initialize(attributes = {})
       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 @@ def ==(o)
       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 @@ def eql?(o)
     # 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