klaviyo-api-sdk 13.0.1 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +434 -286
  4. data/klaviyo-api-sdk.gemspec +1 -1
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +82 -82
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +235 -235
  8. data/lib/klaviyo-api-sdk/api/coupons_api.rb +63 -63
  9. data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +384 -0
  10. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
  11. data/lib/klaviyo-api-sdk/api/events_api.rb +34 -34
  12. data/lib/klaviyo-api-sdk/api/flows_api.rb +93 -93
  13. data/lib/klaviyo-api-sdk/api/forms_api.rb +40 -40
  14. data/lib/klaviyo-api-sdk/api/images_api.rb +15 -15
  15. data/lib/klaviyo-api-sdk/api/lists_api.rb +59 -59
  16. data/lib/klaviyo-api-sdk/api/metrics_api.rb +643 -59
  17. data/lib/klaviyo-api-sdk/api/profiles_api.rb +128 -128
  18. data/lib/klaviyo-api-sdk/api/reporting_api.rb +13 -13
  19. data/lib/klaviyo-api-sdk/api/reviews_api.rb +21 -21
  20. data/lib/klaviyo-api-sdk/api/segments_api.rb +53 -53
  21. data/lib/klaviyo-api-sdk/api/tags_api.rb +58 -58
  22. data/lib/klaviyo-api-sdk/api/templates_api.rb +36 -36
  23. data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +15 -15
  24. data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +15 -15
  25. data/lib/klaviyo-api-sdk/api/webhooks_api.rb +15 -15
  26. data/lib/klaviyo-api-sdk/api_client.rb +1 -1
  27. data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +1 -1
  28. data/lib/klaviyo-api-sdk/models/button_block.rb +247 -0
  29. data/lib/klaviyo-api-sdk/models/{custom_object_property_enum.rb → button_enum.rb} +4 -4
  30. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
  31. data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +3 -0
  32. data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
  33. data/lib/klaviyo-api-sdk/models/data_source_create_query.rb +223 -0
  34. data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object.rb +237 -0
  35. data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object_attributes.rb +284 -0
  36. data/lib/klaviyo-api-sdk/models/data_source_enum.rb +35 -0
  37. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query.rb +223 -0
  38. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +246 -0
  39. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +219 -0
  40. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +218 -0
  41. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships_data_source.rb +218 -0
  42. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_enum.rb +35 -0
  43. data/lib/klaviyo-api-sdk/models/data_source_record_enum.rb +35 -0
  44. data/lib/klaviyo-api-sdk/models/data_source_record_resource_object.rb +237 -0
  45. data/lib/klaviyo-api-sdk/models/data_source_record_resource_object_attributes.rb +223 -0
  46. data/lib/klaviyo-api-sdk/models/drop_shadow_block.rb +247 -0
  47. data/lib/klaviyo-api-sdk/models/drop_shadow_enum.rb +35 -0
  48. data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter.rb → dsr_bulk_create_attrs_data_source_records.rb} +15 -14
  49. data/lib/klaviyo-api-sdk/models/dsr_bulk_create_rels_data_source_data.rb +238 -0
  50. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
  51. data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
  52. data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
  53. data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
  54. data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
  55. data/lib/klaviyo-api-sdk/models/horizontal_rule_block.rb +247 -0
  56. data/lib/klaviyo-api-sdk/models/horizontal_rule_enum.rb +35 -0
  57. data/lib/klaviyo-api-sdk/models/image_block.rb +247 -0
  58. data/lib/klaviyo-api-sdk/models/mapped_metric_enum.rb +35 -0
  59. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query.rb +223 -0
  60. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object.rb +281 -0
  61. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships.rb +227 -0
  62. data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter_condition_groups_inner.rb → mapped_metric_partial_update_query_resource_object_relationships_custom_metric.rb} +10 -17
  63. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_custom_metric_data.rb +238 -0
  64. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_metric.rb +218 -0
  65. data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_metric_data.rb +238 -0
  66. data/lib/klaviyo-api-sdk/models/priority_enum.rb +35 -0
  67. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +327 -0
  68. data/lib/klaviyo-api-sdk/models/{custom_object_property_condition.rb → profile_predictive_analytics_channel_affinity_priority_filter.rb} +23 -37
  69. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +327 -0
  70. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_filter.rb +286 -0
  71. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_date_condition.rb +286 -0
  72. data/lib/klaviyo-api-sdk/models/rank_enum.rb +35 -0
  73. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/spacer_block.rb +247 -0
  75. data/lib/klaviyo-api-sdk/models/spacer_enum.rb +35 -0
  76. data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +6 -2
  77. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +5 -0
  78. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +5 -0
  79. data/lib/klaviyo-api-sdk.rb +40 -5
  80. data/lib/klaviyo-api-sdk.rb.bak +974 -0
  81. metadata +43 -7
  82. data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter_condition_groups_inner_conditions_inner.rb +0 -106
