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
data/lib/klaviyo-api-sdk/api/tags_api.rb CHANGED
@@ -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
  # HTTP header 'Content-Type'
@@ -190,7 +190,7 @@ module KlaviyoAPI
190
190
  # header parameters
191
191
  header_params = opts[:header_params] || {}
192
192
  # klaviyo api revision
193
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
193
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
194
194
  # HTTP header 'Accept' (if needed)
195
195
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
196
196
 
@@ -255,7 +255,7 @@ module KlaviyoAPI
255
255
  # header parameters
256
256
  header_params = opts[:header_params] || {}
257
257
  # klaviyo api revision
258
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
258
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
259
259
  # HTTP header 'Accept' (if needed)
260
260
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
261
261
 
@@ -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
 
@@ -394,7 +394,7 @@ module KlaviyoAPI
394
394
  # header parameters
395
395
  header_params = opts[:header_params] || {}
396
396
  # klaviyo api revision
397
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
397
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
398
398
  # HTTP header 'Accept' (if needed)
399
399
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
400
400
 
@@ -465,7 +465,7 @@ module KlaviyoAPI
465
465
  # header parameters
466
466
  header_params = opts[:header_params] || {}
467
467
  # klaviyo api revision
468
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
468
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
469
469
  # HTTP header 'Accept' (if needed)
470
470
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
471
471
 
@@ -536,7 +536,7 @@ module KlaviyoAPI
536
536
  # header parameters
537
537
  header_params = opts[:header_params] || {}
538
538
  # klaviyo api revision
539
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
539
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
540
540
  # HTTP header 'Accept' (if needed)
541
541
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
542
542
 
@@ -576,9 +576,9 @@ module KlaviyoAPI
576
576
  # Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
577
577
  # @param id [String] The Tag ID
578
578
  # @param [Hash] opts the optional parameters
579
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
580
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
581
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
579
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
580
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
581
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
582
582
  # @return [Hash<String, Object>]
583
583
  def get_tag(id, opts = {})
584
584
  data, _status_code, _headers = get_tag_with_http_info(id, opts)
@@ -589,9 +589,9 @@ module KlaviyoAPI
589
589
  # Retrieve the tag with the given tag ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;tags:read&#x60;
590
590
  # @param id [String] The Tag ID
591
591
  # @param [Hash] opts the optional parameters
592
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
593
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
594
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
592
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
593
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
594
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
595
595
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
596
596
  def get_tag_with_http_info(id, opts = {})
597
597
  if @api_client.config.debugging
@@ -625,7 +625,7 @@ module KlaviyoAPI
625
625
  # header parameters
626
626
  header_params = opts[:header_params] || {}
627
627
  # klaviyo api revision
628
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
628
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
629
629
  # HTTP header 'Accept' (if needed)
630
630
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
631
631
 
@@ -662,7 +662,7 @@ module KlaviyoAPI
662
662
  # Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
663
663
  # @param id [String] The Tag Group ID
664
664
  # @param [Hash] opts the optional parameters
665
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
665
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
666
666
  # @return [Hash<String, Object>]
667
667
  def get_tag_group(id, opts = {})
668
668
  data, _status_code, _headers = get_tag_group_with_http_info(id, opts)
@@ -673,7 +673,7 @@ module KlaviyoAPI
673
673
  # Retrieve the tag group with the given tag group ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;tags:read&#x60;
674
674
  # @param id [String] The Tag Group ID
675
675
  # @param [Hash] opts the optional parameters
676
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
676
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
677
677
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
678
678
  def get_tag_group_with_http_info(id, opts = {})
679
679
  if @api_client.config.debugging
@@ -697,7 +697,7 @@ module KlaviyoAPI
697
697
  # header parameters
698
698
  header_params = opts[:header_params] || {}
699
699
  # klaviyo api revision
700
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
700
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
701
701
  # HTTP header 'Accept' (if needed)
702
702
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
703
703
 
@@ -734,7 +734,7 @@ module KlaviyoAPI
734
734
  # Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
735
735
  # @param id [String] The Tag ID
736
736
  # @param [Hash] opts the optional parameters
737
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
737
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
738
738
  # @return [Hash<String, Object>]
739
739
  def get_tag_group_for_tag(id, opts = {})
740
740
  data, _status_code, _headers = get_tag_group_for_tag_with_http_info(id, opts)
@@ -751,7 +751,7 @@ module KlaviyoAPI
751
751
  # Returns the tag group resource for a given tag ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;tags:read&#x60;
752
752
  # @param id [String] The Tag ID
753
753
  # @param [Hash] opts the optional parameters
