klaviyo-api-sdk 11.1.0 → 12.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 (787) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +355 -279
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +387 -142
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +323 -231
  8. data/lib/klaviyo-api-sdk/api/coupons_api.rb +67 -64
  9. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  10. data/lib/klaviyo-api-sdk/api/events_api.rb +35 -35
  11. data/lib/klaviyo-api-sdk/api/flows_api.rb +281 -191
  12. data/lib/klaviyo-api-sdk/api/forms_api.rb +57 -37
  13. data/lib/klaviyo-api-sdk/api/images_api.rb +16 -16
  14. data/lib/klaviyo-api-sdk/api/lists_api.rb +68 -68
  15. data/lib/klaviyo-api-sdk/api/metrics_api.rb +39 -39
  16. data/lib/klaviyo-api-sdk/api/profiles_api.rb +98 -98
  17. data/lib/klaviyo-api-sdk/api/reporting_api.rb +14 -14
  18. data/lib/klaviyo-api-sdk/api/reviews_api.rb +99 -23
  19. data/lib/klaviyo-api-sdk/api/segments_api.rb +60 -60
  20. data/lib/klaviyo-api-sdk/api/tags_api.rb +59 -59
  21. data/lib/klaviyo-api-sdk/api/templates_api.rb +33 -33
  22. data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +10 -10
  23. data/lib/klaviyo-api-sdk/api/webhooks_api.rb +16 -16
  24. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  25. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  26. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  27. data/lib/klaviyo-api-sdk/models/ab_test_action.rb +265 -0
  28. data/lib/klaviyo-api-sdk/models/ab_test_enum.rb +36 -0
  29. data/lib/klaviyo-api-sdk/models/alltime_date_filter.rb +1 -1
  30. data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
  31. data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
  32. data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
  33. data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
  34. data/lib/klaviyo-api-sdk/models/{audiences_sub_object.rb → audiences.rb} +9 -5
  35. data/lib/klaviyo-api-sdk/models/audiences_update.rb +236 -0
  36. data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action.rb +255 -0
  37. data/lib/klaviyo-api-sdk/models/back_in_stock_delay_enum.rb +36 -0
  38. data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
  39. data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
  40. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  41. data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
  42. data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
  43. data/lib/klaviyo-api-sdk/models/block_display_options.rb +1 -1
  44. data/lib/klaviyo-api-sdk/models/block_enum.rb +1 -1
  45. data/lib/klaviyo-api-sdk/models/boolean_branch_links.rb +230 -0
  46. data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
  47. data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
  48. data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
  49. data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
  50. data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
  51. data/lib/klaviyo-api-sdk/models/branch_action.rb +265 -0
  52. data/lib/klaviyo-api-sdk/models/branch_enum.rb +36 -0
  53. data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
  54. data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
  55. data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
  56. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  57. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
  58. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
  59. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  60. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
  61. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +4 -3
  62. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  63. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +4 -3
  64. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_strategy.rb +108 -0
  65. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +3 -3
  66. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  67. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  68. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +6 -1
  69. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +6 -1
  70. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
  71. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
  72. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +14 -5
  73. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +11 -42
  74. data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_content.rb → campaign_message_create_query_resource_object_attributes_definition.rb} +5 -5
  75. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships.rb +219 -0
  76. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image.rb +219 -0
  77. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_relationships_image_data.rb +239 -0
  78. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  79. data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query.rb +224 -0
  80. data/lib/klaviyo-api-sdk/models/campaign_message_image_update_query_data.rb +239 -0
  81. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  82. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +14 -5
  83. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +9 -29
  84. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +107 -0
  85. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  86. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +4 -3
  88. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +108 -0
  89. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  90. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
  91. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  93. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +2 -2
  104. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  111. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
  112. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  113. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +2 -2
  119. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  120. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
  121. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  126. data/lib/klaviyo-api-sdk/models/{catalog_category_create_query_resource_object_relationships_items_data_inner.rb → catalog_category_item_op_data_inner.rb} +4 -4
  127. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  137. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
  145. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  152. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  157. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +6 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +6 -1
  172. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  178. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  185. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/code_action.rb +265 -0
  190. data/lib/klaviyo-api-sdk/models/code_enum.rb +36 -0
  191. data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
  192. data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/conditional_branch_action.rb +264 -0
  194. data/lib/klaviyo-api-sdk/models/conditional_branch_action_data.rb +224 -0
  195. data/lib/klaviyo-api-sdk/models/conditional_split_enum.rb +36 -0
  196. data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/content_repeat.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/countdown_delay_action.rb +269 -0
  201. data/lib/klaviyo-api-sdk/models/countdown_delay_action_data.rb +312 -0
  202. data/lib/klaviyo-api-sdk/models/countdown_delay_enum.rb +36 -0
  203. data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
  206. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
  207. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
  208. data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +6 -1
  210. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +6 -1
  212. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
  213. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
  214. data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
  215. data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
  216. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
  217. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
  218. data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
  222. data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
  223. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +395 -0
  226. data/lib/klaviyo-api-sdk/models/custom_object_enum.rb +36 -0
  227. data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
  230. data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  235. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  236. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/deep_link_enum.rb +36 -0
  240. data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
  242. data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +1 -1
  243. data/lib/klaviyo-api-sdk/models/{email_content_sub_object.rb → email_content.rb} +4 -4
  244. data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
  245. data/lib/klaviyo-api-sdk/models/email_message_definition.rb +244 -0
  246. data/lib/klaviyo-api-sdk/models/email_send_options.rb +223 -0
  247. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object.rb → email_tracking_options.rb} +50 -38
  249. data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +1 -1
  250. data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
  252. data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
  253. data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
  261. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/fake_enum.rb +36 -0
  275. data/lib/klaviyo-api-sdk/models/false_or_misleading_enum.rb +36 -0
  276. data/lib/klaviyo-api-sdk/models/featured_enum.rb +36 -0
  277. data/lib/klaviyo-api-sdk/models/{sto_schedule_options.rb → flow_create_query.rb} +14 -15
  278. data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object.rb +238 -0
  279. data/lib/klaviyo-api-sdk/models/flow_create_query_resource_object_attributes.rb +239 -0
  280. data/lib/klaviyo-api-sdk/models/flow_definition.rb +269 -0
  281. data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +122 -0
  282. data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +111 -0
  283. data/lib/klaviyo-api-sdk/models/flow_email.rb +364 -0
  284. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/flow_internal_alert.rb +286 -0
  286. data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +394 -0
  287. data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
  288. data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
  289. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +2 -2
  291. data/lib/klaviyo-api-sdk/models/flow_sms.rb +386 -0
  292. data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/flow_tracking_setting_static_param.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +2 -2
  301. data/lib/klaviyo-api-sdk/models/flow_webhook.rb +259 -0
  302. data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +294 -0
  303. data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
  304. data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
  305. data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +1 -1
  306. data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +1 -1
  307. data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +1 -1
  308. data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +1 -1
  309. data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +1 -1
  310. data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +1 -1
  311. data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +1 -1
  312. data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +1 -1
  313. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
  314. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
  315. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
  316. data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
  317. data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
  318. data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
  319. data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
  320. data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
  321. data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
  322. data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
  323. data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
  324. data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
  325. data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
  326. data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
  327. data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
  328. data/lib/klaviyo-api-sdk/models/html_block.rb +1 -1
  329. data/lib/klaviyo-api-sdk/models/html_block_data.rb +1 -1
  330. data/lib/klaviyo-api-sdk/models/html_enum.rb +1 -1
  331. data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
  332. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
  333. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
  334. data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
  335. data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
  336. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
  337. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
  338. data/lib/klaviyo-api-sdk/models/immediate_enum.rb +36 -0
  339. data/lib/klaviyo-api-sdk/models/immediate_send_strategy.rb +224 -0
  340. data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
  341. data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
  342. data/lib/klaviyo-api-sdk/models/in_the_last_base_relative_date_filter.rb +301 -0
  343. data/lib/klaviyo-api-sdk/models/in_the_last_enum.rb +36 -0
  344. data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
  345. data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/{send_strategy_sub_object.rb → internal_service_action.rb} +46 -33
  348. data/lib/klaviyo-api-sdk/models/internal_service_enum.rb +36 -0
  349. data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
  350. data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
  351. data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
  353. data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
  354. data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
  355. data/lib/klaviyo-api-sdk/models/link.rb +220 -0
  356. data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
  358. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
  360. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
  363. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  364. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  365. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  366. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  367. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/list_set_filter.rb +1 -1
  369. data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +1 -1
  370. data/lib/klaviyo-api-sdk/models/list_trigger.rb +234 -0
  371. data/lib/klaviyo-api-sdk/models/list_update_action.rb +269 -0
  372. data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → list_update_action_data.rb} +34 -43
  373. data/lib/klaviyo-api-sdk/models/list_update_enum.rb +36 -0
  374. data/lib/klaviyo-api-sdk/models/{static_schedule_options.rb → local_static_send.rb} +46 -22
  375. data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +262 -0
  376. data/lib/klaviyo-api-sdk/models/low_inventory_condition_filter.rb +226 -0
  377. data/lib/klaviyo-api-sdk/models/low_inventory_condition_group.rb +226 -0
  378. data/lib/klaviyo-api-sdk/models/low_inventory_enum.rb +36 -0
  379. data/lib/klaviyo-api-sdk/models/low_inventory_property_enum.rb +36 -0
  380. data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +328 -0
  381. data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
  382. data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
  383. data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
  384. data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
  385. data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
  386. data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
  387. data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
  388. data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
  389. data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
  390. data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
  391. data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
  392. data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
  393. data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
  394. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  395. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  396. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
  397. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
  398. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
  399. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
  400. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  401. data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +266 -0
  402. data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +118 -0
  403. data/lib/klaviyo-api-sdk/models/metric_property_condition_group.rb +226 -0
  404. data/lib/klaviyo-api-sdk/models/metric_property_enum.rb +36 -0
  405. data/lib/klaviyo-api-sdk/models/metric_trigger.rb +243 -0
  406. data/lib/klaviyo-api-sdk/models/mobile_push_badge.rb +259 -0
  407. data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +247 -0
  408. data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +243 -0
  409. data/lib/klaviyo-api-sdk/models/mobile_push_enum.rb +36 -0
  410. data/lib/klaviyo-api-sdk/models/mobile_push_message_standard_definition_create.rb +261 -0
  411. data/lib/klaviyo-api-sdk/models/{sms_tracking_options_sub_object.rb → mobile_push_message_standard_definition_update.rb} +40 -23
  412. data/lib/klaviyo-api-sdk/models/mobile_push_no_badge.rb +259 -0
  413. data/lib/klaviyo-api-sdk/models/mobile_push_options.rb +243 -0
  414. data/lib/klaviyo-api-sdk/models/{email_tracking_options_sub_object_custom_tracking_params_inner.rb → mobile_push_options_badge.rb} +5 -4
  415. data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +105 -0
  416. data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
  417. data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
  418. data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
  419. data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
  420. data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
  421. data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
  422. data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
  423. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
  424. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
  425. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
  426. data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
  427. data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
  428. data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
  429. data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
  430. data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
  431. data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
  432. data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
  433. data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
  434. data/lib/klaviyo-api-sdk/models/non_local_static_send.rb +259 -0
  435. data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
  436. data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
  437. data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
  438. data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
  439. data/lib/klaviyo-api-sdk/models/numeric_range_filter.rb +301 -0
  440. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
  441. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -1
  442. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  443. data/lib/klaviyo-api-sdk/models/open_app_enum.rb +36 -0
  444. data/lib/klaviyo-api-sdk/models/other_enum.rb +36 -0
  445. data/lib/klaviyo-api-sdk/models/pending_enum.rb +36 -0
  446. data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
  447. data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
  448. data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
  449. data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +262 -0
  450. data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +226 -0
  451. data/lib/klaviyo-api-sdk/models/price_drop_condition_group.rb +226 -0
  452. data/lib/klaviyo-api-sdk/models/price_drop_enum.rb +36 -0
  453. data/lib/klaviyo-api-sdk/models/price_drop_property_enum.rb +36 -0
  454. data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +349 -0
  455. data/lib/klaviyo-api-sdk/models/private_information_enum.rb +36 -0
  456. data/lib/klaviyo-api-sdk/models/profanity_or_inappropriate_enum.rb +36 -0
  457. data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
  458. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  459. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
  460. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
  461. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  462. data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
  463. data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
  464. data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
  465. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
  466. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
  467. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
  468. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
  469. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
  470. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
  471. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
  472. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
  473. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
  474. data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
  475. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  476. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  477. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
  478. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
  479. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
  480. data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
  481. data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
  482. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +6 -1
  483. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +6 -1
  484. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
  485. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
  486. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  487. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
  488. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  489. data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
  490. data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
  491. data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
  492. data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
  493. data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +1 -1
  494. data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
  495. data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +238 -0
  496. data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition_timeframe_filter.rb +105 -0
  497. data/lib/klaviyo-api-sdk/models/profile_not_in_flow_enum.rb +36 -0
  498. data/lib/klaviyo-api-sdk/models/profile_operation_delete.rb +273 -0
  499. data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_boolean.rb +301 -0
  500. data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date.rb +301 -0
  501. data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_date_property_value.rb +105 -0
  502. data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_list.rb +328 -0
  503. data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_numeric.rb +301 -0
  504. data/lib/klaviyo-api-sdk/models/profile_operation_update_or_create_string.rb +301 -0
  505. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  506. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
  507. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
  508. data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
  509. data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
  510. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
  511. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
  512. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
  513. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
  514. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
  515. data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
  516. data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
  517. data/lib/klaviyo-api-sdk/models/profile_property_date_trigger.rb +395 -0
  518. data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
  519. data/lib/klaviyo-api-sdk/models/profile_random_sample_condition.rb +238 -0
  520. data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
  521. data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
  522. data/lib/klaviyo-api-sdk/models/profile_sample_enum.rb +36 -0
  523. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  524. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  525. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
  526. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +8 -3
  527. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
  528. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +6 -1
  529. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  530. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  531. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
  532. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
  533. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
  534. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
  535. data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
  536. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
  537. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +1 -1
  538. data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
  539. data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
  540. data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
  541. data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
  542. data/lib/klaviyo-api-sdk/models/published_enum.rb +36 -0
  543. data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
  544. data/lib/klaviyo-api-sdk/models/push_on_open_app.rb +224 -0
  545. data/lib/klaviyo-api-sdk/models/push_on_open_deep_link.rb +246 -0
  546. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
  547. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -1
  548. data/lib/klaviyo-api-sdk/models/{email_send_options_sub_object.rb → push_send_options.rb} +7 -5
  549. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
  550. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
  551. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
  552. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
  553. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
  554. data/lib/klaviyo-api-sdk/models/reject_reason_fake.rb +224 -0
  555. data/lib/klaviyo-api-sdk/models/reject_reason_misleading.rb +224 -0
  556. data/lib/klaviyo-api-sdk/models/reject_reason_other.rb +235 -0
  557. data/lib/klaviyo-api-sdk/models/reject_reason_private_information.rb +224 -0
  558. data/lib/klaviyo-api-sdk/models/reject_reason_profanity.rb +224 -0
  559. data/lib/klaviyo-api-sdk/models/reject_reason_unrelated.rb +224 -0
  560. data/lib/klaviyo-api-sdk/models/rejected_enum.rb +36 -0
  561. data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
  562. data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
  563. data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
  564. data/lib/klaviyo-api-sdk/models/{render_options_sub_object.rb → render_options.rb} +4 -4
  565. data/lib/klaviyo-api-sdk/models/review_enum.rb +36 -0
  566. data/lib/klaviyo-api-sdk/models/review_patch_query.rb +224 -0
  567. data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object.rb +253 -0
  568. data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes.rb +220 -0
  569. data/lib/klaviyo-api-sdk/models/review_patch_query_resource_object_attributes_status.rb +109 -0
  570. data/lib/klaviyo-api-sdk/models/review_status_featured.rb +224 -0
  571. data/lib/klaviyo-api-sdk/models/review_status_pending.rb +224 -0
  572. data/lib/klaviyo-api-sdk/models/review_status_published.rb +224 -0
  573. data/lib/klaviyo-api-sdk/models/review_status_rejected.rb +238 -0
  574. data/lib/klaviyo-api-sdk/models/review_status_rejected_rejection_reason.rb +110 -0
  575. data/lib/klaviyo-api-sdk/models/review_status_unpublished.rb +224 -0
  576. data/lib/klaviyo-api-sdk/models/scheduled_enum.rb +36 -0
  577. data/lib/klaviyo-api-sdk/models/scheduled_trigger.rb +224 -0
  578. data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
  579. data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
  580. data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
  581. data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
  582. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  583. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  584. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
  585. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  586. data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +1 -1
  587. data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +1 -1
  588. data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +1 -1
  589. data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +1 -1
  590. data/lib/klaviyo-api-sdk/models/segment_trigger.rb +234 -0
  591. data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +1 -1
  592. data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +1 -1
  593. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +1 -1
  594. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +1 -1
  595. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
  596. data/lib/klaviyo-api-sdk/models/send_email_action.rb +264 -0
  597. data/lib/klaviyo-api-sdk/models/send_email_action_data.rb +271 -0
  598. data/lib/klaviyo-api-sdk/models/send_email_enum.rb +36 -0
  599. data/lib/klaviyo-api-sdk/models/send_internal_alert_action.rb +264 -0
  600. data/lib/klaviyo-api-sdk/models/send_internal_alert_action_data.rb +271 -0
  601. data/lib/klaviyo-api-sdk/models/send_internal_alert_enum.rb +36 -0
  602. data/lib/klaviyo-api-sdk/models/send_mobile_push_enum.rb +36 -0
  603. data/lib/klaviyo-api-sdk/models/send_push_notification_action.rb +264 -0
  604. data/lib/klaviyo-api-sdk/models/send_push_notification_action_data.rb +271 -0
  605. data/lib/klaviyo-api-sdk/models/send_sms_action.rb +264 -0
  606. data/lib/klaviyo-api-sdk/models/send_sms_action_data.rb +271 -0
  607. data/lib/klaviyo-api-sdk/models/send_sms_enum.rb +36 -0
  608. data/lib/klaviyo-api-sdk/models/send_webhook_action.rb +264 -0
  609. data/lib/klaviyo-api-sdk/models/send_webhook_action_data.rb +271 -0
  610. data/lib/klaviyo-api-sdk/models/send_webhook_enum.rb +36 -0
  611. data/lib/klaviyo-api-sdk/models/send_whats_app_action.rb +264 -0
  612. data/lib/klaviyo-api-sdk/models/send_whats_app_action_data.rb +271 -0
  613. data/lib/klaviyo-api-sdk/models/send_whatsapp_enum.rb +36 -0
  614. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  615. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +6 -1
  616. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
  617. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  618. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +6 -1
  619. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
  620. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
  621. data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
  622. data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
  623. data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
  624. data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
  625. data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
  626. data/lib/klaviyo-api-sdk/models/smart_send_time_enum.rb +36 -0
  627. data/lib/klaviyo-api-sdk/models/smart_send_time_strategy.rb +239 -0
  628. data/lib/klaviyo-api-sdk/models/{sms_content_sub_object_create.rb → sms_content_create.rb} +4 -4
  629. data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
  630. data/lib/klaviyo-api-sdk/models/sms_message_definition_create.rb +242 -0
  631. data/lib/klaviyo-api-sdk/models/{sms_send_options_sub_object.rb → sms_send_options.rb} +7 -5
  632. data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
  633. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +240 -0
  634. data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +1 -1
  635. data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
  636. data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
  637. data/lib/klaviyo-api-sdk/models/split_action.rb +255 -0
  638. data/lib/klaviyo-api-sdk/models/split_enum.rb +36 -0
  639. data/lib/klaviyo-api-sdk/models/split_links.rb +226 -0
  640. data/lib/klaviyo-api-sdk/models/standard_enum.rb +36 -0
  641. data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
  642. data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
  643. data/lib/klaviyo-api-sdk/models/static_enum.rb +1 -1
  644. data/lib/klaviyo-api-sdk/models/{throttled_schedule_options.rb → static_send_strategy.rb} +26 -17
  645. data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +106 -0
  646. data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
  647. data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
  648. data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
  649. data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
  650. data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
  651. data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
  652. data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
  653. data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
  654. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
  655. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  656. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
  657. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
  658. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  659. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
  660. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
  661. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  662. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  663. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
  664. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  665. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  666. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
  667. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  668. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  669. data/lib/klaviyo-api-sdk/models/subscription_parameters.rb +1 -1
  670. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  671. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
  672. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  673. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  674. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
  675. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
  676. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  677. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
  678. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
  679. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  680. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
  681. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
  682. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  683. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
  684. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  685. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  686. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
  687. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
  688. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  689. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  690. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  691. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
  692. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
  693. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  694. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
  695. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
  696. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  697. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  698. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  699. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  700. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
  701. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
  702. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  703. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  704. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
  705. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
  706. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  707. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  708. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  709. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  710. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  711. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
  712. data/lib/klaviyo-api-sdk/models/target_date_action.rb +269 -0
  713. data/lib/klaviyo-api-sdk/models/target_date_action_data.rb +276 -0
  714. data/lib/klaviyo-api-sdk/models/target_date_enum.rb +36 -0
  715. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  716. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
  717. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
  718. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  719. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
  720. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
  721. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  722. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  723. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
  724. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
  725. data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +1 -1
  726. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  727. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
  728. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
  729. data/lib/klaviyo-api-sdk/models/text_block.rb +1 -1
  730. data/lib/klaviyo-api-sdk/models/text_block_data.rb +1 -1
  731. data/lib/klaviyo-api-sdk/models/text_block_styles.rb +1 -1
  732. data/lib/klaviyo-api-sdk/models/text_enum.rb +1 -1
  733. data/lib/klaviyo-api-sdk/models/throttled_enum.rb +36 -0
  734. data/lib/klaviyo-api-sdk/models/throttled_send_strategy.rb +288 -0
  735. data/lib/klaviyo-api-sdk/models/time_delay_action.rb +269 -0
  736. data/lib/klaviyo-api-sdk/models/time_delay_action_data.rb +325 -0
  737. data/lib/klaviyo-api-sdk/models/time_delay_enum.rb +36 -0
  738. data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
  739. data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +1 -1
  740. data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +1 -1
  741. data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +1 -1
  742. data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +1 -1
  743. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +1 -1
  744. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +1 -1
  745. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +1 -1
  746. data/lib/klaviyo-api-sdk/models/trigger_branch_action.rb +264 -0
  747. data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +310 -0
  748. data/lib/klaviyo-api-sdk/models/trigger_split_enum.rb +36 -0
  749. data/lib/klaviyo-api-sdk/models/union_condition_group.rb +226 -0
  750. data/lib/klaviyo-api-sdk/models/union_condition_group_conditions_inner.rb +114 -0
  751. data/lib/klaviyo-api-sdk/models/union_filter.rb +226 -0
  752. data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
  753. data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
  754. data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +1 -1
  755. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +1 -1
  756. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +1 -1
  757. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +1 -1
  758. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +1 -1
  759. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +1 -1
  760. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +1 -1
  761. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +1 -1
  762. data/lib/klaviyo-api-sdk/models/unpublished_enum.rb +36 -0
  763. data/lib/klaviyo-api-sdk/models/unrelated_enum.rb +36 -0
  764. data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
  765. data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +1 -1
  766. data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +1 -1
  767. data/lib/klaviyo-api-sdk/models/update_profile_action.rb +264 -0
  768. data/lib/klaviyo-api-sdk/models/update_profile_action_data.rb +273 -0
  769. data/lib/klaviyo-api-sdk/models/update_profile_action_data_profile_operations_inner.rb +109 -0
  770. data/lib/klaviyo-api-sdk/models/update_profile_enum.rb +36 -0
  771. data/lib/klaviyo-api-sdk/models/utm_param.rb +238 -0
  772. data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → utm_param_info.rb} +17 -33
  773. data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
  774. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +6 -1
  775. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
  776. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +6 -1
  777. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
  778. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
  779. data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
  780. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
  781. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +2 -2
  782. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
  783. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_relationships.rb +219 -0
  784. data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
  785. data/lib/klaviyo-api-sdk/version.rb +1 -1
  786. data/lib/klaviyo-api-sdk.rb +188 -18
  787. metadata +189 -19
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
5
 