@@ -53,7 +53,7 @@ module KlaviyoAPI
53
53
  # header parameters
54
54
  header_params = opts[:header_params] || {}
55
55
  # klaviyo api revision
56
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
56
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
57
57
  # HTTP header 'Accept' (if needed)
58
58
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
59
59
  # HTTP header 'Content-Type'
@@ -126,7 +126,7 @@ module KlaviyoAPI
126
126
  # header parameters
127
127
  header_params = opts[:header_params] || {}
128
128
  # klaviyo api revision
129
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
129
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
130
130
  # HTTP header 'Accept' (if needed)
131
131
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
132
132
  # HTTP header 'Content-Type'
@@ -165,7 +165,7 @@ module KlaviyoAPI
165
165
  end
166
166
 
167
167
  # Create Universal Content
168
- # Create universal content. Only text blocks, which can include text or HTML, are supported at this time.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write`
168
+ # Create universal content. Currently supported block types are: `button`, `drop_shadow`, `horizontal_rule`, `html`, `image`, `spacer`, and `text`.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write`
169
169
  # @param universal_content_create_query [UniversalContentCreateQuery] Create a template universal content
170
170
  # @param [Hash] opts the optional parameters
171
171
  # @return [Hash<String, Object>]
@@ -178,7 +178,7 @@ module KlaviyoAPI
178
178
  alias create_template_universal_content create_universal_content
179
179
 
180
180
  # Create Universal Content
181
- # Create universal content. Only text blocks, which can include text or HTML, are supported at this time.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;templates:write&#x60;
181
+ # Create universal content. Currently supported block types are: &#x60;button&#x60;, &#x60;drop_shadow&#x60;, &#x60;horizontal_rule&#x60;, &#x60;html&#x60;, &#x60;image&#x60;, &#x60;spacer&#x60;, and &#x60;text&#x60;.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;templates:write&#x60;
182
182
  # @param universal_content_create_query [UniversalContentCreateQuery] Create a template universal content
183
183
  # @param [Hash] opts the optional parameters
184
184
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -199,7 +199,7 @@ module KlaviyoAPI
199
199
  # header parameters
200
200
  header_params = opts[:header_params] || {}
201
201
  # klaviyo api revision
202
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
202
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
203
203
  # HTTP header 'Accept' (if needed)
204
204
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
205
205
  # HTTP header 'Content-Type'
@@ -272,7 +272,7 @@ module KlaviyoAPI
272
272
  # header parameters
273
273
  header_params = opts[:header_params] || {}
274
274
  # klaviyo api revision
275
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
275
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
276
276
  # HTTP header 'Accept' (if needed)
277
277
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
278
278
 
@@ -340,7 +340,7 @@ module KlaviyoAPI
340
340
  # header parameters
341
341
  header_params = opts[:header_params] || {}
342
342
  # klaviyo api revision
343
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
343
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
344
344
  # HTTP header 'Accept' (if needed)
345
345
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
346
346
 
@@ -379,11 +379,11 @@ module KlaviyoAPI
379
379
  # Get All Universal Content
380
380
  # Get all universal content in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read`
381
381
  # @param [Hash] opts the optional parameters
382
- # @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
383
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;definition.content_type&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;definition.type&#x60;: &#x60;equals&#x60;
384
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
382
+ # @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
383
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;definition.content_type&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;definition.type&#x60;: &#x60;equals&#x60;
384
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
385
385
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
386
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
386
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
387
387
  # @return [Hash<String, Object>]