754
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
754
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
755
755
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
756
756
  def get_tag_group_for_tag_with_http_info(id, opts = {})
757
757
  if @api_client.config.debugging
@@ -775,7 +775,7 @@ module KlaviyoAPI
775
775
  # header parameters
776
776
  header_params = opts[:header_params] || {}
777
777
  # klaviyo api revision
778
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
778
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
779
779
  # HTTP header 'Accept' (if needed)
780
780
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
781
781
 
@@ -855,7 +855,7 @@ module KlaviyoAPI
855
855
  # header parameters
856
856
  header_params = opts[:header_params] || {}
857
857
  # klaviyo api revision
858
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
858
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
859
859
  # HTTP header 'Accept' (if needed)
860
860
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
861
861
 
@@ -900,10 +900,10 @@ module KlaviyoAPI
900
900
  # Get Tag Groups
901
901
  # List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
902
902
  # @param [Hash] opts the optional parameters
903
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
904
- # @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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;exclusive&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;default&#x60;: &#x60;equals&#x60;
905
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
906
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
903
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
904
+ # @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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;exclusive&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;default&#x60;: &#x60;equals&#x60;
905
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
906
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
907
907
  # @return [Hash<String, Object>]
908
908
  def get_tag_groups(opts = {})
909
909
  data, _status_code, _headers = get_tag_groups_with_http_info(opts)
@@ -913,10 +913,10 @@ module KlaviyoAPI
913
913
  # Get Tag Groups
914
914
  # List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by &#x60;name&#x60;, &#x60;exclusive&#x60;, and &#x60;default&#x60;, and sorted by &#x60;name&#x60; or &#x60;id&#x60; in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;tags:read&#x60;
915
915
  # @param [Hash] opts the optional parameters
916
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
917
- # @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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;exclusive&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;default&#x60;: &#x60;equals&#x60;
918
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
919
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
916
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
917
+ # @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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;exclusive&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;default&#x60;: &#x60;equals&#x60;
918
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
919
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
920
920
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
921
921
  def get_tag_groups_with_http_info(opts = {})
922
922
  if @api_client.config.debugging
@@ -943,7 +943,7 @@ module KlaviyoAPI
943
943
  # header parameters
944
944
  header_params = opts[:header_params] || {}
945
945
  # klaviyo api revision
946
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
946
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
947
947
  # HTTP header 'Accept' (if needed)
948
948
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
949
949
 
@@ -1011,7 +1011,7 @@ module KlaviyoAPI
1011
1011
  # header parameters
1012
1012
  header_params = opts[:header_params] || {}
1013
1013
  # klaviyo api revision
1014
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1014
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1015
1015
  # HTTP header 'Accept' (if needed)
1016
1016
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1017
1017
 
@@ -1050,12 +1050,12 @@ module KlaviyoAPI
1050
1050
  # Get Tags
1051
1051
  # List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
1052
1052
  # @param [Hash] opts the optional parameters
1053
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
1054
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
1055
- # @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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;
1056
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
1057
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
1058
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
1053
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
1054
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
1055
+ # @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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;
1056
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
1057
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
1058
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
1059
1059
  # @return [Hash<String, Object>]
1060
1060
  def get_tags(opts = {})
1061
1061
  data, _status_code, _headers = get_tags_with_http_info(opts)
@@ -1065,12 +1065,12 @@ module KlaviyoAPI
1065
1065
  # Get Tags
1066
1066
  # List all tags in an account. Tags can be filtered by &#x60;name&#x60;, and sorted by &#x60;name&#x60; or &#x60;id&#x60; in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;tags:read&#x60;
1067
1067
  # @param [Hash] opts the optional parameters
1068
- # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
1069
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
1070
- # @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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;
1071
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships
1072
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination
1073
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting
1068
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
1069
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
1070
+ # @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;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;
1071
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
1072
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
1073
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
1074
1074
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1075
1075
  def get_tags_with_http_info(opts = {})
1076
1076
  if @api_client.config.debugging
@@ -1107,7 +1107,7 @@ module KlaviyoAPI
1107
1107
  # header parameters
1108
1108
  header_params = opts[:header_params] || {}
1109
1109
  # klaviyo api revision
1110
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1110
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1111
1111
  # HTTP header 'Accept' (if needed)
1112
1112
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1113
1113
 
@@ -1144,7 +1144,7 @@ module KlaviyoAPI
1144
1144
  # Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
1145
1145
  # @param id [String] The Tag Group ID
1146
1146
  # @param [Hash] opts the optional parameters
1147
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
1147
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
1148
1148
  # @return [Hash<String, Object>]
