klaviyo-api-sdk 9.0.0 → 11.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 (613) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1272 -524
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +11 -11
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +645 -573
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +1720 -1576
  8. data/lib/klaviyo-api-sdk/api/coupons_api.rb +317 -287
  9. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +5 -5
  10. data/lib/klaviyo-api-sdk/api/events_api.rb +134 -122
  11. data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
  12. data/lib/klaviyo-api-sdk/api/forms_api.rb +56 -60
  13. data/lib/klaviyo-api-sdk/api/images_api.rb +28 -28
  14. data/lib/klaviyo-api-sdk/api/lists_api.rb +316 -153
  15. data/lib/klaviyo-api-sdk/api/metrics_api.rb +582 -19
  16. data/lib/klaviyo-api-sdk/api/profiles_api.rb +1046 -603
  17. data/lib/klaviyo-api-sdk/api/reporting_api.rb +323 -19
  18. data/lib/klaviyo-api-sdk/api/reviews_api.rb +212 -0
  19. data/lib/klaviyo-api-sdk/api/segments_api.rb +341 -166
  20. data/lib/klaviyo-api-sdk/api/tags_api.rb +741 -645
  21. data/lib/klaviyo-api-sdk/api/templates_api.rb +493 -84
  22. data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +250 -0
  23. data/lib/klaviyo-api-sdk/api/webhooks_api.rb +32 -32
  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/alltime_date_filter.rb +1 -1
  28. data/lib/klaviyo-api-sdk/models/anniversary_date_filter.rb +1 -1
  29. data/lib/klaviyo-api-sdk/models/any_enum.rb +1 -1
  30. data/lib/klaviyo-api-sdk/models/api_enum.rb +1 -1
  31. data/lib/klaviyo-api-sdk/models/api_method_filter.rb +1 -1
  32. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  33. data/lib/klaviyo-api-sdk/models/back_in_stock_enum.rb +1 -1
  34. data/lib/klaviyo-api-sdk/models/back_in_stock_method_filter.rb +1 -1
  35. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  36. data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +1 -1
  37. data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +1 -1
  38. data/lib/klaviyo-api-sdk/models/block_display_options.rb +274 -0
  39. data/lib/klaviyo-api-sdk/models/block_enum.rb +36 -0
  40. data/lib/klaviyo-api-sdk/models/boolean_enum.rb +1 -1
  41. data/lib/klaviyo-api-sdk/models/boolean_filter.rb +1 -1
  42. data/lib/klaviyo-api-sdk/models/bounce_date_enum.rb +1 -1
  43. data/lib/klaviyo-api-sdk/models/bounce_date_filter.rb +1 -1
  44. data/lib/klaviyo-api-sdk/models/bounce_date_filter_filter.rb +1 -1
  45. data/lib/klaviyo-api-sdk/models/bulk_remove_enum.rb +1 -1
  46. data/lib/klaviyo-api-sdk/models/bulk_remove_method_filter.rb +1 -1
  47. data/lib/klaviyo-api-sdk/models/calendar_date_filter.rb +1 -1
  48. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  49. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
  50. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
  51. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  52. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
  53. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
  54. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  55. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
  56. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
  57. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  58. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  59. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -1
  60. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
  61. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
  62. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
  63. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
  64. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
  65. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
  66. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  67. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  68. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
  69. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
  70. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  71. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  72. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
  73. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  76. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  77. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
  78. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  79. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  80. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
  81. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  82. data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +273 -0
  83. data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_static_param.rb +239 -0
  84. data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +1 -1
  85. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +1 -1
  86. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +1 -1
  88. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
  89. data/lib/klaviyo-api-sdk/models/carrier_deactivation_enum.rb +1 -1
  90. data/lib/klaviyo-api-sdk/models/carrier_deactivation_method_filter.rb +1 -1
  91. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  93. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  111. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  112. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
  113. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  120. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  121. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  127. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  137. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
  145. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  152. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
  157. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/checkout_enum.rb +1 -1
  172. data/lib/klaviyo-api-sdk/models/checkout_method_filter.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/condition_group.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/constant_contact_enum.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/constant_contact_integration_filter.rb +1 -1
  177. data/lib/klaviyo-api-sdk/models/constant_contact_integration_method_filter.rb +1 -1
  178. data/lib/klaviyo-api-sdk/models/content_repeat.rb +238 -0
  179. data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
  185. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
  192. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
  194. data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
  195. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/custom_source_enum.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/custom_source_filter.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/custom_tracking_param_dto.rb +245 -0
  205. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  206. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
  207. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  208. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
  212. data/lib/klaviyo-api-sdk/models/date_enum.rb +1 -1
  213. data/lib/klaviyo-api-sdk/models/device_metadata.rb +3 -3
  214. data/lib/klaviyo-api-sdk/models/double_optin_filter.rb +1 -1
  215. data/lib/klaviyo-api-sdk/models/dynamic_enum.rb +36 -0
  216. data/lib/klaviyo-api-sdk/models/dynamic_tracking_param.rb +288 -0
  217. data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
  218. data/lib/klaviyo-api-sdk/models/email_enum.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +2 -2
  221. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +19 -19
  222. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object_custom_tracking_params_inner.rb +105 -0
  223. data/lib/klaviyo-api-sdk/models/equals_enum.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/equals_string_filter.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +1 -1
  227. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
  230. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +13 -2
  235. data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +1 -1
  236. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +1 -1
  242. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +1 -1
  243. data/lib/klaviyo-api-sdk/models/existence_enum.rb +1 -1
  244. data/lib/klaviyo-api-sdk/models/existence_operator_filter.rb +1 -1
  245. data/lib/klaviyo-api-sdk/models/failed_age_gate_enum.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/failed_age_gate_method_filter.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +1 -1
  249. data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +1 -1
  250. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +1 -1
  252. data/lib/klaviyo-api-sdk/models/flow_tracking_setting_dynamic_param.rb +273 -0
  253. data/lib/klaviyo-api-sdk/models/{utm_params_sub_object.rb → flow_tracking_setting_static_param.rb} +15 -16
  254. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +1 -1
  261. data/lib/klaviyo-api-sdk/models/form_enum.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/form_method_filter.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/form_series_report_enum.rb +36 -0
  264. data/lib/klaviyo-api-sdk/models/form_series_request_dto.rb +224 -0
  265. data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object.rb +238 -0
  266. data/lib/klaviyo-api-sdk/models/form_series_request_dto_resource_object_attributes.rb +314 -0
  267. data/lib/klaviyo-api-sdk/models/form_values_report_enum.rb +36 -0
  268. data/lib/klaviyo-api-sdk/models/form_values_request_dto.rb +224 -0
  269. data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object.rb +238 -0
  270. data/lib/klaviyo-api-sdk/models/form_values_request_dto_resource_object_attributes.rb +287 -0
  271. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/greater_than_enum.rb +1 -1
  275. data/lib/klaviyo-api-sdk/models/has_email_marketing.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/has_email_marketing_consent.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/has_email_marketing_consent_consent_status.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/has_email_marketing_never_subscribed.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/has_email_marketing_subscribed_filters_inner.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/has_push_marketing.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/has_push_marketing_consent.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/has_sms_marketing_consent.rb +1 -1
  284. data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/has_sms_marketing_subscribed_filters_inner.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/html_block.rb +252 -0
  287. data/lib/klaviyo-api-sdk/models/html_block_data.rb +238 -0
  288. data/lib/klaviyo-api-sdk/models/html_enum.rb +36 -0
  289. data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
  291. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/in_enum.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/in_string_array_filter.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/inbound_message_enum.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/inbound_message_method_filter.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/integration_enum.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/invalid_email_date_enum.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/invalid_email_date_filter.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/is_double_opt_in_enum.rb +1 -1
  304. data/lib/klaviyo-api-sdk/models/is_set_enum.rb +1 -1
  305. data/lib/klaviyo-api-sdk/models/is_set_existence_filter.rb +1 -1
  306. data/lib/klaviyo-api-sdk/models/less_than_enum.rb +1 -1
  307. data/lib/klaviyo-api-sdk/models/list_contains_operator_filter.rb +1 -1
  308. data/lib/klaviyo-api-sdk/models/list_contains_operator_filter_value.rb +1 -1
  309. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  310. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
  311. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  312. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  313. data/lib/klaviyo-api-sdk/models/list_length_filter.rb +1 -1
  314. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  315. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  316. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  317. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  318. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
  319. data/lib/klaviyo-api-sdk/models/list_set_filter.rb +3 -3
  320. data/lib/klaviyo-api-sdk/models/list_substring_filter.rb +283 -0
  321. data/lib/klaviyo-api-sdk/models/mailbox_provider_enum.rb +1 -1
  322. data/lib/klaviyo-api-sdk/models/mailbox_provider_method_filter.rb +1 -1
  323. data/lib/klaviyo-api-sdk/models/manual_add_enum.rb +1 -1
  324. data/lib/klaviyo-api-sdk/models/manual_add_method_filter.rb +1 -1
  325. data/lib/klaviyo-api-sdk/models/manual_import_enum.rb +1 -1
  326. data/lib/klaviyo-api-sdk/models/manual_import_method_filter.rb +1 -1
  327. data/lib/klaviyo-api-sdk/models/manual_remove_enum.rb +1 -1
  328. data/lib/klaviyo-api-sdk/models/manual_remove_method_filter.rb +1 -1
  329. data/lib/klaviyo-api-sdk/models/manual_suppression_date_enum.rb +1 -1
  330. data/lib/klaviyo-api-sdk/models/manual_suppression_date_filter.rb +1 -1
  331. data/lib/klaviyo-api-sdk/models/message_blocked_enum.rb +1 -1
  332. data/lib/klaviyo-api-sdk/models/message_blocked_method_filter.rb +1 -1
  333. data/lib/klaviyo-api-sdk/models/method_enum.rb +1 -1
  334. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  335. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  336. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
  337. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
  338. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
  339. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
  340. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  341. data/lib/klaviyo-api-sdk/models/never_subscribed_enum.rb +1 -1
  342. data/lib/klaviyo-api-sdk/models/no_email_marketing.rb +1 -1
  343. data/lib/klaviyo-api-sdk/models/no_email_marketing_consent.rb +1 -1
  344. data/lib/klaviyo-api-sdk/models/no_email_marketing_consent_consent_status.rb +1 -1
  345. data/lib/klaviyo-api-sdk/models/no_email_marketing_filters_inner.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/no_email_marketing_never_subscribed.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/no_email_marketing_subscribed.rb +1 -1
  348. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed.rb +1 -1
  349. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters.rb +1 -1
  350. data/lib/klaviyo-api-sdk/models/no_email_marketing_unsubscribed_filters_one_of_inner.rb +1 -1
  351. data/lib/klaviyo-api-sdk/models/no_push_marketing.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/no_push_marketing_consent.rb +1 -1
  353. data/lib/klaviyo-api-sdk/models/no_sms_marketing.rb +1 -1
  354. data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent.rb +1 -1
  355. data/lib/klaviyo-api-sdk/models/no_sms_marketing_consent_consent_status.rb +1 -1
  356. data/lib/klaviyo-api-sdk/models/no_sms_marketing_never_subscribed.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed.rb +1 -1
  358. data/lib/klaviyo-api-sdk/models/no_sms_marketing_unsubscribed_filters_inner.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/not_equals_enum.rb +1 -1
  360. data/lib/klaviyo-api-sdk/models/numeric_enum.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/numeric_operator_filter.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/numeric_operator_filter_value.rb +1 -1
  363. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
  364. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +13 -2
  365. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  366. data/lib/klaviyo-api-sdk/models/preference_page_enum.rb +1 -1
  367. data/lib/klaviyo-api-sdk/models/preference_page_filter.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/preference_page_method_filter.rb +1 -1
  369. data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
  370. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  371. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
  372. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +13 -2
  373. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  374. data/lib/klaviyo-api-sdk/models/profile_group_membership_enum.rb +1 -1
  375. data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition.rb +1 -1
  376. data/lib/klaviyo-api-sdk/models/profile_has_group_membership_condition_timeframe_filter.rb +1 -1
  377. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
  378. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
  379. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
  380. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
  381. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
  382. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
  383. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
  384. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
  385. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
  386. data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
  387. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  388. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  389. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition.rb +1 -1
  390. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_condition_consent.rb +1 -1
  391. data/lib/klaviyo-api-sdk/models/profile_marketing_consent_enum.rb +1 -1
  392. data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
  393. data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
  394. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
  395. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
  396. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
  397. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
  398. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  399. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
  400. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  401. data/lib/klaviyo-api-sdk/models/profile_metric_condition.rb +1 -1
  402. data/lib/klaviyo-api-sdk/models/profile_metric_condition_timeframe_filter.rb +1 -1
  403. data/lib/klaviyo-api-sdk/models/profile_metric_enum.rb +1 -1
  404. data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +1 -1
  405. data/lib/klaviyo-api-sdk/models/profile_metric_property_filter_filter.rb +9 -3
  406. data/lib/klaviyo-api-sdk/models/profile_no_group_membership_condition.rb +1 -1
  407. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  408. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
  409. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +13 -2
  410. data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_condition.rb +1 -1
  411. data/lib/klaviyo-api-sdk/models/profile_postal_code_distance_enum.rb +1 -1
  412. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_enum.rb +1 -1
  413. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_numeric_condition.rb +1 -1
  414. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_condition.rb +1 -1
  415. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter.rb +1 -1
  416. data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_string_filter_operator.rb +1 -1
  417. data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -1
  418. data/lib/klaviyo-api-sdk/models/profile_property_condition_filter.rb +1 -1
  419. data/lib/klaviyo-api-sdk/models/profile_property_enum.rb +1 -1
  420. data/lib/klaviyo-api-sdk/models/profile_region_condition.rb +1 -1
  421. data/lib/klaviyo-api-sdk/models/profile_region_enum.rb +1 -1
  422. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  423. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  424. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
  425. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +1 -1
  426. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
  427. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +1 -1
  428. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  429. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  430. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
  431. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
  432. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
  433. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
  434. data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +1 -1
  435. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +1 -1
  436. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +13 -2
  437. data/lib/klaviyo-api-sdk/models/provided_landline_enum.rb +1 -1
  438. data/lib/klaviyo-api-sdk/models/provided_landline_method_filter.rb +1 -1
  439. data/lib/klaviyo-api-sdk/models/provided_no_age_enum.rb +1 -1
  440. data/lib/klaviyo-api-sdk/models/provided_no_age_method_filter.rb +1 -1
  441. data/lib/klaviyo-api-sdk/models/push_enum.rb +1 -1
  442. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +1 -1
  443. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +13 -2
  444. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
  445. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
  446. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
  447. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
  448. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
  449. data/lib/klaviyo-api-sdk/models/relative_anniversary_date_filter.rb +1 -1
  450. data/lib/klaviyo-api-sdk/models/relative_date_operator_base_filter.rb +1 -1
  451. data/lib/klaviyo-api-sdk/models/relative_date_range_filter.rb +1 -1
  452. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
  453. data/lib/klaviyo-api-sdk/models/segment_create_query.rb +1 -1
  454. data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object.rb +1 -1
  455. data/lib/klaviyo-api-sdk/models/segment_create_query_resource_object_attributes.rb +1 -1
  456. data/lib/klaviyo-api-sdk/models/segment_definition.rb +1 -1
  457. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  458. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  459. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
  460. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  461. data/lib/klaviyo-api-sdk/models/segment_series_report_enum.rb +36 -0
  462. data/lib/klaviyo-api-sdk/models/segment_series_request_dto.rb +224 -0
  463. data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object.rb +238 -0
  464. data/lib/klaviyo-api-sdk/models/segment_series_request_dto_resource_object_attributes.rb +301 -0
  465. data/lib/klaviyo-api-sdk/models/segment_values_report_enum.rb +36 -0
  466. data/lib/klaviyo-api-sdk/models/segment_values_request_dto.rb +224 -0
  467. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object.rb +238 -0
  468. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes.rb +274 -0
  469. data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
  470. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
  471. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  472. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
  473. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
  474. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  475. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
  476. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
  477. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
  478. data/lib/klaviyo-api-sdk/models/sftp_enum.rb +1 -1
  479. data/lib/klaviyo-api-sdk/models/sftp_method_filter.rb +1 -1
  480. data/lib/klaviyo-api-sdk/models/shopify_enum.rb +1 -1
  481. data/lib/klaviyo-api-sdk/models/shopify_integration_filter.rb +1 -1
  482. data/lib/klaviyo-api-sdk/models/shopify_integration_method_filter.rb +1 -1
  483. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
  484. data/lib/klaviyo-api-sdk/models/sms_enum.rb +1 -1
  485. data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
  486. data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +14 -10
  487. data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +19 -19
  488. data/lib/klaviyo-api-sdk/models/spam_complaint_enum.rb +1 -1
  489. data/lib/klaviyo-api-sdk/models/spam_complaint_method_filter.rb +1 -1
  490. data/lib/klaviyo-api-sdk/models/static_date_filter.rb +1 -1
  491. data/lib/klaviyo-api-sdk/models/static_date_range_filter.rb +1 -1
  492. data/lib/klaviyo-api-sdk/models/static_enum.rb +36 -0
  493. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  494. data/lib/klaviyo-api-sdk/models/static_tracking_param.rb +254 -0
  495. data/lib/klaviyo-api-sdk/models/status_date_enum.rb +1 -1
  496. data/lib/klaviyo-api-sdk/models/status_date_filter.rb +1 -1
  497. data/lib/klaviyo-api-sdk/models/status_date_filter_filter.rb +1 -1
  498. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  499. data/lib/klaviyo-api-sdk/models/string_array_operator_filter.rb +1 -1
  500. data/lib/klaviyo-api-sdk/models/string_enum.rb +1 -1
  501. data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +1 -1
  502. data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
  503. data/lib/klaviyo-api-sdk/models/subscribed_enum.rb +1 -1
  504. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
  505. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  506. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
  507. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
  508. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  509. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
  510. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
  511. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  512. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  513. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
  514. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  515. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  516. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
  517. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  518. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  519. data/lib/klaviyo-api-sdk/models/{marketing_subscription_parameters.rb → subscription_parameters.rb} +5 -5
  520. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  521. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
  522. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  523. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  524. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +1 -1
  525. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +1 -1
  526. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  527. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +1 -1
  528. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +1 -1
  529. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  530. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
  531. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
  532. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  533. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +1 -1
  534. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  535. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  536. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +1 -1
  537. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +1 -1
  538. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  539. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  540. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  541. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
  542. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
  543. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  544. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
  545. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
  546. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  547. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  548. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  549. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  550. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
  551. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
  552. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  553. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  554. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
  555. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
  556. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  557. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  558. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  559. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  560. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  561. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
  562. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  563. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
  564. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
  565. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  566. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
  567. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
  568. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  569. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  570. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
  571. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
  572. data/lib/klaviyo-api-sdk/models/template_universal_content_enum.rb +36 -0
  573. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  574. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
  575. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
  576. data/lib/klaviyo-api-sdk/models/text_block.rb +252 -0
  577. data/lib/klaviyo-api-sdk/models/text_block_data.rb +252 -0
  578. data/lib/klaviyo-api-sdk/models/text_block_styles.rb +534 -0
  579. data/lib/klaviyo-api-sdk/models/text_enum.rb +36 -0
  580. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  581. data/lib/klaviyo-api-sdk/models/timeframe.rb +1 -1
  582. data/lib/klaviyo-api-sdk/models/tracking_param_dto.rb +230 -0
  583. data/lib/klaviyo-api-sdk/models/tracking_param_dto_campaign.rb +106 -0
  584. data/lib/klaviyo-api-sdk/models/tracking_param_dto_flow.rb +106 -0
  585. data/lib/klaviyo-api-sdk/models/tracking_setting_enum.rb +36 -0
  586. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query.rb +224 -0
  587. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object.rb +253 -0
  588. data/lib/klaviyo-api-sdk/models/tracking_setting_partial_update_query_resource_object_attributes.rb +279 -0
  589. data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter.rb +1 -1
  590. data/lib/klaviyo-api-sdk/models/union_positive_numeric_filter_operator.rb +1 -1
  591. data/lib/klaviyo-api-sdk/models/universal_content_create_query.rb +224 -0
  592. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object.rb +238 -0
  593. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes.rb +239 -0
  594. data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +105 -0
  595. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query.rb +224 -0
  596. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object.rb +253 -0
  597. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes.rb +231 -0
  598. data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +105 -0
  599. data/lib/klaviyo-api-sdk/models/unsubscribed_enum.rb +1 -1
  600. data/lib/klaviyo-api-sdk/models/webhook_create_query.rb +1 -1
  601. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object.rb +1 -1
  602. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_attributes.rb +1 -1
  603. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships.rb +1 -1
  604. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics.rb +1 -1
  605. data/lib/klaviyo-api-sdk/models/webhook_create_query_resource_object_relationships_webhook_topics_data_inner.rb +1 -1
  606. data/lib/klaviyo-api-sdk/models/webhook_enum.rb +1 -1
  607. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query.rb +1 -1
  608. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object.rb +1 -1
  609. data/lib/klaviyo-api-sdk/models/webhook_partial_update_query_resource_object_attributes.rb +1 -1
  610. data/lib/klaviyo-api-sdk/models/webhook_topic_enum.rb +1 -1
  611. data/lib/klaviyo-api-sdk/version.rb +1 -1
  612. data/lib/klaviyo-api-sdk.rb +90 -22
  613. metadata +59 -4