388
388
  def get_all_universal_content(opts = {})
389
389
  data, _status_code, _headers = get_all_universal_content_with_http_info(opts)
@@ -396,11 +396,11 @@ module KlaviyoAPI
396
396
  # Get All Universal Content
397
397
  # Get all universal content in an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;templates:read&#x60;
398
398
  # @param [Hash] opts the optional parameters
399
- # @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
400
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;definition.content_type&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;definition.type&#x60;: &#x60;equals&#x60;
401
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
399
+ # @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
400
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;definition.content_type&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;definition.type&#x60;: &#x60;equals&#x60;
401
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
402
402
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
403
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
403
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
404
404
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
405
405
  def get_all_universal_content_with_http_info(opts = {})
406
406
  if @api_client.config.debugging
@@ -436,7 +436,7 @@ module KlaviyoAPI
436
436
  # header parameters
437
437
  header_params = opts[:header_params] || {}
438
438
  # klaviyo api revision
439
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
439
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
440
440
  # HTTP header 'Accept' (if needed)
441
441
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
442
442
 
@@ -476,7 +476,7 @@ module KlaviyoAPI
476
476
  # Get a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read`
477
477
  # @param id [String] The ID of template
478
478
  # @param [Hash] opts the optional parameters
479
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
479
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
480
480
  # @return [Hash<String, Object>]
481
481
  def get_template(id, opts = {})
482
482
  data, _status_code, _headers = get_template_with_http_info(id, opts)
@@ -487,7 +487,7 @@ module KlaviyoAPI
487
487
  # Get a template with the given template ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;templates:read&#x60;
488
488
  # @param id [String] The ID of template
489
489
  # @param [Hash] opts the optional parameters
490
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
490
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
491
491
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
492
492
  def get_template_with_http_info(id, opts = {})
493
493
  if @api_client.config.debugging
@@ -511,7 +511,7 @@ module KlaviyoAPI
511
511
  # header parameters
512
512
  header_params = opts[:header_params] || {}
513
513
  # klaviyo api revision
514
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
514
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
515
515
  # HTTP header 'Accept' (if needed)
516
516
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
517
517
 
@@ -547,10 +547,10 @@ module KlaviyoAPI
547
547
  # Get Templates
548
548
  # Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read`
549
549
  # @param [Hash] opts the optional parameters
550
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
551
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
552
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
553
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
550
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
551
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
552
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
553
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
554
554
  # @return [Hash<String, Object>]
555
555
  def get_templates(opts = {})
556
556
  data, _status_code, _headers = get_templates_with_http_info(opts)
@@ -560,10 +560,10 @@ module KlaviyoAPI
560
560
  # Get Templates
561
561
  # Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, &#x60;updated&#x60; Returns a maximum of 10 results per page.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;templates:read&#x60;
562
562
  # @param [Hash] opts the optional parameters
563
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
564
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
565
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
566
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
563
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
564
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
565
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
566
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
567
567
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
568
568
  def get_templates_with_http_info(opts = {})
569
569
  if @api_client.config.debugging
@@ -590,7 +590,7 @@ module KlaviyoAPI
590
590
  # header parameters
591
591
  header_params = opts[:header_params] || {}
592
592
  # klaviyo api revision
593
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
593
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
594
594
  # HTTP header 'Accept' (if needed)
595
595
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
596
596
 
@@ -627,7 +627,7 @@ module KlaviyoAPI
627
627
  # Get the universal content with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read`
628
628
  # @param id [String] The ID of the universal content
629
629
  # @param [Hash] opts the optional parameters
630
- # @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
630
+ # @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
631
631
  # @return [Hash<String, Object>]
632
632
  def get_universal_content(id, opts = {})
633
633
  data, _status_code, _headers = get_universal_content_with_http_info(id, opts)
@@ -638,7 +638,7 @@ module KlaviyoAPI
638
638
  # Get the universal content with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;templates:read&#x60;
639
639
  # @param id [String] The ID of the universal content
640
640
  # @param [Hash] opts the optional parameters