6
- The version of the OpenAPI document: 2024-10-15
6
+ The version of the OpenAPI document: 2025-01-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -54,7 +54,7 @@ module KlaviyoAPI
54
54
  # header parameters
55
55
  header_params = opts[:header_params] || {}
56
56
  # klaviyo api revision
57
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
57
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
58
58
  # HTTP header 'Accept' (if needed)
59
59
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
60
60
  # HTTP header 'Content-Type'
@@ -136,7 +136,7 @@ module KlaviyoAPI
136
136
  # header parameters
137
137
  header_params = opts[:header_params] || {}
138
138
  # klaviyo api revision
139
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
139
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
140
140
  # HTTP header 'Accept' (if needed)
141
141
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
142
142
  # HTTP header 'Content-Type'
@@ -209,7 +209,7 @@ module KlaviyoAPI
209
209
  # header parameters
210
210
  header_params = opts[:header_params] || {}
211
211
  # klaviyo api revision
212
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
212
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
213
213
  # HTTP header 'Accept' (if needed)
214
214
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
215
215
  # HTTP header 'Content-Type'
@@ -282,7 +282,7 @@ module KlaviyoAPI
282
282
  # header parameters
283
283
  header_params = opts[:header_params] || {}
284
284
  # klaviyo api revision
285
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
285
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
286
286
  # HTTP header 'Accept' (if needed)
