klaviyo-api-sdk 18.0.0 → 19.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 (418) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +44 -0
  3. data/README.md +1525 -459
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
  6. data/lib/klaviyo-api-sdk/api/billing_api.rb +162 -0
  7. data/lib/klaviyo-api-sdk/api/brands_api.rb +1933 -0
  8. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +3298 -653
  9. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +265 -265
  10. data/lib/klaviyo-api-sdk/api/client_api.rb +9 -13
  11. data/lib/klaviyo-api-sdk/api/conversations_api.rb +1 -1
  12. data/lib/klaviyo-api-sdk/api/coupons_api.rb +80 -80
  13. data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +120 -117
  14. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
  15. data/lib/klaviyo-api-sdk/api/events_api.rb +39 -39
  16. data/lib/klaviyo-api-sdk/api/flows_api.rb +190 -113
  17. data/lib/klaviyo-api-sdk/api/forms_api.rb +292 -43
  18. data/lib/klaviyo-api-sdk/api/images_api.rb +23 -23
  19. data/lib/klaviyo-api-sdk/api/lists_api.rb +64 -64
  20. data/lib/klaviyo-api-sdk/api/metrics_api.rb +94 -94
  21. data/lib/klaviyo-api-sdk/api/profiles_api.rb +163 -163
  22. data/lib/klaviyo-api-sdk/api/reporting_api.rb +27 -27
  23. data/lib/klaviyo-api-sdk/api/reviews_api.rb +23 -23
  24. data/lib/klaviyo-api-sdk/api/segments_api.rb +58 -58
  25. data/lib/klaviyo-api-sdk/api/tags_api.rb +62 -62
  26. data/lib/klaviyo-api-sdk/api/templates_api.rb +236 -76
  27. data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
  28. data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +11 -11
  29. data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
  30. data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +19 -19
  31. data/lib/klaviyo-api-sdk/api/webhooks_api.rb +27 -27
  32. data/lib/klaviyo-api-sdk/api_client.rb +1 -1
  33. data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → ab_test_action_link_only.rb} +23 -9
  34. data/lib/klaviyo-api-sdk/models/{sms_message_definition_create.rb → ab_test_settings.rb} +36 -35
  35. data/lib/klaviyo-api-sdk/models/action_output_split_action_link_only.rb +271 -0
  36. data/lib/klaviyo-api-sdk/models/address.rb +295 -0
  37. data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +10 -1
  38. data/lib/klaviyo-api-sdk/models/age_gate_styles.rb +14 -5
  39. data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb} +56 -44
  40. data/lib/klaviyo-api-sdk/models/api_schema_property.rb +2 -2
  41. data/lib/klaviyo-api-sdk/models/audience_clone_query.rb +223 -0
  42. data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object.rb → audience_clone_query_resource_object.rb} +7 -7
  43. data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_attributes.rb +235 -0
  44. data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships.rb +218 -0
  45. data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign.rb +218 -0
  46. data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign_data.rb +238 -0
  47. data/lib/klaviyo-api-sdk/models/audience_create_query.rb +223 -0
  48. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object.rb +251 -0
  49. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes.rb → audience_create_query_resource_object_attributes.rb} +4 -4
  50. data/lib/klaviyo-api-sdk/models/{html_block_data_v0.rb → audience_create_query_resource_object_relationships.rb} +19 -24
  51. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign.rb +218 -0
  52. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_data.rb +238 -0
  53. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages.rb +220 -0
  54. data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
  55. data/lib/klaviyo-api-sdk/models/{audiences_update.rb → audience_definition.rb} +32 -10
  56. data/lib/klaviyo-api-sdk/models/audience_inline_create.rb +261 -0
  57. data/lib/klaviyo-api-sdk/models/audience_update_query.rb +223 -0
  58. data/lib/klaviyo-api-sdk/models/audience_update_query_resource_object.rb +252 -0
  59. data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object_attributes.rb → audience_update_query_resource_object_attributes.rb} +4 -5
  60. data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action_link_only.rb +271 -0
  61. data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +10 -1
  62. data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
  63. data/lib/klaviyo-api-sdk/models/border_styles.rb +297 -0
  64. data/lib/klaviyo-api-sdk/models/brand_button_create_query.rb +223 -0
  65. data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object.rb +237 -0
  66. data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object_attributes.rb +298 -0
  67. data/lib/klaviyo-api-sdk/models/brand_button_enum.rb +35 -0
  68. data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query.rb +223 -0
  69. data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object.rb +252 -0
  70. data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object_attributes.rb +275 -0
  71. data/lib/klaviyo-api-sdk/models/brand_color_create_query.rb +223 -0
  72. data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object.rb +237 -0
  73. data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object_attributes.rb +233 -0
  74. data/lib/klaviyo-api-sdk/models/brand_color_enum.rb +35 -0
  75. data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query.rb +223 -0
  76. data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object.rb +252 -0
  77. data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object_attributes.rb +231 -0
  78. data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options.rb → brand_email_body_patch_attributes.rb} +68 -38
  79. data/lib/klaviyo-api-sdk/models/brand_email_default_enum.rb +35 -0
  80. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query.rb +223 -0
  81. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object.rb +261 -0
  82. data/lib/klaviyo-api-sdk/models/{audiences.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +25 -28
  83. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships.rb +236 -0
  84. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_button.rb +218 -0
  85. data/lib/klaviyo-api-sdk/models/{content_repeat_v0.rb → brand_email_default_partial_update_query_resource_object_relationships_brand_button_data.rb} +22 -22
  86. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo.rb +218 -0
  87. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo_data.rb +237 -0
  88. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_social_group.rb +218 -0
  89. data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_rels_brand_social_group_data.rb +237 -0
  90. data/lib/klaviyo-api-sdk/models/brand_email_footer_patch_attributes.rb +283 -0
  91. data/lib/klaviyo-api-sdk/models/{mobile_push_content_update.rb → brand_email_header_patch_attributes.rb} +36 -38
  92. data/lib/klaviyo-api-sdk/models/brand_library_button_styles.rb +262 -0
  93. data/lib/klaviyo-api-sdk/models/brand_library_text_styles.rb +368 -0
  94. data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → brand_library_text_styles_letter_spacing.rb} +3 -4
  95. data/lib/klaviyo-api-sdk/models/brand_logo_create_query.rb +223 -0
  96. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object.rb → brand_logo_create_query_resource_object.rb} +6 -6
  97. data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_attributes.rb +264 -0
  98. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships.rb → brand_logo_create_query_resource_object_relationships.rb} +4 -4
  99. data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image.rb +218 -0
  100. data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image_data.rb +237 -0
  101. data/lib/klaviyo-api-sdk/models/brand_logo_enum.rb +35 -0
  102. data/lib/klaviyo-api-sdk/models/{universal_content_create_query.rb → brand_logo_partial_update_query.rb} +4 -4
  103. data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object.rb +261 -0
  104. data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object_attributes.rb +259 -0
  105. data/lib/klaviyo-api-sdk/models/brand_social_group_create_query.rb +223 -0
  106. data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object.rb → brand_social_group_create_query_resource_object.rb} +5 -5
  107. data/lib/klaviyo-api-sdk/models/brand_social_group_create_query_resource_object_attributes.rb +237 -0
  108. data/lib/klaviyo-api-sdk/models/{mobile_push_badge_badge_options.rb → brand_social_group_create_query_resource_object_attributes_social_links_inner.rb} +3 -5
  109. data/lib/klaviyo-api-sdk/models/brand_social_group_enum.rb +35 -0
  110. data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query.rb → brand_social_group_partial_update_query.rb} +4 -4
  111. data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object.rb → brand_social_group_partial_update_query_resource_object.rb} +6 -6
  112. data/lib/klaviyo-api-sdk/models/brand_social_group_partial_update_query_resource_object_attributes.rb +231 -0
  113. data/lib/klaviyo-api-sdk/models/brand_voice_descriptor.rb +248 -0
  114. data/lib/klaviyo-api-sdk/models/brand_voice_enum.rb +35 -0
  115. data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query.rb +223 -0
  116. data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object.rb +252 -0
  117. data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object_attributes.rb +235 -0
  118. data/lib/klaviyo-api-sdk/models/button_action.rb +1 -0
  119. data/lib/klaviyo-api-sdk/models/button_properties.rb +10 -1
  120. data/lib/klaviyo-api-sdk/models/button_styles.rb +10 -1
  121. data/lib/klaviyo-api-sdk/models/campaign_audience_clone_enum.rb +35 -0
  122. data/lib/klaviyo-api-sdk/models/campaign_audience_enum.rb +35 -0
  123. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +9 -9
  124. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +13 -4
  125. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +30 -63
  126. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships.rb +236 -0
  127. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences.rb +220 -0
  128. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences_data_inner.rb +238 -0
  129. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages.rb +220 -0
  130. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
  131. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags.rb +220 -0
  132. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags_data_inner.rb +238 -0
  133. data/lib/klaviyo-api-sdk/models/{push_action_button_definition.rb → campaign_definition.rb} +56 -44
  134. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_enum.rb +35 -0
  135. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query.rb +223 -0
  136. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object.rb +251 -0
  137. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_attributes.rb +298 -0
  138. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships.rb +223 -0
  139. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message.rb +218 -0
  140. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message_data.rb +238 -0
  141. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query.rb +223 -0
  142. data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query_resource_object.rb +251 -0
  143. data/lib/klaviyo-api-sdk/models/{non_local_static_send.rb → campaign_message_schedule_update_query_resource_object_attributes.rb} +22 -22
  144. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  145. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +12 -48
  146. data/lib/klaviyo-api-sdk/models/campaign_schedule_enum.rb +35 -0
  147. data/lib/klaviyo-api-sdk/models/campaign_schedule_query.rb +223 -0
  148. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object.rb +251 -0
  149. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_attributes.rb +226 -0
  150. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships.rb +223 -0
  151. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign.rb +218 -0
  152. data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign_data.rb +238 -0
  153. data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +2 -2
  154. data/lib/klaviyo-api-sdk/models/campaign_variation_enum.rb +35 -0
  155. data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +10 -1
  156. data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
  157. data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → click_tracking_subscription_parameters.rb} +22 -22
  158. data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_unsubscription_parameters.rb} +22 -21
  159. data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
  160. data/lib/klaviyo-api-sdk/models/{push_on_open_web_url.rb → code_action_link_only.rb} +17 -14
  161. data/lib/klaviyo-api-sdk/models/color.rb +237 -0
  162. data/lib/klaviyo-api-sdk/models/conditional_branch_action_link_only.rb +271 -0
  163. data/lib/klaviyo-api-sdk/models/consent_page_enum.rb +35 -0
  164. data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
  165. data/lib/klaviyo-api-sdk/models/{push_on_open_deep_link.rb → continue_with_shop.rb} +29 -22
  166. data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → continue_with_shop_autofill.rb} +50 -37
  167. data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
  168. data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → continue_with_shop_properties.rb} +76 -59
  169. data/lib/klaviyo-api-sdk/models/continue_with_shop_styles.rb +298 -0
  170. data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_attributes.rb +17 -4
  171. data/lib/klaviyo-api-sdk/models/countdown_delay_action_link_only.rb +271 -0
  172. data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +33 -1
  173. data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → coupon_assigner_configuration.rb} +40 -48
  174. data/lib/klaviyo-api-sdk/models/coupon_block_data.rb +1 -5
  175. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +14 -5
  176. data/lib/klaviyo-api-sdk/models/coupon_properties.rb +10 -1
  177. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
  178. data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +10 -1
  179. data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +11 -1
  180. data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter.rb +225 -0
  181. data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter_condition_groups_inner.rb +225 -0
  182. data/lib/klaviyo-api-sdk/models/{local_static_send.rb → custom_social_link.rb} +72 -31
  183. data/lib/klaviyo-api-sdk/models/customer_hub_block_action_link_only.rb +271 -0
  184. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +5 -0
  185. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +5 -1
  186. data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +5 -0
  187. data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object.rb +5 -0
  188. data/lib/klaviyo-api-sdk/models/date_properties.rb +10 -1
  189. data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
  190. data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +10 -1
  191. data/lib/klaviyo-api-sdk/models/dropdown_styles.rb +14 -5
  192. data/lib/klaviyo-api-sdk/models/{mobile_push_badge.rb → dynamic_sms_image.rb} +29 -28
  193. data/lib/klaviyo-api-sdk/models/{email_content.rb → email_channel_details.rb} +97 -42
  194. data/lib/klaviyo-api-sdk/models/{push_send_options.rb → email_header_link.rb} +29 -14
  195. data/lib/klaviyo-api-sdk/models/email_properties.rb +10 -1
  196. data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
  197. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -4
  198. data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -4
  199. data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
  200. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +13 -4
  201. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +5 -14
  202. data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → first_party_social_link.rb} +30 -31
  203. data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object.rb +252 -0
  204. data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes.rb +223 -0
  205. data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes_definition.rb +126 -0
  206. data/lib/klaviyo-api-sdk/models/flow_action_insert_query.rb +223 -0
  207. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object.rb +246 -0
  208. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes.rb +245 -0
  209. data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → flow_action_insert_query_resource_object_attributes_anchor_action.rb} +6 -8
  210. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes_definition.rb +124 -0
  211. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships.rb +218 -0
  212. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow.rb +218 -0
  213. data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow_data.rb +238 -0
  214. data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +1 -0
  215. data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +1 -0
  216. data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
  217. data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +1 -1
  218. data/lib/klaviyo-api-sdk/models/flow_sms.rb +2 -2
  219. data/lib/klaviyo-api-sdk/models/{mobile_push_options_on_open.rb → flow_sms_message_hierarchy_inner.rb} +3 -4
  220. data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
  221. data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → flow_whats_app_with_ac.rb} +86 -16
  222. data/lib/klaviyo-api-sdk/models/form_partial_update_query.rb +223 -0
  223. data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object.rb +252 -0
  224. data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object_attributes.rb +229 -0
  225. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query.rb +223 -0
  226. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object.rb +237 -0
  227. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships.rb +223 -0
  228. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form.rb +218 -0
  229. data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form_data.rb +238 -0
  230. data/lib/klaviyo-api-sdk/models/form_publish_job_enum.rb +35 -0
  231. data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query.rb +223 -0
  232. data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object.rb +237 -0
  233. data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object_relationships.rb +223 -0
  234. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image.rb → form_unpublish_job_create_query_resource_object_relationships_form.rb} +4 -4
  235. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image_data.rb → form_unpublish_job_create_query_resource_object_relationships_form_data.rb} +5 -5
  236. data/lib/klaviyo-api-sdk/models/form_unpublish_job_enum.rb +35 -0
  237. data/lib/klaviyo-api-sdk/models/html_text_properties.rb +10 -1
  238. data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +36 -4
  239. data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → iaf_open_url.rb} +42 -34
  240. data/lib/klaviyo-api-sdk/models/{sms_content_create.rb → iaf_open_url_properties.rb} +12 -12
  241. data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
  242. data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
  243. data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
  244. data/lib/klaviyo-api-sdk/models/image_properties.rb +10 -1
  245. data/lib/klaviyo-api-sdk/models/{throttled_send_strategy.rb → inline_message_schedule.rb} +69 -55
  246. data/lib/klaviyo-api-sdk/models/input_style_overrides.rb +307 -0
  247. data/lib/klaviyo-api-sdk/models/internal_service_action_link_only.rb +271 -0
  248. data/lib/klaviyo-api-sdk/models/link_text_styles.rb +352 -0
  249. data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → link_text_styles_letter_spacing.rb} +3 -3
  250. data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
  251. data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox.rb +291 -0
  252. data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_properties.rb +372 -0
  253. data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_styles.rb +283 -0
  254. data/lib/klaviyo-api-sdk/models/{campaign_message_static_count.rb → marketing_tracking_consent_configuration.rb} +31 -30
  255. data/lib/klaviyo-api-sdk/models/media_asset.rb +318 -0
  256. data/lib/klaviyo-api-sdk/models/media_asset_reference.rb +240 -0
  257. data/lib/klaviyo-api-sdk/models/message_clone_query.rb +223 -0
  258. data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object.rb +266 -0
  259. data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_attributes.rb +235 -0
  260. data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_relationships.rb +223 -0
  261. data/lib/klaviyo-api-sdk/models/message_create_query.rb +223 -0
  262. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object.rb +251 -0
  263. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_attributes.rb +236 -0
  264. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships.rb +237 -0
  265. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign.rb +218 -0
  266. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience.rb +218 -0
  267. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience_data.rb +238 -0
  268. data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_data.rb +238 -0
  269. data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
  270. data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → message_hierarchy_rcs_item.rb} +56 -57
  271. data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item.rb +301 -0
  272. data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item_image.rb +105 -0
  273. data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_tracking_options.rb → message_hierarchy_sms_item_media.rb} +4 -4
  274. data/lib/klaviyo-api-sdk/models/{block_display_options.rb → message_inline_create.rb} +64 -33
  275. data/lib/klaviyo-api-sdk/models/message_partial_update_query.rb +223 -0
  276. data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object.rb +252 -0
  277. data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object_attributes.rb +218 -0
  278. data/lib/klaviyo-api-sdk/models/message_send_options.rb +344 -0
  279. data/lib/klaviyo-api-sdk/models/message_tracking_options.rb +239 -0
  280. data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → multi_branch_split_action_link_only.rb} +15 -32
  281. data/lib/klaviyo-api-sdk/models/multi_branch_split_action_link_only_data.rb +225 -0
  282. data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +4 -0
  283. data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
  284. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +10 -1
  286. data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
  287. data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +10 -1
  288. data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
  289. data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +15 -5
  290. data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
  291. data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
  292. data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
  293. data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
  294. data/lib/klaviyo-api-sdk/models/push_action_button_v0.rb +322 -0
  295. data/lib/klaviyo-api-sdk/models/{push_action_button.rb → push_action_button_v2.rb} +28 -8
  296. data/lib/klaviyo-api-sdk/models/push_channel_details.rb +512 -0
  297. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +13 -4
  298. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -10
  299. data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +10 -1
  300. data/lib/klaviyo-api-sdk/models/radio_buttons_styles.rb +10 -1
  301. data/lib/klaviyo-api-sdk/models/rcs_card.rb +290 -0
  302. data/lib/klaviyo-api-sdk/models/rcs_card_image.rb +105 -0
  303. data/lib/klaviyo-api-sdk/models/rcs_card_video.rb +105 -0
  304. data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → rcs_rich_content.rb} +36 -14
  305. data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → rcs_suggestion.rb} +63 -34
  306. data/lib/klaviyo-api-sdk/models/review_properties.rb +10 -1
  307. data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
  308. data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +2 -0
  309. data/lib/klaviyo-api-sdk/models/send_email_action_link_only.rb +271 -0
  310. data/lib/klaviyo-api-sdk/models/send_internal_alert_action_link_only.rb +271 -0
  311. data/lib/klaviyo-api-sdk/models/send_push_notification_action_link_only.rb +271 -0
  312. data/lib/klaviyo-api-sdk/models/send_settings.rb +264 -0
  313. data/lib/klaviyo-api-sdk/models/send_sms_action_link_only.rb +271 -0
  314. data/lib/klaviyo-api-sdk/models/send_webhook_action_link_only.rb +271 -0
  315. data/lib/klaviyo-api-sdk/models/send_whats_app_action_link_only.rb +271 -0
  316. data/lib/klaviyo-api-sdk/models/{image_block_v0.rb → send_whats_app_with_ac_action.rb} +35 -31
  317. data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_data.rb +264 -0
  318. data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_link_only.rb +271 -0
  319. data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +10 -1
  320. data/lib/klaviyo-api-sdk/models/slim_image_reference.rb +242 -0
  321. data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_update.rb → sms_channel_details.rb} +135 -34
  322. data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +10 -1
  323. data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
  324. data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +10 -1
  325. data/lib/klaviyo-api-sdk/models/{render_options.rb → spacing_styles.rb} +48 -40
  326. data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +10 -1
  327. data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
  328. data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
  329. data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query.rb → template_preview_send_job_create_query.rb} +4 -4
  330. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object.rb +251 -0
  331. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_attributes.rb +237 -0
  332. data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +21 -31
  333. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile.rb +218 -0
  334. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile_data.rb +238 -0
  335. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template.rb +218 -0
  336. data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template_data.rb +238 -0
  337. data/lib/klaviyo-api-sdk/models/template_preview_send_job_enum.rb +35 -0
  338. data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query.rb +223 -0
  339. data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object.rb +237 -0
  340. data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object_attributes.rb +224 -0
  341. data/lib/klaviyo-api-sdk/models/text_messaging_configuration_enum.rb +35 -0
  342. data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_attrs_text_messaging_sender_registration.rb +224 -0
  343. data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query.rb +223 -0
  344. data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query_resource_object.rb +237 -0
  345. data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_create.rb → text_messaging_sender_create_query_resource_object_attributes.rb} +50 -68
  346. data/lib/klaviyo-api-sdk/models/text_messaging_sender_enum.rb +35 -0
  347. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query.rb +223 -0
  348. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object.rb +251 -0
  349. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_attributes.rb +440 -0
  350. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_relationships.rb +223 -0
  351. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender.rb +218 -0
  352. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender_data.rb +237 -0
  353. data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_enum.rb +35 -0
  354. data/lib/klaviyo-api-sdk/models/text_properties.rb +10 -1
  355. data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → text_style_overrides.rb} +54 -53
  356. data/lib/klaviyo-api-sdk/models/text_style_overrides_font_family.rb +103 -0
  357. data/lib/klaviyo-api-sdk/models/text_styles.rb +14 -5
  358. data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → throttled_options.rb} +31 -32
  359. data/lib/klaviyo-api-sdk/models/time_delay_action_link_only.rb +271 -0
  360. data/lib/klaviyo-api-sdk/models/{email_send_options.rb → timezone_options.rb} +13 -13
  361. data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object.rb +237 -0
  362. data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object_attributes.rb +440 -0
  363. data/lib/klaviyo-api-sdk/models/{immediate_send_strategy.rb → toll_free_sender_details.rb} +22 -21
  364. data/lib/klaviyo-api-sdk/models/translation_create_query.rb +223 -0
  365. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object.rb +246 -0
  366. data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_create.rb → translation_create_query_resource_object_attributes.rb} +54 -41
  367. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships.rb +254 -0
  368. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation.rb +218 -0
  369. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation_data.rb +238 -0
  370. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page.rb +218 -0
  371. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page_data.rb +238 -0
  372. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message.rb +218 -0
  373. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message_data.rb +238 -0
  374. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template.rb +218 -0
  375. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_data.rb +238 -0
  376. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content.rb +218 -0
  377. data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content_data.rb +238 -0
  378. data/lib/klaviyo-api-sdk/models/translation_enum.rb +35 -0
  379. data/lib/klaviyo-api-sdk/models/translation_partial_update_query.rb +223 -0
  380. data/lib/klaviyo-api-sdk/models/translation_partial_update_query_resource_object.rb +252 -0
  381. data/lib/klaviyo-api-sdk/models/{mobile_push_content_create.rb → translation_partial_update_query_resource_object_attributes.rb} +39 -41
  382. data/lib/klaviyo-api-sdk/models/trigger_branch_action_link_only.rb +271 -0
  383. data/lib/klaviyo-api-sdk/models/universal_content_clone_query.rb +223 -0
  384. data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object.rb +252 -0
  385. data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object_attributes.rb +235 -0
  386. data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1.rb +223 -0
  387. data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1_resource_object.rb +237 -0
  388. data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object_attributes.rb → universal_content_create_query_v1_resource_object_attributes.rb} +4 -4
  389. data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_strategy.rb → universal_content_create_query_v1_resource_object_attributes_definition.rb} +17 -6
  390. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1.rb +223 -0
  391. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1_resource_object.rb +252 -0
  392. data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object_attributes.rb → universal_content_partial_update_query_v1_resource_object_attributes.rb} +4 -4
  393. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_definition.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -5
  394. data/lib/klaviyo-api-sdk/models/update_profile_action_link_only.rb +271 -0
  395. data/lib/klaviyo-api-sdk/models/variation_create_query.rb +223 -0
  396. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object.rb +251 -0
  397. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_attributes.rb +223 -0
  398. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships.rb +223 -0
  399. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message.rb +218 -0
  400. data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message_data.rb +238 -0
  401. data/lib/klaviyo-api-sdk/models/variation_definition.rb +230 -0
  402. data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_options.rb → variation_definition_details.rb} +6 -5
  403. data/lib/klaviyo-api-sdk/models/variation_inline_create.rb +223 -0
  404. data/lib/klaviyo-api-sdk/models/variation_partial_update_query.rb +223 -0
  405. data/lib/klaviyo-api-sdk/models/variation_partial_update_query_resource_object.rb +252 -0
  406. data/lib/klaviyo-api-sdk/models/verified_badge_style.rb +266 -0
  407. data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
  408. data/lib/klaviyo-api-sdk.rb +305 -78
  409. data/lib/klaviyo-api-sdk.rb.bak +306 -79
  410. metadata +315 -82
  411. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +0 -107
  412. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -107
  413. data/lib/klaviyo-api-sdk/models/drop_shadow_block_v0.rb +0 -293
  414. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
  415. data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -105
  416. data/lib/klaviyo-api-sdk/models/text_block_styles_v0.rb +0 -533
  417. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -109
  418. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -109