641
- # @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
641
+ # @option opts [Array<String>] :fields_template_universal_content For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
642
642
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
643
643
  def get_universal_content_with_http_info(id, opts = {})
644
644
  if @api_client.config.debugging
@@ -662,7 +662,7 @@ module KlaviyoAPI
662
662
  # header parameters
663
663
  header_params = opts[:header_params] || {}
664
664
  # klaviyo api revision
665
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
665
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
666
666
  # HTTP header 'Accept' (if needed)
667
667
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
668
668
 
@@ -730,7 +730,7 @@ module KlaviyoAPI
730
730
  # header parameters
731
731
  header_params = opts[:header_params] || {}
732
732
  # klaviyo api revision
733
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
733
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
734
734
  # HTTP header 'Accept' (if needed)
735
735
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
736
736
  # HTTP header 'Content-Type'
@@ -809,7 +809,7 @@ module KlaviyoAPI
809
809
  # header parameters
810
810
  header_params = opts[:header_params] || {}
811
811
  # klaviyo api revision
812
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
812
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
813
813
  # HTTP header 'Accept' (if needed)
814
814
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
815
815
  # HTTP header 'Content-Type'
@@ -848,7 +848,7 @@ module KlaviyoAPI
848
848
  end
849
849
 
850
850
  # Update Universal Content
851
- # Update universal content. The `definition` field can only be updated for text blocks at this time.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write`
851
+ # Update universal content. The `definition` field can only be updated on the following block types at this time: `button`, `drop_shadow`, `horizontal_rule`, `html`, `image`, `spacer`, and `text`.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:write`
852
852
  # @param id [String] The ID of the template universal content
853
853
  # @param universal_content_partial_update_query [UniversalContentPartialUpdateQuery] Update a universal content by ID
854
854
  # @param [Hash] opts the optional parameters
@@ -862,7 +862,7 @@ module KlaviyoAPI
862
862
  alias update_template_universal_content update_universal_content
863
863
 
864
864
  # Update Universal Content
865
- # Update universal content. The &#x60;definition&#x60; field can only be updated for text blocks at this time.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;templates:write&#x60;
865
+ # Update universal content. The &#x60;definition&#x60; field can only be updated on the following block types at this time: &#x60;button&#x60;, &#x60;drop_shadow&#x60;, &#x60;horizontal_rule&#x60;, &#x60;html&#x60;, &#x60;image&#x60;, &#x60;spacer&#x60;, and &#x60;text&#x60;.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;templates:write&#x60;
866
866
  # @param id [String] The ID of the template universal content
867
867
  # @param universal_content_partial_update_query [UniversalContentPartialUpdateQuery] Update a universal content by ID
868
868
  # @param [Hash] opts the optional parameters
@@ -888,7 +888,7 @@ module KlaviyoAPI
888
888
  # header parameters
889
889
  header_params = opts[:header_params] || {}
890
890
  # klaviyo api revision
891
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
891
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
892
892
  # HTTP header 'Accept' (if needed)
893
893
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
894
894
  # HTTP header 'Content-Type'
@@ -19,10 +19,10 @@ module KlaviyoAPI
19
19
  @api_client = api_client
20
20
  end
21
21
  # Get Tracking Setting
22
- # Get the tracking setting with the given account ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read`
22
+ # Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read`
23
23
  # @param id [String] The id of the tracking setting (account ID).
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
25
+ # @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
26
26
  # @return [Hash<String, Object>]
27
27
  def get_tracking_setting(id, opts = {})
28
28
  data, _status_code, _headers = get_tracking_setting_with_http_info(id, opts)
@@ -30,10 +30,10 @@ module KlaviyoAPI
30
30
  end
31
31
 
32
32
  # Get Tracking Setting
33
- # Get the tracking setting with the given account ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;tracking-settings:read&#x60;
33
+ # Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;tracking-settings:read&#x60;
34
34
  # @param id [String] The id of the tracking setting (account ID).
35
35
  # @param [Hash] opts the optional parameters
36
- # @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
36
+ # @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
37
37
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
38
38
  def get_tracking_setting_with_http_info(id, opts = {})
39
39
  if @api_client.config.debugging
@@ -57,7 +57,7 @@ module KlaviyoAPI
57
57
  # header parameters