287
287
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
288
288
  # HTTP header 'Content-Type'
@@ -355,7 +355,7 @@ module KlaviyoAPI
355
355
  # header parameters
356
356
  header_params = opts[:header_params] || {}
357
357
  # klaviyo api revision
358
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
358
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
359
359
  # HTTP header 'Accept' (if needed)
360
360
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
361
361
 
@@ -392,10 +392,10 @@ module KlaviyoAPI
392
392
  # Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
393
393
  # @param id [String] The campaign ID to be retrieved
394
394
  # @param [Hash] opts the optional parameters
395
- # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
396
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
397
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
398
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
395
+ # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
396
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
397
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
398
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
399
399
  # @return [Hash<String, Object>]
400
400
  def get_campaign(id, opts = {})
401
401
  data, _status_code, _headers = get_campaign_with_http_info(id, opts)
@@ -406,10 +406,10 @@ module KlaviyoAPI
406
406
  # Returns a specific campaign based on a required 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;campaigns:read&#x60;
407
407
  # @param id [String] The campaign ID to be retrieved
408
408
  # @param [Hash] opts the optional parameters
409
- # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
410
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
411
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
412
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
409
+ # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
410
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
411
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
412
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
413
413
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
414
414
  def get_campaign_with_http_info(id, opts = {})