@@ -22,7 +22,7 @@ module KlaviyoAPI
22
22
  # Create a new custom metric. Custom metric objects must include a `name` and `definition`.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `15/d` **Scopes:** `metrics:write` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_custom_metric.json)
23
23
  # @param custom_metric_create_query [CustomMetricCreateQuery] Create a custom metric.
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
25
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
26
26
  # @return [Hash<String, Object>]
27
27
  def create_custom_metric(custom_metric_create_query, opts = {})
28
28
  data, _status_code, _headers = create_custom_metric_with_http_info(custom_metric_create_query, opts)
@@ -33,7 +33,7 @@ module KlaviyoAPI
33
33
  # Create a new custom metric. Custom metric objects must include a &#x60;name&#x60; and &#x60;definition&#x60;.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60;&lt;br&gt;Daily: &#x60;15/d&#x60; **Scopes:** &#x60;metrics:write&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_custom_metric.json)
34
34
  # @param custom_metric_create_query [CustomMetricCreateQuery] Create a custom metric.
35
35
  # @param [Hash] opts the optional parameters
36
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
36
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-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 create_custom_metric_with_http_info(custom_metric_create_query, 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'] || "2026-07-15"
60
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
61
61
  # HTTP header 'Accept' (if needed)
62
62
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
63
63
  # HTTP header 'Content-Type'
@@ -127,7 +127,7 @@ module KlaviyoAPI
127
127
  # header parameters
128
128
  header_params = opts[:header_params] || {}
129
129
  # klaviyo api revision
130
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
130
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
131
131
  # HTTP header 'Accept' (if needed)
132
132
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
133
133
 
@@ -164,9 +164,9 @@ module KlaviyoAPI
164
164
  # Get a custom metric with the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric.json)
165
165
  # @param id [String] The ID of the custom metric
166
166
  # @param [Hash] opts the optional parameters
167
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
168
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
169
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
167
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
168
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
169
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
170
170
  # @return [Hash<String, Object>]
171
171
  def get_custom_metric(id, opts = {})
172
172
  data, _status_code, _headers = get_custom_metric_with_http_info(id, opts)
@@ -177,9 +177,9 @@ module KlaviyoAPI
177
177
  # Get a custom metric with the given custom metric 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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric.json)
178
178
  # @param id [String] The ID of the custom metric
179
179
  # @param [Hash] opts the optional parameters
180
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
181
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
182
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
180
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
181
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
182
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
183
183
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
184
184
  def get_custom_metric_with_http_info(id, opts = {})
185
185
  if @api_client.config.debugging
@@ -213,7 +213,7 @@ module KlaviyoAPI
213
213
  # header parameters
214
214
  header_params = opts[:header_params] || {}
215
215
  # klaviyo api revision
216
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
216
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
217
217
  # HTTP header 'Accept' (if needed)
218
218
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
219
219
 
@@ -250,7 +250,7 @@ module KlaviyoAPI
250
250
  # Get the custom metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_for_mapped_metric.json)
251
251
  # @param id [String] The type of mapping.
252
252
  # @param [Hash] opts the optional parameters
253
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
253
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
254
254
  # @return [Hash<String, Object>]
255
255
  def get_custom_metric_for_mapped_metric(id, opts = {})
256
256
  data, _status_code, _headers = get_custom_metric_for_mapped_metric_with_http_info(id, opts)
@@ -264,7 +264,7 @@ module KlaviyoAPI
264
264
  # Get the custom metric for the given mapped metric ID (if applicable).&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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_for_mapped_metric.json)
265
265
  # @param id [String] The type of mapping.
266
266
  # @param [Hash] opts the optional parameters
267
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
267
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
268
268
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
269
269
  def get_custom_metric_for_mapped_metric_with_http_info(id, opts = {})
270
270
  if @api_client.config.debugging
@@ -293,7 +293,7 @@ module KlaviyoAPI
293
293
  # header parameters
294
294
  header_params = opts[:header_params] || {}
295
295
  # klaviyo api revision
296
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
296
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
297
297
  # HTTP header 'Accept' (if needed)
298
298
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
299
299
 
@@ -369,7 +369,7 @@ module KlaviyoAPI
369
369
  # header parameters
370
370
  header_params = opts[:header_params] || {}
371
371
  # klaviyo api revision
372
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
372
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
373
373
  # HTTP header 'Accept' (if needed)
374
374
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
375
375
 
@@ -408,9 +408,9 @@ module KlaviyoAPI
408
408
  # Get Custom Metrics
409
409
  # Get all custom metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metrics.json)
410
410
  # @param [Hash] opts the optional parameters
411
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
412
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
413
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
411
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
412
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
413
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
414
414
  # @return [Hash<String, Object>]
415
415
  def get_custom_metrics(opts = {})
416
416
  data, _status_code, _headers = get_custom_metrics_with_http_info(opts)
@@ -420,9 +420,9 @@ module KlaviyoAPI
420
420
  # Get Custom Metrics
421
421
  # Get all custom metrics in an account.&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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metrics.json)
422
422
  # @param [Hash] opts the optional parameters
423
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
424
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
425
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
423
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
424
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
425
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
426
426
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
427
427
  def get_custom_metrics_with_http_info(opts = {})
428
428
  if @api_client.config.debugging
@@ -452,7 +452,7 @@ module KlaviyoAPI
452
452
  # header parameters
453
453
  header_params = opts[:header_params] || {}
454
454
  # klaviyo api revision
455
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
455
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
456
456
  # HTTP header 'Accept' (if needed)
457
457
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
458
458
 
@@ -489,7 +489,7 @@ module KlaviyoAPI
489
489
  # Get all flows where the given metric is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `flows:read` `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_metric.json)
490
490
  # @param id [String]
491
491
  # @param [Hash] opts the optional parameters
492
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
492
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
493
493
  # @return [Hash<String, Object>]
494
494
  def get_flows_triggered_by_metric(id, opts = {})
495
495
  data, _status_code, _headers = get_flows_triggered_by_metric_with_http_info(id, opts)
@@ -506,7 +506,7 @@ module KlaviyoAPI
506
506
  # Get all flows where the given metric is being used as the trigger.&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;flows:read&#x60; &#x60;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_metric.json)
507
507
  # @param id [String]
508
508
  # @param [Hash] opts the optional parameters
509
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
509
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
510
510
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
511
511
  def get_flows_triggered_by_metric_with_http_info(id, opts = {})
512
512
  if @api_client.config.debugging
@@ -530,7 +530,7 @@ module KlaviyoAPI
530
530
  # header parameters
531
531
  header_params = opts[:header_params] || {}
532
532
  # klaviyo api revision
533
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
533
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
534
534
  # HTTP header 'Accept' (if needed)
535
535
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
536
536
 
@@ -607,7 +607,7 @@ module KlaviyoAPI
607
607
  # header parameters
608
608
  header_params = opts[:header_params] || {}
609
609
  # klaviyo api revision
610
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
610
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
611
611
  # HTTP header 'Accept' (if needed)
612
612
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
613
613
 
@@ -650,10 +650,10 @@ module KlaviyoAPI
650
650
  # Get the mapped metric with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metric.json)
651
651
  # @param id [String] The type of mapping.
652
652
  # @param [Hash] opts the optional parameters
653
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
654
- # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
655
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
656
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
653
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
654
+ # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
655
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
656
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
657
657
  # @return [Hash<String, Object>]
658
658
  def get_mapped_metric(id, opts = {})
659
659
  data, _status_code, _headers = get_mapped_metric_with_http_info(id, opts)
@@ -664,10 +664,10 @@ module KlaviyoAPI
664
664
  # Get the mapped metric with the given 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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metric.json)
665
665
  # @param id [String] The type of mapping.
666
666
  # @param [Hash] opts the optional parameters
667
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
668
- # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
669
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
670
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
667
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
668
+ # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
669
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
670
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
671
671
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
672
672
  def get_mapped_metric_with_http_info(id, opts = {})
673
673
  if @api_client.config.debugging
@@ -711,7 +711,7 @@ module KlaviyoAPI
711
711
  # header parameters
712
712
  header_params = opts[:header_params] || {}
713
713
  # klaviyo api revision
714
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
714
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
715
715
  # HTTP header 'Accept' (if needed)
716
716
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
717
717
 
@@ -747,10 +747,10 @@ module KlaviyoAPI
747
747
  # Get Mapped Metrics
748
748
  # Get all mapped metrics in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metrics.json)
749
749
  # @param [Hash] opts the optional parameters
750
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
751
- # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
752
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
753
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
750
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
751
+ # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
752
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
753
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
754
754
  # @return [Hash<String, Object>]
755
755
  def get_mapped_metrics(opts = {})
756
756
  data, _status_code, _headers = get_mapped_metrics_with_http_info(opts)
@@ -760,10 +760,10 @@ module KlaviyoAPI
760
760
  # Get Mapped Metrics
761
761
  # Get all mapped metrics in an account.&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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metrics.json)
762
762
  # @param [Hash] opts the optional parameters
763
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
764
- # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
765
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
766
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
763
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
764
+ # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
765
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
766
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
767
767
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
768
768
  def get_mapped_metrics_with_http_info(opts = {})
769
769
  if @api_client.config.debugging
@@ -798,7 +798,7 @@ module KlaviyoAPI
798
798
  # header parameters
799
799
  header_params = opts[:header_params] || {}
800
800
  # klaviyo api revision
801
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
801
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
802
802
  # HTTP header 'Accept' (if needed)
803
803
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
804
804
 
@@ -835,9 +835,9 @@ module KlaviyoAPI
835
835
  # Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric.json)
836
836
  # @param id [String] Metric ID
837
837
  # @param [Hash] opts the optional parameters
838
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
839
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
840
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
838
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
839
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
840
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
841
841
  # @return [Hash<String, Object>]
842
842
  def get_metric(id, opts = {})
843
843
  data, _status_code, _headers = get_metric_with_http_info(id, opts)
@@ -848,9 +848,9 @@ module KlaviyoAPI
848
848
  # Get a metric with the given metric 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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric.json)
849
849
  # @param id [String] Metric ID
850
850
  # @param [Hash] opts the optional parameters
851
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
852
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
853
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
851
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
852
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
853
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
854
854
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
855
855
  def get_metric_with_http_info(id, opts = {})
856
856
  if @api_client.config.debugging
@@ -884,7 +884,7 @@ module KlaviyoAPI
884
884
  # header parameters
885
885
  header_params = opts[:header_params] || {}
886
886
  # klaviyo api revision
887
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
887
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
888
888
  # HTTP header 'Accept' (if needed)
889
889
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
890
890
 
@@ -921,7 +921,7 @@ module KlaviyoAPI
921
921
  # Get the metric for the given mapped metric ID (if applicable).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_mapped_metric.json)
922
922
  # @param id [String] The type of mapping.
923
923
  # @param [Hash] opts the optional parameters
924
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
924
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
925
925
  # @return [Hash<String, Object>]
926
926
  def get_metric_for_mapped_metric(id, opts = {})
927
927
  data, _status_code, _headers = get_metric_for_mapped_metric_with_http_info(id, opts)
@@ -935,7 +935,7 @@ module KlaviyoAPI
935
935
  # Get the metric for the given mapped metric ID (if applicable).&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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_mapped_metric.json)
936
936
  # @param id [String] The type of mapping.
937
937
  # @param [Hash] opts the optional parameters
938
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
938
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
939
939
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
940
940
  def get_metric_for_mapped_metric_with_http_info(id, opts = {})
941
941
  if @api_client.config.debugging
@@ -964,7 +964,7 @@ module KlaviyoAPI
964
964
  # header parameters
965
965
  header_params = opts[:header_params] || {}
966
966
  # klaviyo api revision
967
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
967
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
968
968
  # HTTP header 'Accept' (if needed)
969
969
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
970
970
 
@@ -1004,7 +1004,7 @@ module KlaviyoAPI
1004
1004
  # Get the metric for the given metric property ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_metric_property.json)
1005
1005
  # @param id [String] The ID of the metric property
1006
1006
  # @param [Hash] opts the optional parameters
1007
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1007
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1008
1008
  # @return [Hash<String, Object>]
1009
1009
  def get_metric_for_metric_property(id, opts = {})
1010
1010
  data, _status_code, _headers = get_metric_for_metric_property_with_http_info(id, opts)
@@ -1018,7 +1018,7 @@ module KlaviyoAPI
1018
1018
  # Get the metric for the given metric property 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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_metric_property.json)
1019
1019
  # @param id [String] The ID of the metric property
1020
1020
  # @param [Hash] opts the optional parameters
1021
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1021
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1022
1022
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1023
1023
  def get_metric_for_metric_property_with_http_info(id, opts = {})
1024
1024
  if @api_client.config.debugging
@@ -1042,7 +1042,7 @@ module KlaviyoAPI
1042
1042
  # header parameters
1043
1043
  header_params = opts[:header_params] || {}
1044
1044
  # klaviyo api revision
1045
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1045
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1046
1046
  # HTTP header 'Accept' (if needed)
1047
1047
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1048
1048
 
@@ -1118,7 +1118,7 @@ module KlaviyoAPI
1118
1118
  # header parameters
1119
1119
  header_params = opts[:header_params] || {}
1120
1120
  # klaviyo api revision
1121
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1121
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1122
1122
  # HTTP header 'Accept' (if needed)
1123
1123
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1124
1124
 
@@ -1189,7 +1189,7 @@ module KlaviyoAPI
1189
1189
  # header parameters
1190
1190
  header_params = opts[:header_params] || {}
1191
1191
  # klaviyo api revision
1192
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1192
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1193
1193
  # HTTP header 'Accept' (if needed)
1194
1194
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1195
1195
 
@@ -1260,7 +1260,7 @@ module KlaviyoAPI
1260
1260
  # header parameters
1261
1261
  header_params = opts[:header_params] || {}
1262
1262
  # klaviyo api revision
1263
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1263
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1264
1264
  # HTTP header 'Accept' (if needed)
1265
1265
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1266
1266
 
@@ -1301,9 +1301,9 @@ module KlaviyoAPI
1301
1301
  # @param id [String] The ID of the metric property
1302
1302
  # @param [Hash] opts the optional parameters
1303
1303
  # @option opts [Array<String>] :additional_fields_metric_property Request additional fields not included by default in the response. Supported values: &#39;sample_values&#39;
1304
- # @option opts [Array<String>] :fields_metric_property For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1305
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1306
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
1304
+ # @option opts [Array<String>] :fields_metric_property For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1305
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1306
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1307
1307
  # @return [Hash<String, Object>]
1308
1308
  def get_metric_property(id, opts = {})
1309
1309
  data, _status_code, _headers = get_metric_property_with_http_info(id, opts)
@@ -1315,9 +1315,9 @@ module KlaviyoAPI
1315
1315
  # @param id [String] The ID of the metric property
1316
1316
  # @param [Hash] opts the optional parameters
1317
1317
  # @option opts [Array<String>] :additional_fields_metric_property Request additional fields not included by default in the response. Supported values: &#39;sample_values&#39;
1318
- # @option opts [Array<String>] :fields_metric_property For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1319
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1320
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
1318
+ # @option opts [Array<String>] :fields_metric_property For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1319
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1320
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1321
1321
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1322
1322
  def get_metric_property_with_http_info(id, opts = {})
1323
1323
  if @api_client.config.debugging
@@ -1356,7 +1356,7 @@ module KlaviyoAPI
1356
1356
  # header parameters
1357
1357
  header_params = opts[:header_params] || {}
1358
1358
  # klaviyo api revision
1359
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1359
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1360
1360
  # HTTP header 'Accept' (if needed)
1361
1361
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1362
1362
 
@@ -1392,11 +1392,11 @@ module KlaviyoAPI
1392
1392
  # Get Metrics
1393
1393
  # Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics.json)
1394
1394
  # @param [Hash] opts the optional parameters
1395
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1396
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1397
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
1398
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
1399
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
1395
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1396
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1397
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60; (string)&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60; (string)
1398
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1399
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
1400
1400
  # @return [Hash<String, Object>]
1401
1401
  def get_metrics(opts = {})
1402
1402
  data, _status_code, _headers = get_metrics_with_http_info(opts)
@@ -1406,11 +1406,11 @@ module KlaviyoAPI
1406
1406
  # Get Metrics
1407
1407
  # Get all metrics in an account. Requests can be filtered by the following fields: integration &#x60;name&#x60;, integration &#x60;category&#x60; Returns a maximum of 200 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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics.json)
1408
1408
  # @param [Hash] opts the optional parameters
1409
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1410
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1411
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
1412
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#relationships
1413
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#pagination
1409
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1410
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1411
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60; (string)&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60; (string)
1412
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships
1413
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination
1414
1414
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1415
1415
  def get_metrics_with_http_info(opts = {})
1416
1416
  if @api_client.config.debugging
@@ -1442,7 +1442,7 @@ module KlaviyoAPI
1442
1442
  # header parameters
1443
1443
  header_params = opts[:header_params] || {}
1444
1444
  # klaviyo api revision
1445
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1445
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1446
1446
  # HTTP header 'Accept' (if needed)
1447
1447
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1448
1448
 
@@ -1479,7 +1479,7 @@ module KlaviyoAPI
1479
1479
  # Get all metrics for the given custom metric ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics_for_custom_metric.json)
1480
1480
  # @param id [String] The ID of the custom metric
1481
1481
  # @param [Hash] opts the optional parameters
1482
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1482
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1483
1483
  # @return [Hash<String, Object>]
1484
1484
  def get_metrics_for_custom_metric(id, opts = {})
1485
1485
  data, _status_code, _headers = get_metrics_for_custom_metric_with_http_info(id, opts)
@@ -1493,7 +1493,7 @@ module KlaviyoAPI
1493
1493
  # Get all metrics for the given custom metric 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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics_for_custom_metric.json)
1494
1494
  # @param id [String] The ID of the custom metric
1495
1495
  # @param [Hash] opts the optional parameters
1496
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1496
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1497
1497
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1498
1498
  def get_metrics_for_custom_metric_with_http_info(id, opts = {})
1499
1499
  if @api_client.config.debugging
@@ -1517,7 +1517,7 @@ module KlaviyoAPI
1517
1517
  # header parameters
1518
1518
  header_params = opts[:header_params] || {}
1519
1519
  # klaviyo api revision
1520
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1520
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1521
1521
  # HTTP header 'Accept' (if needed)
1522
1522
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1523
1523
 
@@ -1558,7 +1558,7 @@ module KlaviyoAPI
1558
1558
  # @param id [String] The ID of the metric
1559
1559
  # @param [Hash] opts the optional parameters
1560
1560
  # @option opts [Array<String>] :additional_fields_metric_property Request additional fields not included by default in the response. Supported values: &#39;sample_values&#39;
1561
- # @option opts [Array<String>] :fields_metric_property For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1561
+ # @option opts [Array<String>] :fields_metric_property For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1562
1562
  # @return [Hash<String, Object>]
1563
1563
  def get_properties_for_metric(id, opts = {})
1564
1564
  data, _status_code, _headers = get_properties_for_metric_with_http_info(id, opts)
@@ -1576,7 +1576,7 @@ module KlaviyoAPI
1576
1576
  # @param id [String] The ID of the metric
1577
1577
  # @param [Hash] opts the optional parameters
1578
1578
  # @option opts [Array<String>] :additional_fields_metric_property Request additional fields not included by default in the response. Supported values: &#39;sample_values&#39;
1579
- # @option opts [Array<String>] :fields_metric_property For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1579
+ # @option opts [Array<String>] :fields_metric_property For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1580
1580
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1581
1581
  def get_properties_for_metric_with_http_info(id, opts = {})
1582
1582
  if @api_client.config.debugging
@@ -1605,7 +1605,7 @@ module KlaviyoAPI
1605
1605
  # header parameters
1606
1606
  header_params = opts[:header_params] || {}
1607
1607
  # klaviyo api revision
1608
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1608
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1609
1609
  # HTTP header 'Accept' (if needed)
1610
1610
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1611
1611
 
@@ -1682,7 +1682,7 @@ module KlaviyoAPI
1682
1682
  # header parameters
1683
1683
  header_params = opts[:header_params] || {}
1684
1684
  # klaviyo api revision
1685
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1685
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1686
1686
  # HTTP header 'Accept' (if needed)
1687
1687
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1688
1688
 
@@ -1725,7 +1725,7 @@ module KlaviyoAPI
1725
1725
  # Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your `POST` request. To request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview). Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). For a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `metrics:read` [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_metric_aggregates.json)
1726
1726
  # @param metric_aggregate_query [MetricAggregateQuery] Retrieve Metric Aggregations
1727
1727
  # @param [Hash] opts the optional parameters
1728
- # @option opts [Array<String>] :fields_metric_aggregate For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1728
+ # @option opts [Array<String>] :fields_metric_aggregate For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1729
1729
  # @return [Hash<String, Object>]
1730
1730
  def query_metric_aggregates(metric_aggregate_query, opts = {})
1731
1731
  data, _status_code, _headers = query_metric_aggregates_with_http_info(metric_aggregate_query, opts)
@@ -1739,7 +1739,7 @@ module KlaviyoAPI
1739
1739
  # Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your &#x60;POST&#x60; request. To request campaign and flow performance data that matches the data shown in Klaviyo&#39;s UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview). Results can be filtered and grouped by time, event, or profile dimensions. To learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint). For a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).&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;metrics:read&#x60; [OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_metric_aggregates.json)
1740
1740
  # @param metric_aggregate_query [MetricAggregateQuery] Retrieve Metric Aggregations
1741
1741
  # @param [Hash] opts the optional parameters
1742
- # @option opts [Array<String>] :fields_metric_aggregate For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1742
+ # @option opts [Array<String>] :fields_metric_aggregate For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1743
1743
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1744
1744
  def query_metric_aggregates_with_http_info(metric_aggregate_query, opts = {})
1745
1745
  if @api_client.config.debugging
@@ -1763,7 +1763,7 @@ module KlaviyoAPI
1763
1763
  # header parameters
1764
1764
  header_params = opts[:header_params] || {}
1765
1765
  # klaviyo api revision
1766
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1766
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1767
1767
  # HTTP header 'Accept' (if needed)
1768
1768
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1769
1769
  # HTTP header 'Content-Type'
@@ -1809,7 +1809,7 @@ module KlaviyoAPI
1809
1809
  # @param id [String] The ID of the custom metric
1810
1810
  # @param custom_metric_partial_update_query [CustomMetricPartialUpdateQuery] Update a custom metric by ID.
1811
1811
  # @param [Hash] opts the optional parameters
1812
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1812
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1813
1813
  # @return [Hash<String, Object>]
1814
1814
  def update_custom_metric(id, custom_metric_partial_update_query, opts = {})
1815
1815
  data, _status_code, _headers = update_custom_metric_with_http_info(id, custom_metric_partial_update_query, opts)
@@ -1821,7 +1821,7 @@ module KlaviyoAPI
1821
1821
  # @param id [String] The ID of the custom metric
1822
1822
  # @param custom_metric_partial_update_query [CustomMetricPartialUpdateQuery] Update a custom metric by ID.
1823
1823
  # @param [Hash] opts the optional parameters
1824
- # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1824
+ # @option opts [Array<String>] :fields_custom_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1825
1825
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1826
1826
  def update_custom_metric_with_http_info(id, custom_metric_partial_update_query, opts = {})
1827
1827
  if @api_client.config.debugging
@@ -1849,7 +1849,7 @@ module KlaviyoAPI
1849
1849
  # header parameters
1850
1850
  header_params = opts[:header_params] || {}
1851
1851
  # klaviyo api revision
1852
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1852
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1853
1853
  # HTTP header 'Accept' (if needed)
1854
1854
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1855
1855
  # HTTP header 'Content-Type'
@@ -1892,7 +1892,7 @@ module KlaviyoAPI
1892
1892
  # @param id [String] The type of mapping.
1893
1893
  # @param mapped_metric_partial_update_query [MappedMetricPartialUpdateQuery] Update a mapped metric by ID
1894
1894
  # @param [Hash] opts the optional parameters
1895
- # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1895
+ # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1896
1896
  # @return [Hash<String, Object>]
1897
1897
  def update_mapped_metric(id, mapped_metric_partial_update_query, opts = {})
1898
1898
  data, _status_code, _headers = update_mapped_metric_with_http_info(id, mapped_metric_partial_update_query, opts)
@@ -1904,7 +1904,7 @@ module KlaviyoAPI
1904
1904
  # @param id [String] The type of mapping.
1905
1905
  # @param mapped_metric_partial_update_query [MappedMetricPartialUpdateQuery] Update a mapped metric by ID
1906
1906
  # @param [Hash] opts the optional parameters
1907
- # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-07-15/reference/api-overview#sparse-fieldsets
1907
+ # @option opts [Array<String>] :fields_mapped_metric For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets
1908
1908
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1909
1909
  def update_mapped_metric_with_http_info(id, mapped_metric_partial_update_query, opts = {})
1910
1910
  if @api_client.config.debugging
@@ -1937,7 +1937,7 @@ module KlaviyoAPI
1937
1937
  # header parameters
1938
1938
  header_params = opts[:header_params] || {}
1939
1939
  # klaviyo api revision
1940
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
1940
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-10-15"
1941
1941
  # HTTP header 'Accept' (if needed)
1942
1942
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1943
1943
  # HTTP header 'Content-Type'