58
58
  header_params = opts[:header_params] || {}
59
59
  # klaviyo api revision
60
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
60
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
61
61
  # HTTP header 'Accept' (if needed)
62
62
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
63
63
 
@@ -91,10 +91,10 @@ module KlaviyoAPI
91
91
  end
92
92
 
93
93
  # Get Tracking Settings
94
- # Get all tracking settings in an account. Returns an array with a single tracking setting.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read`
94
+ # Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:read`
95
95
  # @param [Hash] opts the optional parameters
96
- # @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
97
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
96
+ # @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
97
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
98
98
  # @option opts [Integer] :page_size Default: 1. Min: 1. Max: 1. (default to 1)
99
99
  # @return [Hash<String, Object>]
100
100
  def get_tracking_settings(opts = {})
@@ -103,10 +103,10 @@ module KlaviyoAPI
103
103
  end
104
104
 
105
105
  # Get Tracking Settings
106
- # Get all tracking settings in an account. Returns an array with a single tracking setting.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;tracking-settings:read&#x60;
106
+ # Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;tracking-settings:read&#x60;
107
107
  # @param [Hash] opts the optional parameters
108
- # @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
109
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
108
+ # @option opts [Array<String>] :fields_tracking_setting For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
109
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
110
110
  # @option opts [Integer] :page_size Default: 1. Min: 1. Max: 1. (default to 1)
111
111
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
112
112
  def get_tracking_settings_with_http_info(opts = {})
@@ -137,7 +137,7 @@ module KlaviyoAPI
137
137
  # header parameters
138
138
  header_params = opts[:header_params] || {}
139
139
  # klaviyo api revision
140
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
140
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
141
141
  # HTTP header 'Accept' (if needed)
142
142
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
143
143
 
@@ -171,7 +171,7 @@ module KlaviyoAPI
171
171
  end
172
172
 
173
173
  # Update Tracking Setting
174
- # Update the tracking setting with the given account ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:write`
174
+ # Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `tracking-settings:write`
175
175
  # @param id [String] The id of the tracking setting (account ID).
176
176
  # @param tracking_setting_partial_update_query [TrackingSettingPartialUpdateQuery] DTO for updating tracking settings
177
177
  # @param [Hash] opts the optional parameters
@@ -182,7 +182,7 @@ module KlaviyoAPI
182
182
  end
183
183
 
184
184
  # Update Tracking Setting
185
- # Update the tracking setting with the given account ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;tracking-settings:write&#x60;
185
+ # Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;tracking-settings:write&#x60;
186
186
  # @param id [String] The id of the tracking setting (account ID).
187
187
  # @param tracking_setting_partial_update_query [TrackingSettingPartialUpdateQuery] DTO for updating tracking settings
188
188
  # @param [Hash] opts the optional parameters
@@ -208,7 +208,7 @@ module KlaviyoAPI
208
208
  # header parameters
209
209
  header_params = opts[:header_params] || {}
210
210
  # klaviyo api revision
211
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
211
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
212
212
  # HTTP header 'Accept' (if needed)
213
213
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
214
214
  # HTTP header 'Content-Type'
@@ -50,7 +50,7 @@ module KlaviyoAPI
50
50
  # header parameters
51
51
  header_params = opts[:header_params] || {}
52
52
  # klaviyo api revision
53
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
53
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
54
54
  # HTTP header 'Accept' (if needed)
55
55
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
56
56
  # HTTP header 'Content-Type'
@@ -120,7 +120,7 @@ module KlaviyoAPI
120
120
  # header parameters
121
121
  header_params = opts[:header_params] || {}
122
122
  # klaviyo api revision
123
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
123
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
124
124
  # HTTP header 'Accept' (if needed)
125
125
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
126
126
 
@@ -157,7 +157,7 @@ module KlaviyoAPI
157
157
  # Get the web feed with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read`
158
158
  # @param id [String] The ID of the web feed
159
159
  # @param [Hash] opts the optional parameters
160
- # @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
160
+ # @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
161
161
  # @return [Hash<String, Object>]
162
162
  def get_web_feed(id, opts = {})
163
163
  data, _status_code, _headers = get_web_feed_with_http_info(id, opts)