415
415
  if @api_client.config.debugging
@@ -419,11 +419,11 @@ module KlaviyoAPI
419
419
  if @api_client.config.client_side_validation && id.nil?
420
420
  fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign"
421
421
  end
422
- allowable_values = ["label", "channel", "content", "content.subject", "content.preview_text", "content.from_email", "content.from_label", "content.reply_to_email", "content.cc_email", "content.bcc_email", "content.body", "content.media_url", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
422
+ allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.play_sound", "send_times", "created_at", "updated_at"]
423
423
  if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
424
424
  fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
425
425
  end
426
- allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
426
+ allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
427
427
  if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
428
428
  fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
429
429
  end
@@ -448,7 +448,7 @@ module KlaviyoAPI
448
448
  # header parameters
449
449
  header_params = opts[:header_params] || {}
450
450
  # klaviyo api revision
451
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
451
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
452
452
  # HTTP header 'Accept' (if needed)
453
453
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
454
454
 
@@ -485,7 +485,7 @@ module KlaviyoAPI
485
485
  # Return the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
486
486
  # @param id [String]
487
487
  # @param [Hash] opts the optional parameters
488
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
488
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
489
489
  # @return [Hash<String, Object>]
490
490
  def get_campaign_for_campaign_message(id, opts = {})
491
491
  data, _status_code, _headers = get_campaign_for_campaign_message_with_http_info(id, opts)
@@ -499,7 +499,7 @@ module KlaviyoAPI
499
499
  # Return the related campaign&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;campaigns:read&#x60;
500
500
  # @param id [String]
501
501
  # @param [Hash] opts the optional parameters
502
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
502
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
503
503
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
504
504
  def get_campaign_for_campaign_message_with_http_info(id, opts = {})
505
505
  if @api_client.config.debugging
@@ -509,7 +509,7 @@ module KlaviyoAPI
509
509
  if @api_client.config.client_side_validation && id.nil?
510
510
  fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_for_campaign_message"
511
511
  end
512
- allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
512
+ allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
513
513
  if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
514
514
  fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
515
515
  end
@@ -523,7 +523,7 @@ module KlaviyoAPI
523
523
  # header parameters
524
524
  header_params = opts[:header_params] || {}
525
525
  # klaviyo api revision
526
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
526
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
527
527
  # HTTP header 'Accept' (if needed)
528
528
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
529
529
 
@@ -594,7 +594,7 @@ module KlaviyoAPI
594
594
  # header parameters
595
595
  header_params = opts[:header_params] || {}
596
596
  # klaviyo api revision
597
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
597
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
598
598
  # HTTP header 'Accept' (if needed)
599
599
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
600
600
 
@@ -634,10 +634,11 @@ module KlaviyoAPI
634
634
  # Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
635
635
  # @param id [String] The message ID to be retrieved
636
636
  # @param [Hash] opts the optional parameters
637
- # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
638
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
639
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
640
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
637
+ # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
638
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
639
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
640
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
641
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
641
642
  # @return [Hash<String, Object>]
642
643
  def get_campaign_message(id, opts = {})
643
644
  data, _status_code, _headers = get_campaign_message_with_http_info(id, opts)
@@ -648,10 +649,11 @@ module KlaviyoAPI
648
649
  # Returns a specific message based on a required 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;campaigns:read&#x60;
649
650
  # @param id [String] The message ID to be retrieved
650
651
  # @param [Hash] opts the optional parameters
651
- # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
652
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
653
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
654
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
652
+ # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
653
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
654
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
655
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
656
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
655
657
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
656
658
  def get_campaign_message_with_http_info(id, opts = {})
657
659
  if @api_client.config.debugging
@@ -661,19 +663,23 @@ module KlaviyoAPI
661
663
  if @api_client.config.client_side_validation && id.nil?
662
664
  fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_message"
663
665
  end
664
- allowable_values = ["label", "channel", "content", "content.subject", "content.preview_text", "content.from_email", "content.from_label", "content.reply_to_email", "content.cc_email", "content.bcc_email", "content.body", "content.media_url", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
666
+ allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.play_sound", "send_times", "created_at", "updated_at"]
665
667
  if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
666
668
  fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
667
669
  end
668
- allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
670
+ allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
669
671
  if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
670
672
  fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
671
673
  end
674
+ allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"]
675
+ if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) }
676
+ fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
677
+ end
672
678
  allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
673
679
  if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
674
680
  fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
675
681
  end
676
- allowable_values = ["campaign", "template"]
682
+ allowable_values = ["campaign", "image", "template"]
677
683
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
678
684
  fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
679
685
  end
@@ -684,13 +690,14 @@ module KlaviyoAPI
684
690
  query_params = opts[:query_params] || {}
685
691
  query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
686
692
  query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
693
+ query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil?
687
694
  query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
688
695
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
689
696
 
690
697
  # header parameters
691
698
  header_params = opts[:header_params] || {}
692
699
  # klaviyo api revision
693
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
700
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
694
701
  # HTTP header 'Accept' (if needed)
695
702
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
696
703
 
@@ -727,7 +734,7 @@ module KlaviyoAPI
727
734
  # Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
728
735
  # @param id [String] The ID of the campaign for which to get the estimated number of recipients
729
736
  # @param [Hash] opts the optional parameters
730
- # @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
737
+ # @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
731
738
  # @return [Hash<String, Object>]
732
739
  def get_campaign_recipient_estimation(id, opts = {})
733
740
  data, _status_code, _headers = get_campaign_recipient_estimation_with_http_info(id, opts)
@@ -738,7 +745,7 @@ module KlaviyoAPI
738
745
  # Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the &#x60;Create Campaign Recipient Estimation Job&#x60; endpoint.&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;campaigns:read&#x60;