@@ -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-07-15
6
+ The version of the OpenAPI document: 2024-10-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -43,7 +43,7 @@ module KlaviyoAPI
43
43
  fail ArgumentError, "Missing the required parameter 'segment_create_query' when calling SegmentsApi.create_segment"
44
44
  end
45
45
  # resource path
46
- local_var_path = '/api/segments/'
46
+ local_var_path = '/api/segments'
47
47
 
48
48
  # query parameters
49
49
  query_params = opts[:query_params] || {}
@@ -51,11 +51,11 @@ module KlaviyoAPI
51
51
  # header parameters
52
52
  header_params = opts[:header_params] || {}
53
53
  # klaviyo api revision
54
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
54
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
55
55
  # HTTP header 'Accept' (if needed)
56
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
56
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
57
57
  # HTTP header 'Content-Type'
58
- content_type = @api_client.select_header_content_type(['application/json'])
58
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
59
59
  if !content_type.nil?
60
60
  header_params['Content-Type'] = content_type
61
61
  end
@@ -113,7 +113,7 @@ module KlaviyoAPI
113
113
  fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.delete_segment"
114
114
  end
115
115
  # resource path
116
- local_var_path = '/api/segments/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
116
+ local_var_path = '/api/segments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
117
117
 
118
118
  # query parameters