@@ -168,7 +168,7 @@ module KlaviyoAPI
168
168
  # Get the web feed with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;web-feeds:read&#x60;
169
169
  # @param id [String] The ID of the web feed
170
170
  # @param [Hash] opts the optional parameters
171
- # @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
171
+ # @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
172
172
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
173
173
  def get_web_feed_with_http_info(id, opts = {})
174
174
  if @api_client.config.debugging
@@ -192,7 +192,7 @@ module KlaviyoAPI
192
192
  # header parameters
193
193
  header_params = opts[:header_params] || {}
194
194
  # klaviyo api revision
195
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
195
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
196
196
  # HTTP header 'Accept' (if needed)
197
197
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
198
198
 
@@ -228,11 +228,11 @@ module KlaviyoAPI
228
228
  # Get Web Feeds
229
229
  # Get all web feeds for an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `web-feeds:read`
230
230
  # @param [Hash] opts the optional parameters
231
- # @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
232
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
233
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
231
+ # @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
232
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
233
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
234
234
  # @option opts [Integer] :page_size Default: 5. Min: 1. Max: 20. (default to 5)
235
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
235
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
236
236
  # @return [Hash<String, Object>]
237
237
  def get_web_feeds(opts = {})
238
238
  data, _status_code, _headers = get_web_feeds_with_http_info(opts)
@@ -242,11 +242,11 @@ module KlaviyoAPI
242
242
  # Get Web Feeds
243
243
  # Get all web feeds for an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;web-feeds:read&#x60;
244
244
  # @param [Hash] opts the optional parameters
245
- # @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
246
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
247
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
245
+ # @option opts [Array<String>] :fields_web_feed For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
246
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
247
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
248
248
  # @option opts [Integer] :page_size Default: 5. Min: 1. Max: 20. (default to 5)
249
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
249
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
250
250
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
251
251
  def get_web_feeds_with_http_info(opts = {})
252
252
  if @api_client.config.debugging
@@ -282,7 +282,7 @@ module KlaviyoAPI
282
282
  # header parameters
283
283
  header_params = opts[:header_params] || {}
284
284
  # klaviyo api revision
285
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
285
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
286
286
  # HTTP header 'Accept' (if needed)
287
287
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
288
288
 
@@ -353,7 +353,7 @@ module KlaviyoAPI
353
353
  # header parameters
354
354
  header_params = opts[:header_params] || {}
355
355
  # klaviyo api revision
356
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
356
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
357
357
  # HTTP header 'Accept' (if needed)
358
358
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
359
359
  # HTTP header 'Content-Type'
@@ -50,7 +50,7 @@ module KlaviyoAPI
50
50
  # header parameters
51
51
  header_params = opts[:header_params] || {}
52
52
  # klaviyo api revision
53
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
53
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
54
54
  # HTTP header 'Accept' (if needed)
55
55
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
56
56
  # HTTP header 'Content-Type'
@@ -120,7 +120,7 @@ module KlaviyoAPI
120
120
  # header parameters
121
121
  header_params = opts[:header_params] || {}
122
122
  # klaviyo api revision
123
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
123
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
124
124
  # HTTP header 'Accept' (if needed)
125
125
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
126
126
 
@@ -157,8 +157,8 @@ module KlaviyoAPI
157
157
  # Get the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read`
158
158
  # @param id [String] The ID of the webhook.
159
159
  # @param [Hash] opts the optional parameters
160
- # @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
161
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
160
+ # @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
161
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
162
162
  # @return [Hash<String, Object>]
163
163
  def get_webhook(id, opts = {})
164
164
  data, _status_code, _headers = get_webhook_with_http_info(id, opts)
@@ -169,8 +169,8 @@ module KlaviyoAPI
169
169
  # Get the webhook with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;webhooks:read&#x60;
170
170
  # @param id [String] The ID of the webhook.
171
171
  # @param [Hash] opts the optional parameters
172
- # @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
173
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
172
+ # @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
173
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
174
174
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
175
175
  def get_webhook_with_http_info(id, opts = {})
176
176
  if @api_client.config.debugging
@@ -199,7 +199,7 @@ module KlaviyoAPI
199
199
  # header parameters