739
746
  # @param id [String] The ID of the campaign for which to get the estimated number of recipients
740
747
  # @param [Hash] opts the optional parameters
741
- # @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
748
+ # @option opts [Array<String>] :fields_campaign_recipient_estimation For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
742
749
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
743
750
  def get_campaign_recipient_estimation_with_http_info(id, opts = {})
744
751
  if @api_client.config.debugging
@@ -762,7 +769,7 @@ module KlaviyoAPI
762
769
  # header parameters
763
770
  header_params = opts[:header_params] || {}
764
771
  # klaviyo api revision
765
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
772
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
766
773
  # HTTP header 'Accept' (if needed)
767
774
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
768
775
 
@@ -799,7 +806,7 @@ module KlaviyoAPI
799
806
  # Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
800
807
  # @param id [String] The ID of the campaign to get recipient estimation status
801
808
  # @param [Hash] opts the optional parameters
802
- # @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
809
+ # @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
803
810
  # @return [Hash<String, Object>]
804
811
  def get_campaign_recipient_estimation_job(id, opts = {})
805
812
  data, _status_code, _headers = get_campaign_recipient_estimation_job_with_http_info(id, opts)
@@ -810,7 +817,7 @@ module KlaviyoAPI
810
817
  # Retrieve the status of a recipient estimation job triggered with the &#x60;Create Campaign Recipient Estimation Job&#x60; endpoint.&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;campaigns:read&#x60;
811
818
  # @param id [String] The ID of the campaign to get recipient estimation status
812
819
  # @param [Hash] opts the optional parameters
813
- # @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
820
+ # @option opts [Array<String>] :fields_campaign_recipient_estimation_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
814
821
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
815
822
  def get_campaign_recipient_estimation_job_with_http_info(id, opts = {})
816
823
  if @api_client.config.debugging
@@ -834,7 +841,7 @@ module KlaviyoAPI
834
841
  # header parameters
835
842
  header_params = opts[:header_params] || {}
836
843
  # klaviyo api revision
837
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
844
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
838
845
  # HTTP header 'Accept' (if needed)
839
846
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
840
847
 
@@ -871,7 +878,7 @@ module KlaviyoAPI
871
878
  # Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
872
879
  # @param id [String] The ID of the campaign to send
873
880
  # @param [Hash] opts the optional parameters
874
- # @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
881
+ # @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
875
882
  # @return [Hash<String, Object>]
876
883
  def get_campaign_send_job(id, opts = {})
877
884
  data, _status_code, _headers = get_campaign_send_job_with_http_info(id, opts)
@@ -882,7 +889,7 @@ module KlaviyoAPI
882
889
  # Get a campaign send job&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;campaigns:read&#x60;
883
890
  # @param id [String] The ID of the campaign to send
884
891
  # @param [Hash] opts the optional parameters
885
- # @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
892
+ # @option opts [Array<String>] :fields_campaign_send_job For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
886
893
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
887
894
  def get_campaign_send_job_with_http_info(id, opts = {})
888
895
  if @api_client.config.debugging
@@ -906,7 +913,7 @@ module KlaviyoAPI
906
913
  # header parameters
907
914
  header_params = opts[:header_params] || {}
908
915
  # klaviyo api revision
909
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
916
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
910
917
  # HTTP header 'Accept' (if needed)
911
918
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
912
919
 
@@ -939,49 +946,78 @@ module KlaviyoAPI
939
946
  return data, status_code, headers
940
947
  end
941
948
 
942
- # Get Campaign Tags
943
- # Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
944
- # @param id [String]
949
+ # Get Campaigns
950
+ # Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns. `?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
951
+ # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;messages.channel&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;scheduled_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
945
952
  # @param [Hash] opts the optional parameters
946
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
953
+ # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
954
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
955
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
956
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
957
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
958
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
947
959
  # @return [Hash<String, Object>]
948
- def get_campaign_tags(id, opts = {})
949
- data, _status_code, _headers = get_campaign_tags_with_http_info(id, opts)
960
+ def get_campaigns(filter, opts = {})
961
+ data, _status_code, _headers = get_campaigns_with_http_info(filter, opts)
950
962
  data
951
963
  end
952
964
 
953
- # alias of `get_campaign_tags`
954
- alias get_tags_for_campaign get_campaign_tags
955
-
956
- # Get Campaign Tags
957
- # Return all tags that belong to the given campaign.&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;campaigns:read&#x60; &#x60;tags:read&#x60;
958
- # @param id [String]
965
+ # Get Campaigns
966
+ # Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: &#x60;?filter&#x3D;equals(messages.channel,&#39;email&#39;)&#x60; to list email campaigns, or &#x60;?filter&#x3D;equals(messages.channel,&#39;sms&#39;)&#x60; to list SMS campaigns. &#x60;?filter&#x3D;equals(messages.channel,&#39;mobile_push&#39;)&#x60; to list mobile push campaigns.&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;campaigns:read&#x60;
967
+ # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;messages.channel&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;scheduled_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
959
968
  # @param [Hash] opts the optional parameters
960
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
969
+ # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
970
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
971
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
972
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
973
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#pagination
974
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sorting
961
975
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
962
- def get_campaign_tags_with_http_info(id, opts = {})
976
+ def get_campaigns_with_http_info(filter, opts = {})
963
977
  if @api_client.config.debugging
964
- @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaign_tags ...'
978
+ @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaigns ...'
965
979
  end
966
- # verify the required parameter 'id' is set
967
- if @api_client.config.client_side_validation && id.nil?
968
- fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_campaign_tags"
980
+ # verify the required parameter 'filter' is set
981
+ if @api_client.config.client_side_validation && filter.nil?
982
+ fail ArgumentError, "Missing the required parameter 'filter' when calling CampaignsApi.get_campaigns"
983
+ end
984
+ allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.play_sound", "send_times", "created_at", "updated_at"]
985
+ if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
986
+ fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
987
+ end
988
+ allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
989
+ if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
990
+ fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
969
991
  end
970
992
  allowable_values = ["name"]
971
993
  if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
972
994
  fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
973
995
  end
996
+ allowable_values = ["campaign-messages", "tags"]
997
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
998
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
999
+ end
1000
+ allowable_values = ["created_at", "-created_at", "id", "-id", "name", "-name", "scheduled_at", "-scheduled_at", "updated_at", "-updated_at"]
1001
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
1002
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
1003
+ end
974
1004
  # resource path
975
- local_var_path = '/api/campaigns/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1005
+ local_var_path = '/api/campaigns'
976
1006
 
977
1007
  # query parameters
978
1008
  query_params = opts[:query_params] || {}
1009
+ query_params[:'filter'] = filter
1010
+ query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
1011
+ query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
979
1012
  query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
1013
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1014
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
1015
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
980
1016
 
981
1017
  # header parameters
982
1018
  header_params = opts[:header_params] || {}
983
1019
  # klaviyo api revision
984
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1020
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
985
1021
  # HTTP header 'Accept' (if needed)
986
1022
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
987
1023
 
@@ -998,7 +1034,7 @@ module KlaviyoAPI
998
1034
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
999
1035
 