119
119
  query_params = opts[:query_params] || {}
@@ -121,9 +121,9 @@ module KlaviyoAPI
121
121
  # header parameters
122
122
  header_params = opts[:header_params] || {}
123
123
  # klaviyo api revision
124
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
124
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
125
125
  # HTTP header 'Accept' (if needed)
126
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
126
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
127
127
 
128
128
  # form parameters
129
129
  form_params = opts[:form_params] || {}
@@ -154,69 +154,68 @@ module KlaviyoAPI
154
154
  return data, status_code, headers
155
155
  end
156
156
 
157
- # Get Segment
158
- # Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read`
159
- # @param id [String]
157
+ # Get Profile IDs for Segment
158
+ # Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
159
+ # @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
160
160
  # @param [Hash] opts the optional parameters
161
- # @option opts [Array<String>] :additional_fields_segment Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39;
162
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
163
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
164
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
161
+ # @option opts [String] :filter 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;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
162
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
163
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20)
164
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
165
165
  # @return [Hash<String, Object>]
166
- def get_segment(id, opts = {})
167
- data, _status_code, _headers = get_segment_with_http_info(id, opts)
166
+ def get_profile_ids_for_segment(id, opts = {})
167
+ data, _status_code, _headers = get_profile_ids_for_segment_with_http_info(id, opts)
168
168
  data