200
200
  header_params = opts[:header_params] || {}
201
201
  # klaviyo api revision
202
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
202
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
203
203
  # HTTP header 'Accept' (if needed)
204
204
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
205
205
 
@@ -264,7 +264,7 @@ module KlaviyoAPI
264
264
  # header parameters
265
265
  header_params = opts[:header_params] || {}
266
266
  # klaviyo api revision
267
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
267
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
268
268
  # HTTP header 'Accept' (if needed)
269
269
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
270
270
 
@@ -323,7 +323,7 @@ module KlaviyoAPI
323
323
  # header parameters
324
324
  header_params = opts[:header_params] || {}
325
325
  # klaviyo api revision
326
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
326
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
327
327
  # HTTP header 'Accept' (if needed)
328
328
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
329
329
 
@@ -359,8 +359,8 @@ module KlaviyoAPI
359
359
  # Get Webhooks
360
360
  # Get all webhooks in an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read`
361
361
  # @param [Hash] opts the optional parameters
362
- # @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
363
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
362
+ # @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
363
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
364
364
  # @return [Hash<String, Object>]
365
365
  def get_webhooks(opts = {})
366
366
  data, _status_code, _headers = get_webhooks_with_http_info(opts)
@@ -370,8 +370,8 @@ module KlaviyoAPI
370
370
  # Get Webhooks
371
371
  # Get all webhooks in an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; **Scopes:** &#x60;webhooks:read&#x60;
372
372
  # @param [Hash] opts the optional parameters
373
- # @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
374
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
373
+ # @option opts [Array<String>] :fields_webhook For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
374
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
375
375
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
376
376
  def get_webhooks_with_http_info(opts = {})
377
377
  if @api_client.config.debugging
@@ -396,7 +396,7 @@ module KlaviyoAPI
396
396
  # header parameters
397
397
  header_params = opts[:header_params] || {}
398
398
  # klaviyo api revision
399
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
399
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
400
400
  # HTTP header 'Accept' (if needed)
401
401
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
402
402
 
@@ -467,7 +467,7 @@ module KlaviyoAPI
467
467
  # header parameters
468
468
  header_params = opts[:header_params] || {}
469
469
  # klaviyo api revision
470
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
470
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
471
471
  # HTTP header 'Accept' (if needed)
472
472
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
473
473
  # HTTP header 'Content-Type'
@@ -31,7 +31,7 @@ module KlaviyoAPI
31
31
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
32
32
  def initialize(config = Configuration.default)
33
33
  @config = config
34
- @user_agent = "klaviyo-api-ruby/13.0.1"
34
+ @user_agent = "klaviyo-api-ruby/14.0.0"
35
35
  @default_headers = {
36
36
  'Content-Type' => 'application/json',
37
37
  'User-Agent' => @user_agent
@@ -14,7 +14,7 @@ require 'time'
14
14
 
15
15
  module KlaviyoAPI
16
16
  class BaseEventCreateQueryBulkEntryResourceObjectAttributes
17
- # Properties of this event. Any top level property (that are not objects) can be used to create segments. The $extra property is a special property. This records any non-segmentable values that can be referenced later. For example, HTML templates are useful on a segment but are not used to create a segment. There are limits placed onto the size of the data present. This must not exceed 5 MB. This must not exceed 300 event properties. A single string cannot be larger than 100 KB. The maximum allowed sum of profile strings is 100KB. Each array must not exceed 4000 elements. The properties cannot contain more than 10 nested levels.
17
+ # Properties of this event (must not exceed 400 properties). The size of the event payload must not exceed 5 MB, and each string cannot be larger than 100 KB. For a full list of data limits on event payloads, see [Limitations](https://developers.klaviyo.com/en/reference/events_api_overview#limitations). Note any top-level property that is not an object can be used to create segments. The `$extra` property records any non-segmentable values that can be referenced later, e.g., HTML templates are useful on a segment but are not used to create a segment.
18
18
  attr_accessor :properties
19
19
 
20
20
  # When this event occurred. By default, the time the request was received will be used. The time is truncated to the second. The time must be after the year 2000 and can only be up to 1 year in the future.