1000
1036
  new_options = opts.merge(
1001
- :operation => :"CampaignsApi.get_campaign_tags",
1037
+ :operation => :"CampaignsApi.get_campaigns",
1002
1038
  :header_params => header_params,
1003
1039
  :query_params => query_params,
1004
1040
  :form_params => form_params,
@@ -1009,86 +1045,125 @@ module KlaviyoAPI
1009
1045
 
1010
1046
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1011
1047
  if @api_client.config.debugging
1012
- @api_client.config.logger.debug "API called: CampaignsApi#get_campaign_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1048
+ @api_client.config.logger.debug "API called: CampaignsApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1013
1049
  end
1014
1050
  return data, status_code, headers
1015
1051
  end
1016
1052
 
1017
- # alias of `get_campaign_tags_with_http_info`
1018
- alias get_tags_for_campaign_with_http_info get_campaign_tags_with_http_info
1019
-
1020
- # Get Campaigns
1021
- # Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: `?filter=equals(messages.channel,'email')` to list email campaigns, or `?filter=equals(messages.channel,'sms')` to list SMS campaigns.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
1022
- # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;messages.channel&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;scheduled_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
1053
+ # Get Image for Campaign Message
1054
+ # Return the related image for a given campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `images:read`
1055
+ # @param id [String]
1023
1056
  # @param [Hash] opts the optional parameters
1024
- # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1025
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1026
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1027
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
1028
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1029
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
1057
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1030
1058
  # @return [Hash<String, Object>]
1031
- def get_campaigns(filter, opts = {})
1032
- data, _status_code, _headers = get_campaigns_with_http_info(filter, opts)
1059
+ def get_image_for_campaign_message(id, opts = {})
1060
+ data, _status_code, _headers = get_image_for_campaign_message_with_http_info(id, opts)
1033
1061
  data
1034
1062
  end
1035
1063
 
1036
- # Get Campaigns
1037
- # Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide either: &#x60;?filter&#x3D;equals(messages.channel,&#39;email&#39;)&#x60; to list email campaigns, or &#x60;?filter&#x3D;equals(messages.channel,&#39;sms&#39;)&#x60; to list SMS campaigns.&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;campaigns:read&#x60;
1038
- # @param filter [String] For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;messages.channel&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;scheduled_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
1064
+ # alias of `get_image_for_campaign_message`
1065
+ alias get_campaign_message_image get_image_for_campaign_message
1066
+
1067
+ # Get Image for Campaign Message
1068
+ # Return the related image for a given campaign message&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;campaigns:read&#x60; &#x60;images:read&#x60;
1069
+ # @param id [String]
1039
1070
  # @param [Hash] opts the optional parameters
1040
- # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1041
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1042
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1043
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
1044
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
1045
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
1071
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1046
1072
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1047
- def get_campaigns_with_http_info(filter, opts = {})
1073
+ def get_image_for_campaign_message_with_http_info(id, opts = {})
1048
1074
  if @api_client.config.debugging
1049
- @api_client.config.logger.debug 'Calling API: CampaignsApi.get_campaigns ...'
1050
- end
1051
- # verify the required parameter 'filter' is set
1052
- if @api_client.config.client_side_validation && filter.nil?
1053
- fail ArgumentError, "Missing the required parameter 'filter' when calling CampaignsApi.get_campaigns"
1075
+ @api_client.config.logger.debug 'Calling API: CampaignsApi.get_image_for_campaign_message ...'
1054
1076
  end
1055
- allowable_values = ["label", "channel", "content", "content.subject", "content.preview_text", "content.from_email", "content.from_label", "content.reply_to_email", "content.cc_email", "content.bcc_email", "content.body", "content.media_url", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
1056
- if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
1057
- fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
1077
+ # verify the required parameter 'id' is set
1078
+ if @api_client.config.client_side_validation && id.nil?
1079
+ fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_image_for_campaign_message"
1058
1080
  end
1059
- allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
1060
- if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
1061
- fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
1081
+ allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"]
1082
+ if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) }
1083
+ fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
1062
1084
  end
1063
- allowable_values = ["name"]
1064
- if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
1065
- fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
1085
+ # resource path
1086
+ local_var_path = '/api/campaign-messages/{id}/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1087
+
1088
+ # query parameters
1089
+ query_params = opts[:query_params] || {}
1090
+ query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil?
1091
+
1092
+ # header parameters
1093
+ header_params = opts[:header_params] || {}
1094
+ # klaviyo api revision
1095
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1096
+ # HTTP header 'Accept' (if needed)
1097
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1098
+
1099
+ # form parameters
1100
+ form_params = opts[:form_params] || {}
1101
+
1102
+ # http body (model)
1103
+ post_body = opts[:debug_body]
1104
+
1105
+ # return_type
1106
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1107
+
1108
+ # auth_names
1109
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1110
+
1111
+ new_options = opts.merge(
1112
+ :operation => :"CampaignsApi.get_image_for_campaign_message",
1113
+ :header_params => header_params,
1114
+ :query_params => query_params,
1115
+ :form_params => form_params,
1116
+ :body => post_body,
1117
+ :auth_names => auth_names,
1118
+ :return_type => return_type
1119
+ )
1120
+
1121
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1122
+ if @api_client.config.debugging
1123
+ @api_client.config.logger.debug "API called: CampaignsApi#get_image_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1066
1124
  end
1067
- allowable_values = ["campaign-messages", "tags"]
1068
- if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1069
- fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1125
+ return data, status_code, headers
1126
+ end
1127
+
1128
+ # alias of `get_image_for_campaign_message_with_http_info`
1129
+ alias get_campaign_message_image_with_http_info get_image_for_campaign_message_with_http_info
1130
+
1131
+ # Get Image ID for Campaign Message
1132
+ # Returns the ID of the related image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `images:read`
1133
+ # @param id [String]
1134
+ # @param [Hash] opts the optional parameters
1135
+ # @return [Hash<String, Object>]
1136
+ def get_image_id_for_campaign_message(id, opts = {})
1137
+ data, _status_code, _headers = get_image_id_for_campaign_message_with_http_info(id, opts)
1138
+ data
1139
+ end
1140
+
1141
+ # alias of `get_image_id_for_campaign_message`
1142
+ alias get_campaign_message_relationships_image get_image_id_for_campaign_message
1143
+
1144
+ # Get Image ID for Campaign Message
1145
+ # Returns the ID of the related image&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;campaigns:read&#x60; &#x60;images:read&#x60;
1146
+ # @param id [String]
1147
+ # @param [Hash] opts the optional parameters
1148
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1149
+ def get_image_id_for_campaign_message_with_http_info(id, opts = {})
1150
+ if @api_client.config.debugging
1151
+ @api_client.config.logger.debug 'Calling API: CampaignsApi.get_image_id_for_campaign_message ...'
1070
1152
  end
1071
- allowable_values = ["created_at", "-created_at", "id", "-id", "name", "-name", "scheduled_at", "-scheduled_at", "updated_at", "-updated_at"]
1072
- if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
1073
- fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
1153
+ # verify the required parameter 'id' is set
1154
+ if @api_client.config.client_side_validation && id.nil?
1155
+ fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_image_id_for_campaign_message"
1074
1156
  end
1075
1157
  # resource path
1076
- local_var_path = '/api/campaigns'
1158
+ local_var_path = '/api/campaign-messages/{id}/relationships/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1077
1159
 
1078
1160
  # query parameters
1079
1161
  query_params = opts[:query_params] || {}
1080
- query_params[:'filter'] = filter
1081
- query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
1082
- query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
1083
- query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
1084
- query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1085
- query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
1086
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1087
1162
 
1088
1163
  # header parameters
1089
1164
  header_params = opts[:header_params] || {}
1090
1165
  # klaviyo api revision
1091
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1166
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1092
1167
  # HTTP header 'Accept' (if needed)
1093
1168
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1094
1169
 
@@ -1105,7 +1180,7 @@ module KlaviyoAPI
1105
1180
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1106
1181
 