169
169
  end
170
170
 
171
- # Get Segment
172
- # Get a segment with the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[segment]&#x3D;profile_count&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;segments:read&#x60;
173
- # @param id [String]
171
+ # alias of `get_profile_ids_for_segment`
172
+ alias get_segment_relationships_profiles get_profile_ids_for_segment
173
+
174
+ # Get Profile IDs for Segment
175
+ # Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:read&#x60; &#x60;segments:read&#x60;
176
+ # @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
174
177
  # @param [Hash] opts the optional parameters
175
- # @option opts [Array<String>] :additional_fields_segment Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39;
176
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
177
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
178
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
178
+ # @option opts [String] :filter 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;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
179
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
180
+ # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20)
181
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
179
182
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
180
- def get_segment_with_http_info(id, opts = {})
183
+ def get_profile_ids_for_segment_with_http_info(id, opts = {})
181
184
  if @api_client.config.debugging
182
- @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment ...'
185
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_profile_ids_for_segment ...'
183
186
  end
184
187
  # verify the required parameter 'id' is set
185
188
  if @api_client.config.client_side_validation && id.nil?
186
- fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment"
189
+ fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_profile_ids_for_segment"
187
190
  end
188
- allowable_values = ["profile_count"]
189
- if @api_client.config.client_side_validation && opts[:'additional_fields_segment'] && !opts[:'additional_fields_segment'].all? { |item| allowable_values.include?(item) }
190
- fail ArgumentError, "invalid value for \"additional_fields_segment\", must include one of #{allowable_values}"
191
- end
192
- allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred", "profile_count"]
193
- if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
194
- fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
191
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
192
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_profile_ids_for_segment, must be smaller than or equal to 1000.'
195
193
  end
196
- allowable_values = ["name"]
197
- if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
198
- fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
194
+
195
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
196
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_profile_ids_for_segment, must be greater than or equal to 1.'
199
197
  end
200
- allowable_values = ["tags"]
201
- if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
202
- fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
198
+
199
+ allowable_values = ["joined_group_at", "-joined_group_at"]
200
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
201
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
203
202
  end
204
203
  # resource path
205
- local_var_path = '/api/segments/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
204
+ local_var_path = '/api/segments/{id}/relationships/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
206
205
 