1149
1149
  def get_tags_for_tag_group(id, opts = {})
1150
1150
  data, _status_code, _headers = get_tags_for_tag_group_with_http_info(id, opts)
@@ -1158,7 +1158,7 @@ module KlaviyoAPI
1158
1158
  # Return the tags for a given tag group ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;tags:read&#x60;
1159
1159
  # @param id [String] The Tag Group ID
1160
1160
  # @param [Hash] opts the optional parameters
1161
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets
1161
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
1162
1162
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1163
1163
  def get_tags_for_tag_group_with_http_info(id, opts = {})
1164
1164
  if @api_client.config.debugging
@@ -1182,7 +1182,7 @@ module KlaviyoAPI
1182
1182
  # header parameters
1183
1183
  header_params = opts[:header_params] || {}
1184
1184
  # klaviyo api revision
1185
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1185
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1186
1186
  # HTTP header 'Accept' (if needed)
1187
1187
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1188
1188
 
@@ -1262,7 +1262,7 @@ module KlaviyoAPI
1262
1262
  # header parameters
1263
1263
  header_params = opts[:header_params] || {}
1264
1264
  # klaviyo api revision
1265
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1265
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1266
1266
  # HTTP header 'Accept' (if needed)
1267
1267
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1268
1268
  # HTTP header 'Content-Type'
@@ -1350,7 +1350,7 @@ module KlaviyoAPI
1350
1350
  # header parameters
1351
1351
  header_params = opts[:header_params] || {}
1352
1352
  # klaviyo api revision
1353
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1353
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1354
1354
  # HTTP header 'Accept' (if needed)
1355
1355
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1356
1356
  # HTTP header 'Content-Type'
@@ -1438,7 +1438,7 @@ module KlaviyoAPI
1438
1438
  # header parameters
1439
1439
  header_params = opts[:header_params] || {}
1440
1440
  # klaviyo api revision
1441
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1441
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1442
1442
  # HTTP header 'Accept' (if needed)
1443
1443
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1444
1444
  # HTTP header 'Content-Type'
@@ -1526,7 +1526,7 @@ module KlaviyoAPI
1526
1526
  # header parameters
1527
1527
  header_params = opts[:header_params] || {}
1528
1528
  # klaviyo api revision
1529
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1529
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1530
1530
  # HTTP header 'Accept' (if needed)
1531
1531
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1532
1532
  # HTTP header 'Content-Type'
@@ -1617,7 +1617,7 @@ module KlaviyoAPI
1617
1617
  # header parameters
1618
1618
  header_params = opts[:header_params] || {}
1619
1619
  # klaviyo api revision
1620
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1620
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1621
1621
  # HTTP header 'Accept' (if needed)
1622
1622
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1623
1623
  # HTTP header 'Content-Type'
@@ -1711,7 +1711,7 @@ module KlaviyoAPI
1711
1711
  # header parameters
1712
1712
  header_params = opts[:header_params] || {}
1713
1713
  # klaviyo api revision
1714
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1714
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1715
1715
  # HTTP header 'Accept' (if needed)
1716
1716
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1717
1717
  # HTTP header 'Content-Type'
@@ -1805,7 +1805,7 @@ module KlaviyoAPI
1805
1805
  # header parameters
1806
1806
  header_params = opts[:header_params] || {}
1807
1807
  # klaviyo api revision
1808
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1808
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1809
1809
  # HTTP header 'Accept' (if needed)
1810
1810
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1811
1811
  # HTTP header 'Content-Type'
@@ -1899,7 +1899,7 @@ module KlaviyoAPI
1899
1899
  # header parameters
1900
1900
  header_params = opts[:header_params] || {}
1901
1901
  # klaviyo api revision
1902
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1902
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1903
1903
  # HTTP header 'Accept' (if needed)
1904
1904
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1905
1905
  # HTTP header 'Content-Type'
@@ -1984,7 +1984,7 @@ module KlaviyoAPI
1984
1984
  # header parameters
1985
1985
  header_params = opts[:header_params] || {}
1986
1986
  # klaviyo api revision
1987
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
1987
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
1988
1988
  # HTTP header 'Accept' (if needed)
1989
1989
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1990
1990
  # HTTP header 'Content-Type'
@@ -2060,7 +2060,7 @@ module KlaviyoAPI
2060
2060
  # header parameters
2061
2061
  header_params = opts[:header_params] || {}
2062
2062
  # klaviyo api revision
2063
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-04-15"
2063
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
2064
2064
  # HTTP header 'Accept' (if needed)
2065
2065
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2066
2066
  # HTTP header 'Content-Type'