1107
1182
  new_options = opts.merge(
1108
- :operation => :"CampaignsApi.get_campaigns",
1183
+ :operation => :"CampaignsApi.get_image_id_for_campaign_message",
1109
1184
  :header_params => header_params,
1110
1185
  :query_params => query_params,
1111
1186
  :form_params => form_params,
@@ -1116,11 +1191,14 @@ module KlaviyoAPI
1116
1191
 
1117
1192
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1118
1193
  if @api_client.config.debugging
1119
- @api_client.config.logger.debug "API called: CampaignsApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1194
+ @api_client.config.logger.debug "API called: CampaignsApi#get_image_id_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1120
1195
  end
1121
1196
  return data, status_code, headers
1122
1197
  end
1123
1198
 
1199
+ # alias of `get_image_id_for_campaign_message_with_http_info`
1200
+ alias get_campaign_message_relationships_image_with_http_info get_image_id_for_campaign_message_with_http_info
1201
+
1124
1202
  # Get Message IDs for Campaign
1125
1203
  # Returns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
1126
1204
  # @param id [String]
@@ -1159,7 +1237,7 @@ module KlaviyoAPI
1159
1237
  # header parameters
1160
1238
  header_params = opts[:header_params] || {}
1161
1239
  # klaviyo api revision
1162
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1240
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1163
1241
  # HTTP header 'Accept' (if needed)
1164
1242
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1165
1243
 
@@ -1202,10 +1280,11 @@ module KlaviyoAPI
1202
1280
  # Return all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
1203
1281
  # @param id [String]
1204
1282
  # @param [Hash] opts the optional parameters
1205
- # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1206
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1207
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1208
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
1283
+ # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1284
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1285
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1286
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1287
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
1209
1288
  # @return [Hash<String, Object>]
1210
1289
  def get_messages_for_campaign(id, opts = {})
1211
1290
  data, _status_code, _headers = get_messages_for_campaign_with_http_info(id, opts)
@@ -1222,10 +1301,11 @@ module KlaviyoAPI
1222
1301
  # Return all messages that belong to the given campaign.&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;campaigns:read&#x60;
1223
1302
  # @param id [String]
1224
1303
  # @param [Hash] opts the optional parameters
1225
- # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1226
- # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1227
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1228
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
1304
+ # @option opts [Array<String>] :fields_campaign_message For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1305
+ # @option opts [Array<String>] :fields_campaign For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1306
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1307
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1308
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships
1229
1309
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1230
1310
  def get_messages_for_campaign_with_http_info(id, opts = {})
1231
1311
  if @api_client.config.debugging
@@ -1235,19 +1315,23 @@ module KlaviyoAPI
1235
1315
  if @api_client.config.client_side_validation && id.nil?
1236
1316
  fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_messages_for_campaign"
1237
1317
  end
1238
- allowable_values = ["label", "channel", "content", "content.subject", "content.preview_text", "content.from_email", "content.from_label", "content.reply_to_email", "content.cc_email", "content.bcc_email", "content.body", "content.media_url", "send_times", "render_options", "render_options.shorten_links", "render_options.add_org_prefix", "render_options.add_info_link", "render_options.add_opt_out_language", "created_at", "updated_at"]
1318
+ allowable_values = ["definition", "definition.channel", "definition.label", "definition.content", "definition.content.subject", "definition.content.preview_text", "definition.content.from_email", "definition.content.from_label", "definition.content.reply_to_email", "definition.content.cc_email", "definition.content.bcc_email", "definition.content.body", "definition.content.media_url", "definition.render_options", "definition.render_options.shorten_links", "definition.render_options.add_org_prefix", "definition.render_options.add_info_link", "definition.render_options.add_opt_out_language", "definition.notification_type", "definition.content.title", "definition.content.dynamic_image", "definition.options", "definition.options.on_open", "definition.options.on_open.type", "definition.options.on_open.ios_deep_link", "definition.options.on_open.android_deep_link", "definition.options.badge", "definition.options.badge.display", "definition.options.play_sound", "send_times", "created_at", "updated_at"]
1239
1319
  if @api_client.config.client_side_validation && opts[:'fields_campaign_message'] && !opts[:'fields_campaign_message'].all? { |item| allowable_values.include?(item) }
1240
1320
  fail ArgumentError, "invalid value for \"fields_campaign_message\", must include one of #{allowable_values}"
1241
1321
  end
1242
- allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_tracking_params", "tracking_options.custom_tracking_params", "tracking_options.is_tracking_clicks", "tracking_options.is_tracking_opens", "send_strategy", "send_strategy.method", "send_strategy.options_static", "send_strategy.options_static.datetime", "send_strategy.options_static.is_local", "send_strategy.options_static.send_past_recipients_immediately", "send_strategy.options_throttled", "send_strategy.options_throttled.datetime", "send_strategy.options_throttled.throttle_percentage", "send_strategy.options_sto", "send_strategy.options_sto.date", "created_at", "scheduled_at", "updated_at", "send_time"]
1322
+ allowable_values = ["name", "status", "archived", "audiences", "audiences.included", "audiences.excluded", "send_options", "send_options.use_smart_sending", "tracking_options", "tracking_options.add_utm", "tracking_options.utm_params", "tracking_options.is_tracking_opens", "tracking_options.is_tracking_clicks", "send_strategy", "send_strategy.method", "send_strategy.datetime", "send_strategy.options", "send_strategy.options.is_local", "send_strategy.options.send_past_recipients_immediately", "send_strategy.throttle_percentage", "send_strategy.date", "created_at", "scheduled_at", "updated_at", "send_time"]
1243
1323
  if @api_client.config.client_side_validation && opts[:'fields_campaign'] && !opts[:'fields_campaign'].all? { |item| allowable_values.include?(item) }
1244
1324
  fail ArgumentError, "invalid value for \"fields_campaign\", must include one of #{allowable_values}"
1245
1325
  end
1326
+ allowable_values = ["name", "image_url", "format", "size", "hidden", "updated_at"]
1327
+ if @api_client.config.client_side_validation && opts[:'fields_image'] && !opts[:'fields_image'].all? { |item| allowable_values.include?(item) }
1328
+ fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
1329
+ end
1246
1330
  allowable_values = ["name", "editor_type", "html", "text", "created", "updated"]
1247
1331
  if @api_client.config.client_side_validation && opts[:'fields_template'] && !opts[:'fields_template'].all? { |item| allowable_values.include?(item) }
1248
1332
  fail ArgumentError, "invalid value for \"fields_template\", must include one of #{allowable_values}"
1249
1333
  end
1250
- allowable_values = ["campaign", "template"]
1334
+ allowable_values = ["campaign", "image", "template"]
1251
1335
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
1252
1336
  fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
1253
1337
  end
@@ -1258,13 +1342,14 @@ module KlaviyoAPI
1258
1342
  query_params = opts[:query_params] || {}
1259
1343
  query_params[:'fields[campaign-message]'] = @api_client.build_collection_param(opts[:'fields_campaign_message'], :csv) if !opts[:'fields_campaign_message'].nil?
1260
1344
  query_params[:'fields[campaign]'] = @api_client.build_collection_param(opts[:'fields_campaign'], :csv) if !opts[:'fields_campaign'].nil?
1345
+ query_params[:'fields[image]'] = @api_client.build_collection_param(opts[:'fields_image'], :csv) if !opts[:'fields_image'].nil?
1261
1346
  query_params[:'fields[template]'] = @api_client.build_collection_param(opts[:'fields_template'], :csv) if !opts[:'fields_template'].nil?
1262
1347
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
1263
1348
 
1264
1349
  # header parameters
1265
1350
  header_params = opts[:header_params] || {}
1266
1351
  # klaviyo api revision
1267
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1352
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1268
1353
  # HTTP header 'Accept' (if needed)
1269
1354
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1270
1355
 
@@ -1338,7 +1423,7 @@ module KlaviyoAPI
1338
1423
  # header parameters
1339
1424
  header_params = opts[:header_params] || {}
1340
1425
  # klaviyo api revision
1341
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1426
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1342
1427
  # HTTP header 'Accept' (if needed)
1343
1428
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1344
1429
 
@@ -1374,11 +1459,89 @@ module KlaviyoAPI
1374
1459
  # alias of `get_tag_ids_for_campaign_with_http_info`
1375
1460
  alias get_campaign_relationships_tags_with_http_info get_tag_ids_for_campaign_with_http_info
1376
1461
 
1462
+ # Get Tags for Campaign
1463
+ # Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
1464
+ # @param id [String]
1465
+ # @param [Hash] opts the optional parameters
1466
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1467
+ # @return [Hash<String, Object>]
1468
+ def get_tags_for_campaign(id, opts = {})
1469
+ data, _status_code, _headers = get_tags_for_campaign_with_http_info(id, opts)
1470
+ data
1471
+ end
1472
+
1473
+ # alias of `get_tags_for_campaign`
1474
+ alias get_campaign_tags get_tags_for_campaign
1475
+
1476
+ # Get Tags for Campaign
1477
+ # Return all tags that belong to the given campaign.&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;campaigns:read&#x60; &#x60;tags:read&#x60;
1478
+ # @param id [String]
1479
+ # @param [Hash] opts the optional parameters
1480
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1481
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1482
+ def get_tags_for_campaign_with_http_info(id, opts = {})
1483
+ if @api_client.config.debugging
1484
+ @api_client.config.logger.debug 'Calling API: CampaignsApi.get_tags_for_campaign ...'
1485
+ end
1486
+ # verify the required parameter 'id' is set
1487
+ if @api_client.config.client_side_validation && id.nil?
1488
+ fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.get_tags_for_campaign"
1489
+ end
1490
+ allowable_values = ["name"]
1491
+ if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
1492
+ fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
1493
+ end
1494
+ # resource path
1495
+ local_var_path = '/api/campaigns/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1496
+
1497
+ # query parameters
1498
+ query_params = opts[:query_params] || {}
1499
+ query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
1500
+
1501
+ # header parameters
1502
+ header_params = opts[:header_params] || {}
1503
+ # klaviyo api revision
1504
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1505
+ # HTTP header 'Accept' (if needed)
1506
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1507
+
1508
+ # form parameters
1509
+ form_params = opts[:form_params] || {}
1510
+
1511
+ # http body (model)
1512
+ post_body = opts[:debug_body]
1513
+
1514
+ # return_type
1515
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
1516
+
1517
+ # auth_names
1518
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
1519
+
1520
+ new_options = opts.merge(
1521
+ :operation => :"CampaignsApi.get_tags_for_campaign",
1522
+ :header_params => header_params,
1523
+ :query_params => query_params,
1524
+ :form_params => form_params,
1525
+ :body => post_body,
1526
+ :auth_names => auth_names,
1527
+ :return_type => return_type
1528
+ )
1529
+
1530
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1531
+ if @api_client.config.debugging
1532
+ @api_client.config.logger.debug "API called: CampaignsApi#get_tags_for_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1533
+ end
1534
+ return data, status_code, headers
1535
+ end
1536
+
1537
+ # alias of `get_tags_for_campaign_with_http_info`
1538
+ alias get_campaign_tags_with_http_info get_tags_for_campaign_with_http_info
1539
+
1377
1540
  # Get Template for Campaign Message
1378
1541
  # Return the related template<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read` `templates:read`
1379
1542
  # @param id [String]
1380
1543
  # @param [Hash] opts the optional parameters
1381
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1544
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1382
1545
  # @return [Hash<String, Object>]
1383
1546
  def get_template_for_campaign_message(id, opts = {})
1384
1547
  data, _status_code, _headers = get_template_for_campaign_message_with_http_info(id, opts)
@@ -1392,7 +1555,7 @@ module KlaviyoAPI
1392
1555
  # Return the related template&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;campaigns:read&#x60; &#x60;templates:read&#x60;
1393
1556
  # @param id [String]
1394
1557
  # @param [Hash] opts the optional parameters
1395
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
1558
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets
1396
1559
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1397
1560
  def get_template_for_campaign_message_with_http_info(id, opts = {})
1398
1561
  if @api_client.config.debugging
@@ -1416,7 +1579,7 @@ module KlaviyoAPI
1416
1579
  # header parameters
1417
1580
  header_params = opts[:header_params] || {}
1418
1581
  # klaviyo api revision
1419
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1582
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1420
1583
  # HTTP header 'Accept' (if needed)
1421
1584
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1422
1585
 
@@ -1487,7 +1650,7 @@ module KlaviyoAPI
1487
1650
  # header parameters
1488
1651
  header_params = opts[:header_params] || {}
1489
1652
  # klaviyo api revision
1490
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1653
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1491
1654
  # HTTP header 'Accept' (if needed)
1492
1655
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1493
1656
 
@@ -1558,7 +1721,7 @@ module KlaviyoAPI
1558
1721
  # header parameters
1559
1722
  header_params = opts[:header_params] || {}
1560
1723
  # klaviyo api revision
1561
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1724
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1562
1725
  # HTTP header 'Accept' (if needed)
1563
1726
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1564
1727
  # HTTP header 'Content-Type'
@@ -1634,7 +1797,7 @@ module KlaviyoAPI
1634
1797
  # header parameters
1635
1798
  header_params = opts[:header_params] || {}
1636
1799
  # klaviyo api revision
1637
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1800
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1638
1801
  # HTTP header 'Accept' (if needed)
1639
1802
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1640
1803
  # HTTP header 'Content-Type'
@@ -1713,7 +1876,7 @@ module KlaviyoAPI
1713
1876
  # header parameters
1714
1877
  header_params = opts[:header_params] || {}
1715
1878
  # klaviyo api revision
1716
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1879
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1717
1880
  # HTTP header 'Accept' (if needed)
1718
1881
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1719
1882
  # HTTP header 'Content-Type'
@@ -1789,7 +1952,7 @@ module KlaviyoAPI
1789
1952
  # header parameters
1790
1953
  header_params = opts[:header_params] || {}
1791
1954
  # klaviyo api revision
1792
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
1955
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
1793
1956
  # HTTP header 'Accept' (if needed)
1794
1957
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
1795
1958
  # HTTP header 'Content-Type'
@@ -1826,5 +1989,87 @@ module KlaviyoAPI
1826
1989
  end
1827
1990
  return data, status_code, headers
1828
1991
  end
1992
+
1993
+ # Update Image for Campaign Message
1994
+ # Update a campaign message image<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write` `images:read`
1995
+ # @param id [String]
1996
+ # @param campaign_message_image_update_query [CampaignMessageImageUpdateQuery]
1997
+ # @param [Hash] opts the optional parameters
1998
+ # @return [nil]
1999
+ def update_image_for_campaign_message(id, campaign_message_image_update_query, opts = {})
2000
+ update_image_for_campaign_message_with_http_info(id, campaign_message_image_update_query, opts)
2001
+ nil
2002
+ end
2003
+
2004
+ # alias of `update_image_for_campaign_message`
2005
+ alias update_campaign_message_relationships_image update_image_for_campaign_message
2006
+
2007
+ # Update Image for Campaign Message
2008
+ # Update a campaign message image&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;campaigns:write&#x60; &#x60;images:read&#x60;
2009
+ # @param id [String]
2010
+ # @param campaign_message_image_update_query [CampaignMessageImageUpdateQuery]
2011
+ # @param [Hash] opts the optional parameters
2012
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2013
+ def update_image_for_campaign_message_with_http_info(id, campaign_message_image_update_query, opts = {})
2014
+ if @api_client.config.debugging
2015
+ @api_client.config.logger.debug 'Calling API: CampaignsApi.update_image_for_campaign_message ...'
2016
+ end
2017
+ # verify the required parameter 'id' is set
2018
+ if @api_client.config.client_side_validation && id.nil?
2019
+ fail ArgumentError, "Missing the required parameter 'id' when calling CampaignsApi.update_image_for_campaign_message"
2020
+ end
2021
+ # verify the required parameter 'campaign_message_image_update_query' is set
2022
+ if @api_client.config.client_side_validation && campaign_message_image_update_query.nil?
2023
+ fail ArgumentError, "Missing the required parameter 'campaign_message_image_update_query' when calling CampaignsApi.update_image_for_campaign_message"
2024
+ end
2025
+ # resource path
2026
+ local_var_path = '/api/campaign-messages/{id}/relationships/image'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2027
+
2028
+ # query parameters
2029
+ query_params = opts[:query_params] || {}
2030
+
2031
+ # header parameters
2032
+ header_params = opts[:header_params] || {}
2033
+ # klaviyo api revision
2034
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
2035
+ # HTTP header 'Accept' (if needed)
2036
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
2037
+ # HTTP header 'Content-Type'
2038
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
2039
+ if !content_type.nil?
2040
+ header_params['Content-Type'] = content_type
2041
+ end
2042
+
2043
+ # form parameters
2044
+ form_params = opts[:form_params] || {}
2045
+
2046
+ # http body (model)
2047
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_message_image_update_query)
2048
+
2049
+ # return_type
2050
+ return_type = opts[:debug_return_type]
2051
+
2052
+ # auth_names
2053
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']
2054
+
2055
+ new_options = opts.merge(
2056
+ :operation => :"CampaignsApi.update_image_for_campaign_message",
2057
+ :header_params => header_params,
2058
+ :query_params => query_params,
2059
+ :form_params => form_params,
2060
+ :body => post_body,
2061
+ :auth_names => auth_names,
2062
+ :return_type => return_type
2063
+ )
2064
+
2065
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
2066
+ if @api_client.config.debugging
2067
+ @api_client.config.logger.debug "API called: CampaignsApi#update_image_for_campaign_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2068
+ end
2069
+ return data, status_code, headers
2070
+ end
2071
+
2072
+ # alias of `update_image_for_campaign_message_with_http_info`
2073
+ alias update_campaign_message_relationships_image_with_http_info update_image_for_campaign_message_with_http_info
1829
2074
  end
1830
2075
  end