207
206
  # query parameters
208
207
  query_params = opts[:query_params] || {}
209
- query_params[:'additional-fields[segment]'] = @api_client.build_collection_param(opts[:'additional_fields_segment'], :csv) if !opts[:'additional_fields_segment'].nil?
210
- query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
211
- query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
212
- query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
208
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
209
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
210
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
211
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
213
212
 
214
213
  # header parameters
215
214
  header_params = opts[:header_params] || {}
216
215
  # klaviyo api revision
217
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
216
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
218
217
  # HTTP header 'Accept' (if needed)
219
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
218
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
220
219
 
221
220
  # form parameters
222
221
  form_params = opts[:form_params] || {}
@@ -231,7 +230,7 @@ module KlaviyoAPI
231
230
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
232
231
 
233
232
  new_options = opts.merge(
234
- :operation => :"SegmentsApi.get_segment",
233
+ :operation => :"SegmentsApi.get_profile_ids_for_segment",
235
234
  :header_params => header_params,
236
235
  :query_params => query_params,
237
236
  :form_params => form_params,
@@ -242,60 +241,66 @@ module KlaviyoAPI
242
241
 
243
242
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
244
243
  if @api_client.config.debugging
245
- @api_client.config.logger.debug "API called: SegmentsApi#get_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
244
+ @api_client.config.logger.debug "API called: SegmentsApi#get_profile_ids_for_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
246
245
  end
247
246
  return data, status_code, headers
248
247
  end
249
248
 
250
- # Get Segment Profiles
249
+ # alias of `get_profile_ids_for_segment_with_http_info`
250
+ alias get_segment_relationships_profiles_with_http_info get_profile_ids_for_segment_with_http_info
251
+
252
+ # Get Profiles for Segment
251
253
  # Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
252
254
  # @param id [String]
253
255
  # @param [Hash] opts the optional parameters
254
256
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
255
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
256
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
257
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
257
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
258
+ # @option opts [String] :filter 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;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
259
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
258
260
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
259
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
261
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
260
262
  # @return [Hash<String, Object>]
261
- def get_segment_profiles(id, opts = {})
262
- data, _status_code, _headers = get_segment_profiles_with_http_info(id, opts)
263
+ def get_profiles_for_segment(id, opts = {})
264
+ data, _status_code, _headers = get_profiles_for_segment_with_http_info(id, opts)
263
265
  data
264
266
  end
265
267
 
266
- # Get Segment Profiles
268
+ # alias of `get_profiles_for_segment`
269
+ alias get_segment_profiles get_profiles_for_segment
270
+
271
+ # Get Profiles for Segment
267
272
  # Get all profiles within a segment with the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by &#x60;email&#x60;, &#x60;phone_number&#x60;, &#x60;push_token&#x60;, and &#x60;joined_group_at&#x60; fields. Profiles can be sorted by the following fields, in ascending and descending order: &#x60;joined_group_at&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:read&#x60; &#x60;segments:read&#x60;
268
273
  # @param id [String]
269
274
  # @param [Hash] opts the optional parameters
270
275
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
271
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
272
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
273
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
276
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
277
+ # @option opts [String] :filter 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;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
278
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
274
279
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
275
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
280
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
276
281
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
277
- def get_segment_profiles_with_http_info(id, opts = {})
282
+ def get_profiles_for_segment_with_http_info(id, opts = {})
278
283
  if @api_client.config.debugging
279
- @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_profiles ...'
284
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_profiles_for_segment ...'
280
285
  end
281
286
  # verify the required parameter 'id' is set
282
287
  if @api_client.config.client_side_validation && id.nil?
283
- fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment_profiles"
288
+ fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_profiles_for_segment"
284
289
  end
285
290
  allowable_values = ["subscriptions", "predictive_analytics"]
286
291
  if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
287
292
  fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
288
293
  end
289
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
294
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.sms.transactional", "subscriptions.sms.transactional.can_receive_sms_transactional", "subscriptions.sms.transactional.consent", "subscriptions.sms.transactional.consent_timestamp", "subscriptions.sms.transactional.method", "subscriptions.sms.transactional.method_detail", "subscriptions.sms.transactional.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
290
295
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
291
296
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
292
297
  end
293
298
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
294
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_segment_profiles, must be smaller than or equal to 100.'
299
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_profiles_for_segment, must be smaller than or equal to 100.'
295
300
  end
296
301
 
297
302
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
298
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_segment_profiles, must be greater than or equal to 1.'
303
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_profiles_for_segment, must be greater than or equal to 1.'
299
304
  end
300
305
 
301
306
  allowable_values = ["joined_group_at", "-joined_group_at"]
@@ -303,7 +308,7 @@ module KlaviyoAPI
303
308
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
304
309
  end
305
310
  # resource path
306
- local_var_path = '/api/segments/{id}/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
311
+ local_var_path = '/api/segments/{id}/profiles'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
307
312
 
308
313
  # query parameters
309
314
  query_params = opts[:query_params] || {}
@@ -317,9 +322,9 @@ module KlaviyoAPI
317
322
  # header parameters
318
323
  header_params = opts[:header_params] || {}
319
324
  # klaviyo api revision
320
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
325
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
321
326
  # HTTP header 'Accept' (if needed)
322
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
327
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
323
328
 
324
329
  # form parameters
325
330
  form_params = opts[:form_params] || {}
@@ -334,7 +339,7 @@ module KlaviyoAPI
334
339
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
335
340
 
336
341
  new_options = opts.merge(
337
- :operation => :"SegmentsApi.get_segment_profiles",
342
+ :operation => :"SegmentsApi.get_profiles_for_segment",
338
343
  :header_params => header_params,
339
344
  :query_params => query_params,
340
345
  :form_params => form_params,
@@ -345,70 +350,84 @@ module KlaviyoAPI
345
350
 
346
351
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
347
352
  if @api_client.config.debugging
348
- @api_client.config.logger.debug "API called: SegmentsApi#get_segment_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
353
+ @api_client.config.logger.debug "API called: SegmentsApi#get_profiles_for_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
349
354
  end
350
355
  return data, status_code, headers
351
356
  end
352
357
 
353
- # Get Segment Relationships Profiles
354
- # Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read` `segments:read`
358
+ # alias of `get_profiles_for_segment_with_http_info`
359
+ alias get_segment_profiles_with_http_info get_profiles_for_segment_with_http_info
360
+
361
+ # Get Segment
362
+ # Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `segments:read`
355
363
  # @param id [String]
356
364
  # @param [Hash] opts the optional parameters
357
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
358
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
359
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20)
360
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
365
+ # @option opts [Array<String>] :additional_fields_segment Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39;
366
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
367
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
368
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
369
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
361
370
  # @return [Hash<String, Object>]
362
- def get_segment_relationships_profiles(id, opts = {})
363
- data, _status_code, _headers = get_segment_relationships_profiles_with_http_info(id, opts)
371
+ def get_segment(id, opts = {})
372
+ data, _status_code, _headers = get_segment_with_http_info(id, opts)
364
373
  data
365
374
  end
366
375
 
367
- # Get Segment Relationships Profiles
368
- # Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:read&#x60; &#x60;segments:read&#x60;
376
+ # Get Segment
377
+ # Get a segment with the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[segment]&#x3D;profile_count&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-10-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;segments:read&#x60;
369
378
  # @param id [String]
370
379
  # @param [Hash] opts the optional parameters
371
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
372
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
373
- # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20)
374
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
380
+ # @option opts [Array<String>] :additional_fields_segment Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39;
381
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
382
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
383
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
384
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
375
385
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
376
- def get_segment_relationships_profiles_with_http_info(id, opts = {})
386
+ def get_segment_with_http_info(id, opts = {})
377
387
  if @api_client.config.debugging
378
- @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_relationships_profiles ...'
388
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment ...'
379
389
  end
380
390
  # verify the required parameter 'id' is set
381
391
  if @api_client.config.client_side_validation && id.nil?
382
- fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment_relationships_profiles"
392
+ fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment"
383
393
  end
384
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
385
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_segment_relationships_profiles, must be smaller than or equal to 1000.'
394
+ allowable_values = ["profile_count"]
395
+ if @api_client.config.client_side_validation && opts[:'additional_fields_segment'] && !opts[:'additional_fields_segment'].all? { |item| allowable_values.include?(item) }
396
+ fail ArgumentError, "invalid value for \"additional_fields_segment\", must include one of #{allowable_values}"
386
397
  end
387
-
388
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
389
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SegmentsApi.get_segment_relationships_profiles, must be greater than or equal to 1.'
398
+ allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
399
+ if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
400
+ fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
390
401
  end
391
-
392
- allowable_values = ["joined_group_at", "-joined_group_at"]
393
- if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
394
- fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
402
+ allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred", "profile_count"]
403
+ if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
404
+ fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
405
+ end
406
+ allowable_values = ["name"]
407
+ if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
408
+ fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
409
+ end
410
+ allowable_values = ["flow-triggers", "tags"]
411
+ if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
412
+ fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
395
413
  end
396
414
  # resource path
397
- local_var_path = '/api/segments/{id}/relationships/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
415
+ local_var_path = '/api/segments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
398
416
 
399
417
  # query parameters
400
418
  query_params = opts[:query_params] || {}
401
- query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
402
- query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
403
- query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
404
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
419
+ query_params[:'additional-fields[segment]'] = @api_client.build_collection_param(opts[:'additional_fields_segment'], :csv) if !opts[:'additional_fields_segment'].nil?
420
+ query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
421
+ query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
422
+ query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
423
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
405
424
 
406
425
  # header parameters
407
426
  header_params = opts[:header_params] || {}
408
427
  # klaviyo api revision
409
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
428
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
410
429
  # HTTP header 'Accept' (if needed)
411
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
430
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
412
431
 
413
432
  # form parameters
414
433
  form_params = opts[:form_params] || {}
@@ -423,7 +442,7 @@ module KlaviyoAPI
423
442
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
424
443
 
425
444
  new_options = opts.merge(
426
- :operation => :"SegmentsApi.get_segment_relationships_profiles",
445
+ :operation => :"SegmentsApi.get_segment",
427
446
  :header_params => header_params,
428
447
  :query_params => query_params,
429
448
  :form_params => form_params,
@@ -434,46 +453,53 @@ module KlaviyoAPI
434
453
 
435
454
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
436
455
  if @api_client.config.debugging
437
- @api_client.config.logger.debug "API called: SegmentsApi#get_segment_relationships_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
456
+ @api_client.config.logger.debug "API called: SegmentsApi#get_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
438
457
  end
439
458
  return data, status_code, headers
440
459
  end
441
460
 
442
- # Get Segment Relationships Tags
443
- # If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
444
- # @param id [String]
461
+ # Get Segment Flow Triggers
462
+ # Get all flows where the given segment ID is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
463
+ # @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
445
464
  # @param [Hash] opts the optional parameters
465
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
446
466
  # @return [Hash<String, Object>]
447
- def get_segment_relationships_tags(id, opts = {})
448
- data, _status_code, _headers = get_segment_relationships_tags_with_http_info(id, opts)
467
+ def get_segment_flow_triggers(id, opts = {})
468
+ data, _status_code, _headers = get_segment_flow_triggers_with_http_info(id, opts)
449
469
  data
450
470
  end
451
471
 
452
- # Get Segment Relationships Tags
453
- # If &#x60;related_resource&#x60; is &#x60;tags&#x60;, returns the tag IDs of all tags associated with the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;segments:read&#x60; &#x60;tags:read&#x60;
454
- # @param id [String]
472
+ # Get Segment Flow Triggers
473
+ # Get all flows where the given segment ID is being used as the trigger.&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;flows:read&#x60; &#x60;segments:read&#x60;
474
+ # @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
455
475
  # @param [Hash] opts the optional parameters
476
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
456
477
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
457
- def get_segment_relationships_tags_with_http_info(id, opts = {})
478
+ def get_segment_flow_triggers_with_http_info(id, opts = {})
458
479
  if @api_client.config.debugging
459
- @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_relationships_tags ...'
480
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_flow_triggers ...'
460
481
  end
461
482
  # verify the required parameter 'id' is set
462
483
  if @api_client.config.client_side_validation && id.nil?
463
- fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment_relationships_tags"
484
+ fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment_flow_triggers"
485
+ end
486
+ allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
487
+ if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
488
+ fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
464
489
  end
465
490
  # resource path
466
- local_var_path = '/api/segments/{id}/relationships/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
491
+ local_var_path = '/api/segments/{id}/flow-triggers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
467
492
 
468
493
  # query parameters
469
494
  query_params = opts[:query_params] || {}
495
+ query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
470
496
 
471
497
  # header parameters
472
498
  header_params = opts[:header_params] || {}
473
499
  # klaviyo api revision
474
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
500
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
475
501
  # HTTP header 'Accept' (if needed)
476
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
502
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
477
503
 
478
504
  # form parameters
479
505
  form_params = opts[:form_params] || {}
@@ -488,7 +514,7 @@ module KlaviyoAPI
488
514
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
489
515
 
490
516
  new_options = opts.merge(
491
- :operation => :"SegmentsApi.get_segment_relationships_tags",
517
+ :operation => :"SegmentsApi.get_segment_flow_triggers",
492
518
  :header_params => header_params,
493
519
  :query_params => query_params,
494
520
  :form_params => form_params,
@@ -499,53 +525,46 @@ module KlaviyoAPI
499
525
 
500
526
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
501
527
  if @api_client.config.debugging
502
- @api_client.config.logger.debug "API called: SegmentsApi#get_segment_relationships_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
528
+ @api_client.config.logger.debug "API called: SegmentsApi#get_segment_flow_triggers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
503
529
  end
504
530
  return data, status_code, headers
505
531
  end
506
532
 
507
- # Get Segment Tags
508
- # Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
509
- # @param id [String]
533
+ # Get Segment Relationships Flow Triggers
534
+ # Get all flow [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) where the given segment is being used as the trigger.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `segments:read`
535
+ # @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
510
536
  # @param [Hash] opts the optional parameters
511
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
512
537
  # @return [Hash<String, Object>]
513
- def get_segment_tags(id, opts = {})
514
- data, _status_code, _headers = get_segment_tags_with_http_info(id, opts)
538
+ def get_segment_relationships_flow_triggers(id, opts = {})
539
+ data, _status_code, _headers = get_segment_relationships_flow_triggers_with_http_info(id, opts)
515
540
  data
516
541
  end
517
542
 
518
- # Get Segment Tags
519
- # Return all tags associated with the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;segments:read&#x60; &#x60;tags:read&#x60;
520
- # @param id [String]
543
+ # Get Segment Relationships Flow Triggers
544
+ # Get all flow [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) where the given segment is being used as the trigger.&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;flows:read&#x60; &#x60;segments:read&#x60;
545
+ # @param id [String] Primary key that uniquely identifies this segment. Generated by Klaviyo.
521
546
  # @param [Hash] opts the optional parameters
522
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
523
547
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
524
- def get_segment_tags_with_http_info(id, opts = {})
548
+ def get_segment_relationships_flow_triggers_with_http_info(id, opts = {})
525
549
  if @api_client.config.debugging
526
- @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_tags ...'
550
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_relationships_flow_triggers ...'
527
551
  end
528
552
  # verify the required parameter 'id' is set
529
553
  if @api_client.config.client_side_validation && id.nil?
530
- fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment_tags"
531
- end
532
- allowable_values = ["name"]
533
- if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
534
- fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
554
+ fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_segment_relationships_flow_triggers"
535
555
  end
536
556
  # resource path
537
- local_var_path = '/api/segments/{id}/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
557
+ local_var_path = '/api/segments/{id}/relationships/flow-triggers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
538
558
 
539
559
  # query parameters
540
560
  query_params = opts[:query_params] || {}
541
- query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
542
561
 
543
562
  # header parameters
544
563
  header_params = opts[:header_params] || {}
545
564
  # klaviyo api revision
546
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
565
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
547
566
  # HTTP header 'Accept' (if needed)
548
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
567
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
549
568
 
550
569
  # form parameters
551
570
  form_params = opts[:form_params] || {}
@@ -560,7 +579,7 @@ module KlaviyoAPI
560
579
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
561
580
 
562
581
  new_options = opts.merge(
563
- :operation => :"SegmentsApi.get_segment_tags",
582
+ :operation => :"SegmentsApi.get_segment_relationships_flow_triggers",
564
583
  :header_params => header_params,
565
584
  :query_params => query_params,
566
585
  :form_params => form_params,
@@ -571,7 +590,7 @@ module KlaviyoAPI
571
590
 
572
591
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
573
592
  if @api_client.config.debugging
574
- @api_client.config.logger.debug "API called: SegmentsApi#get_segment_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
593
+ @api_client.config.logger.debug "API called: SegmentsApi#get_segment_relationships_flow_triggers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
575
594
  end
576
595
  return data, status_code, headers
577
596
  end
@@ -579,12 +598,13 @@ module KlaviyoAPI
579
598
  # Get Segments
580
599
  # Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `segments:read`
581
600
  # @param [Hash] opts the optional parameters
582
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
583
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
584
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;is_active&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;is_starred&#x60;: &#x60;equals&#x60;
585
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
586
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
587
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
601
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
602
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
603
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
604
+ # @option opts [String] :filter 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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;is_active&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;is_starred&#x60;: &#x60;equals&#x60;
605
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
606
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
607
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
588
608
  # @return [Hash<String, Object>]
589
609
  def get_segments(opts = {})
590
610
  data, _status_code, _headers = get_segments_with_http_info(opts)
@@ -594,17 +614,22 @@ module KlaviyoAPI
594
614
  # Get Segments
595
615
  # Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by &#x60;name&#x60;, &#x60;created&#x60;, and &#x60;updated&#x60; fields. Returns a maximum of 10 results per page.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;segments:read&#x60;
596
616
  # @param [Hash] opts the optional parameters
597
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
598
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
599
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;is_active&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;is_starred&#x60;: &#x60;equals&#x60;
600
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
601
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
602
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
617
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
618
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
619
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
620
+ # @option opts [String] :filter 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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;is_active&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;is_starred&#x60;: &#x60;equals&#x60;
621
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
622
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
623
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
603
624
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
604
625
  def get_segments_with_http_info(opts = {})
605
626
  if @api_client.config.debugging
606
627
  @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segments ...'
607
628
  end
629
+ allowable_values = ["name", "status", "archived", "created", "updated", "trigger_type"]
630
+ if @api_client.config.client_side_validation && opts[:'fields_flow'] && !opts[:'fields_flow'].all? { |item| allowable_values.include?(item) }
631
+ fail ArgumentError, "invalid value for \"fields_flow\", must include one of #{allowable_values}"
632
+ end
608
633
  allowable_values = ["name", "definition", "definition.condition_groups", "created", "updated", "is_active", "is_processing", "is_starred"]
609
634
  if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
610
635
  fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
@@ -613,7 +638,7 @@ module KlaviyoAPI
613
638
  if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
614
639
  fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
615
640
  end
616
- allowable_values = ["tags"]
641
+ allowable_values = ["flow-triggers", "tags"]
617
642
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
618
643
  fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
619
644
  end
@@ -622,10 +647,11 @@ module KlaviyoAPI
622
647
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
623
648
  end
624
649
  # resource path
625
- local_var_path = '/api/segments/'
650
+ local_var_path = '/api/segments'
626
651
 
627
652
  # query parameters
628
653
  query_params = opts[:query_params] || {}
654
+ query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
629
655
  query_params[:'fields[segment]'] = @api_client.build_collection_param(opts[:'fields_segment'], :csv) if !opts[:'fields_segment'].nil?
630
656
  query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
631
657
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
@@ -636,9 +662,9 @@ module KlaviyoAPI
636
662
  # header parameters
637
663
  header_params = opts[:header_params] || {}
638
664
  # klaviyo api revision
639
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
665
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
640
666
  # HTTP header 'Accept' (if needed)
641
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
667
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
642
668
 
643
669
  # form parameters
644
670
  form_params = opts[:form_params] || {}
@@ -669,6 +695,155 @@ module KlaviyoAPI
669
695
  return data, status_code, headers
670
696
  end
671
697
 
698
+ # Get Tag IDs for Segment
699
+ # If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
700
+ # @param id [String]
701
+ # @param [Hash] opts the optional parameters
702
+ # @return [Hash<String, Object>]
703
+ def get_tag_ids_for_segment(id, opts = {})
704
+ data, _status_code, _headers = get_tag_ids_for_segment_with_http_info(id, opts)
705
+ data
706
+ end
707
+
708
+ # alias of `get_tag_ids_for_segment`
709
+ alias get_segment_relationships_tags get_tag_ids_for_segment
710
+
711
+ # Get Tag IDs for Segment
712
+ # If &#x60;related_resource&#x60; is &#x60;tags&#x60;, returns the tag IDs of all tags associated with the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;segments:read&#x60; &#x60;tags:read&#x60;
713
+ # @param id [String]
714
+ # @param [Hash] opts the optional parameters
715
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
716
+ def get_tag_ids_for_segment_with_http_info(id, opts = {})
717
+ if @api_client.config.debugging
718
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_tag_ids_for_segment ...'
719
+ end
720
+ # verify the required parameter 'id' is set
721
+ if @api_client.config.client_side_validation && id.nil?
722
+ fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_tag_ids_for_segment"
723
+ end
724
+ # resource path
725
+ local_var_path = '/api/segments/{id}/relationships/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
726
+
727
+ # query parameters
728
+ query_params = opts[:query_params] || {}
729
+
730
+ # header parameters
731
+ header_params = opts[:header_params] || {}
732
+ # klaviyo api revision
733
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
734
+ # HTTP header 'Accept' (if needed)
735
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
736
+
737
+ # form parameters
738
+ form_params = opts[:form_params] || {}
739
+
740
+ # http body (model)
741
+ post_body = opts[:debug_body]
742
+
743
+ # return_type
744
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
745
+
746
+ # auth_names
747
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
748
+
749
+ new_options = opts.merge(
750
+ :operation => :"SegmentsApi.get_tag_ids_for_segment",
751
+ :header_params => header_params,
752
+ :query_params => query_params,
753
+ :form_params => form_params,
754
+ :body => post_body,
755
+ :auth_names => auth_names,
756
+ :return_type => return_type
757
+ )
758
+
759
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
760
+ if @api_client.config.debugging
761
+ @api_client.config.logger.debug "API called: SegmentsApi#get_tag_ids_for_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
762
+ end
763
+ return data, status_code, headers
764
+ end
765
+
766
+ # alias of `get_tag_ids_for_segment_with_http_info`
767
+ alias get_segment_relationships_tags_with_http_info get_tag_ids_for_segment_with_http_info
768
+
769
+ # Get Tags for Segment
770
+ # Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
771
+ # @param id [String]
772
+ # @param [Hash] opts the optional parameters
773
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
774
+ # @return [Hash<String, Object>]
775
+ def get_tags_for_segment(id, opts = {})
776
+ data, _status_code, _headers = get_tags_for_segment_with_http_info(id, opts)
777
+ data
778
+ end
779
+
780
+ # alias of `get_tags_for_segment`
781
+ alias get_segment_tags get_tags_for_segment
782
+
783
+ # Get Tags for Segment
784
+ # Return all tags associated with the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;segments:read&#x60; &#x60;tags:read&#x60;
785
+ # @param id [String]
786
+ # @param [Hash] opts the optional parameters
787
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
788
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
789
+ def get_tags_for_segment_with_http_info(id, opts = {})
790
+ if @api_client.config.debugging
791
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_tags_for_segment ...'
792
+ end
793
+ # verify the required parameter 'id' is set
794
+ if @api_client.config.client_side_validation && id.nil?
795
+ fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.get_tags_for_segment"
796
+ end
797
+ allowable_values = ["name"]
798
+ if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
799
+ fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
800
+ end
801
+ # resource path
802
+ local_var_path = '/api/segments/{id}/tags'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
803
+
804
+ # query parameters
805
+ query_params = opts[:query_params] || {}
806
+ query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
807
+
808
+ # header parameters
809
+ header_params = opts[:header_params] || {}
810
+ # klaviyo api revision
811
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
812
+ # HTTP header 'Accept' (if needed)
813
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
814
+
815
+ # form parameters
816
+ form_params = opts[:form_params] || {}
817
+
818
+ # http body (model)
819
+ post_body = opts[:debug_body]
820
+
821
+ # return_type
822
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
823
+
824
+ # auth_names
825
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
826
+
827
+ new_options = opts.merge(
828
+ :operation => :"SegmentsApi.get_tags_for_segment",
829
+ :header_params => header_params,
830
+ :query_params => query_params,
831
+ :form_params => form_params,
832
+ :body => post_body,
833
+ :auth_names => auth_names,
834
+ :return_type => return_type
835
+ )
836
+
837
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
838
+ if @api_client.config.debugging
839
+ @api_client.config.logger.debug "API called: SegmentsApi#get_tags_for_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
840
+ end
841
+ return data, status_code, headers
842
+ end
843
+
844
+ # alias of `get_tags_for_segment_with_http_info`
845
+ alias get_segment_tags_with_http_info get_tags_for_segment_with_http_info
846
+
672
847
  # Update Segment
673
848
  # Update a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`
674
849
  # @param id [String]
@@ -699,7 +874,7 @@ module KlaviyoAPI
699
874
  fail ArgumentError, "Missing the required parameter 'segment_partial_update_query' when calling SegmentsApi.update_segment"
700
875
  end
701
876
  # resource path
702
- local_var_path = '/api/segments/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
877
+ local_var_path = '/api/segments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
703
878
 
704
879
  # query parameters
705
880
  query_params = opts[:query_params] || {}
@@ -707,11 +882,11 @@ module KlaviyoAPI
707
882
  # header parameters
708
883
  header_params = opts[:header_params] || {}
709
884
  # klaviyo api revision
710
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
885
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
711
886
  # HTTP header 'Accept' (if needed)
712
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
887
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
713
888
  # HTTP header 'Content-Type'
714
- content_type = @api_client.select_header_content_type(['application/json'])
889
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
715
890
  if !content_type.nil?
716
891
  header_params['Content-Type'] = content_type
717
892
  end