klaviyo-api-sdk 8.0.0 → 10.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 +289 -0
  3. data/README.md +1414 -402
  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 +1764 -1446
  8. data/lib/klaviyo-api-sdk/api/coupons_api.rb +329 -281
  9. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +11 -5
  10. data/lib/klaviyo-api-sdk/api/events_api.rb +140 -122
  11. data/lib/klaviyo-api-sdk/api/flows_api.rb +487 -433
  12. data/lib/klaviyo-api-sdk/api/forms_api.rb +80 -60
  13. data/lib/klaviyo-api-sdk/api/images_api.rb +40 -28
  14. data/lib/klaviyo-api-sdk/api/lists_api.rb +328 -153
  15. data/lib/klaviyo-api-sdk/api/metrics_api.rb +590 -21
  16. data/lib/klaviyo-api-sdk/api/profiles_api.rb +1054 -548
  17. data/lib/klaviyo-api-sdk/api/reporting_api.rb +341 -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 +745 -625
  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 +248 -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 +2 -7
  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 +58 -3
  613. metadata +64 -9
@@ -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
@@ -23,9 +23,9 @@ module KlaviyoAPI
23
23
  # Get the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
24
24
  # @param id [String] The ID of the form
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
27
- # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
28
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
26
+ # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
27
+ # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
28
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
29
29
  # @return [Hash<String, Object>]
30
30
  def get_form(id, opts = {})
31
31
  data, _status_code, _headers = get_form_with_http_info(id, opts)
@@ -36,9 +36,9 @@ module KlaviyoAPI
36
36
  # Get the form with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;forms:read&#x60;
37
37
  # @param id [String] The ID of the form
38
38
  # @param [Hash] opts the optional parameters
39
- # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
40
- # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
41
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
39
+ # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
40
+ # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
41
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#relationships
42
42
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
43
43
  def get_form_with_http_info(id, opts = {})
44
44
  if @api_client.config.debugging
@@ -61,7 +61,7 @@ module KlaviyoAPI
61
61
  fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
62
62
  end
63
63
  # resource path
64
- local_var_path = '/api/forms/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
64
+ local_var_path = '/api/forms/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
65
65
 
66
66
  # query parameters
67
67
  query_params = opts[:query_params] || {}
@@ -72,9 +72,9 @@ module KlaviyoAPI
72
72
  # header parameters
73
73
  header_params = opts[:header_params] || {}
74
74
  # klaviyo api revision
75
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
75
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
76
76
  # HTTP header 'Accept' (if needed)
77
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
77
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
78
78
 
79
79
  # form parameters
80
80
  form_params = opts[:form_params] || {}
@@ -107,20 +107,23 @@ module KlaviyoAPI
107
107
 
108
108
  # Get Form for Form Version
109
109
  # Get the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
110
- # @param id [String]
110
+ # @param id [String] The ID of the form version
111
111
  # @param [Hash] opts the optional parameters
112
- # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
112
+ # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
113
113
  # @return [Hash<String, Object>]
114
114
  def get_form_for_form_version(id, opts = {})
115
115
  data, _status_code, _headers = get_form_for_form_version_with_http_info(id, opts)
116
116
  data
117
117
  end
118
118
 
119
+ # alias of `get_form_for_form_version`
120
+ alias get_form_version_form get_form_for_form_version
121
+
119
122
  # Get Form for Form Version
120
123
  # Get the form associated with the given form version.&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;forms:read&#x60;
121
- # @param id [String]
124
+ # @param id [String] The ID of the form version
122
125
  # @param [Hash] opts the optional parameters
123
- # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
126
+ # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
124
127
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
125
128
  def get_form_for_form_version_with_http_info(id, opts = {})
126
129
  if @api_client.config.debugging
@@ -135,7 +138,7 @@ module KlaviyoAPI
135
138
  fail ArgumentError, "invalid value for \"fields_form\", must include one of #{allowable_values}"
136
139
  end
137
140
  # resource path
138
- local_var_path = '/api/form-versions/{id}/form/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
141
+ local_var_path = '/api/form-versions/{id}/form'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
139
142
 
140
143
  # query parameters
141
144
  query_params = opts[:query_params] || {}
@@ -144,9 +147,9 @@ module KlaviyoAPI
144
147
  # header parameters
145
148
  header_params = opts[:header_params] || {}
146
149
  # klaviyo api revision
147
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
150
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
148
151
  # HTTP header 'Accept' (if needed)
149
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
152
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
150
153
 
151
154
  # form parameters
152
155
  form_params = opts[:form_params] || {}
@@ -177,9 +180,12 @@ module KlaviyoAPI
177
180
  return data, status_code, headers
178
181
  end
179
182
 
183
+ # alias of `get_form_for_form_version_with_http_info`
184
+ alias get_form_version_form_with_http_info get_form_for_form_version_with_http_info
185
+
180
186
  # Get Form ID for Form Version
181
187
  # Get the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
182
- # @param id [String]
188
+ # @param id [String] The ID of the form version
183
189
  # @param [Hash] opts the optional parameters
184
190
  # @return [Hash<String, Object>]
185
191
  def get_form_id_for_form_version(id, opts = {})
@@ -187,9 +193,12 @@ module KlaviyoAPI
187
193
  data
188
194
  end
189
195
 
196
+ # alias of `get_form_id_for_form_version`
197
+ alias get_form_version_relationships_form get_form_id_for_form_version
198
+
190
199
  # Get Form ID for Form Version
191
200
  # Get the ID of the form associated with the given form version.&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;forms:read&#x60;
192
- # @param id [String]
201
+ # @param id [String] The ID of the form version
193
202
  # @param [Hash] opts the optional parameters
194
203
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
195
204
  def get_form_id_for_form_version_with_http_info(id, opts = {})
@@ -201,7 +210,7 @@ module KlaviyoAPI
201
210
  fail ArgumentError, "Missing the required parameter 'id' when calling FormsApi.get_form_id_for_form_version"
202
211
  end
203
212
  # resource path
204
- local_var_path = '/api/form-versions/{id}/relationships/form/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
213
+ local_var_path = '/api/form-versions/{id}/relationships/form'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
205
214
 
206
215
  # query parameters
207
216
  query_params = opts[:query_params] || {}
@@ -209,9 +218,9 @@ module KlaviyoAPI
209
218
  # header parameters
210
219
  header_params = opts[:header_params] || {}
211
220
  # klaviyo api revision
212
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
221
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
213
222
  # HTTP header 'Accept' (if needed)
214
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
223
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
215
224
 
216
225
  # form parameters
217
226
  form_params = opts[:form_params] || {}
@@ -242,11 +251,14 @@ module KlaviyoAPI
242
251
  return data, status_code, headers
243
252
  end
244
253
 
254
+ # alias of `get_form_id_for_form_version_with_http_info`
255
+ alias get_form_version_relationships_form_with_http_info get_form_id_for_form_version_with_http_info
256
+
245
257
  # Get Form Version
246
258
  # Get the form version with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
247
259
  # @param id [String] The ID of the form version
248
260
  # @param [Hash] opts the optional parameters
249
- # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
261
+ # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
250
262
  # @return [Hash<String, Object>]
251
263
  def get_form_version(id, opts = {})
252
264
  data, _status_code, _headers = get_form_version_with_http_info(id, opts)
@@ -257,7 +269,7 @@ module KlaviyoAPI
257
269
  # Get the form version with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;forms:read&#x60;
258
270
  # @param id [String] The ID of the form version
259
271
  # @param [Hash] opts the optional parameters
260
- # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
272
+ # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
261
273
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
262
274
  def get_form_version_with_http_info(id, opts = {})
263
275
  if @api_client.config.debugging
@@ -272,7 +284,7 @@ module KlaviyoAPI
272
284
  fail ArgumentError, "invalid value for \"fields_form_version\", must include one of #{allowable_values}"
273
285
  end
274
286
  # resource path
275
- local_var_path = '/api/form-versions/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
287
+ local_var_path = '/api/form-versions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
276
288
 
277
289
  # query parameters
278
290
  query_params = opts[:query_params] || {}
@@ -281,9 +293,9 @@ module KlaviyoAPI
281
293
  # header parameters
282
294
  header_params = opts[:header_params] || {}
283
295
  # klaviyo api revision
284
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
296
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
285
297
  # HTTP header 'Accept' (if needed)
286
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
298
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
287
299
 
288
300
  # form parameters
289
301
  form_params = opts[:form_params] || {}
@@ -317,11 +329,11 @@ module KlaviyoAPI
317
329
  # Get Forms
318
330
  # Get all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
319
331
  # @param [Hash] opts the optional parameters
320
- # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
321
- # @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;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;ab_test&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
322
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
332
+ # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
333
+ # @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;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;ab_test&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
334
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
323
335
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
324
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
336
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
325
337
  # @return [Hash<String, Object>]
326
338
  def get_forms(opts = {})
327
339
  data, _status_code, _headers = get_forms_with_http_info(opts)
@@ -331,11 +343,11 @@ module KlaviyoAPI
331
343
  # Get Forms
332
344
  # Get all forms in an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;forms:read&#x60;
333
345
  # @param [Hash] opts the optional parameters
334
- # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
335
- # @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;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;ab_test&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
336
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
346
+ # @option opts [Array<String>] :fields_form For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
347
+ # @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;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;ab_test&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
348
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
337
349
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
338
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
350
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
339
351
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
340
352
  def get_forms_with_http_info(opts = {})
341
353
  if @api_client.config.debugging
@@ -358,7 +370,7 @@ module KlaviyoAPI
358
370
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
359
371
  end
360
372
  # resource path
361
- local_var_path = '/api/forms/'
373
+ local_var_path = '/api/forms'
362
374
 
363
375
  # query parameters
364
376
  query_params = opts[:query_params] || {}
@@ -371,9 +383,9 @@ module KlaviyoAPI
371
383
  # header parameters
372
384
  header_params = opts[:header_params] || {}
373
385
  # klaviyo api revision
374
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
386
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
375
387
  # HTTP header 'Accept' (if needed)
376
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
388
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
377
389
 
378
390
  # form parameters
379
391
  form_params = opts[:form_params] || {}
@@ -406,7 +418,7 @@ module KlaviyoAPI
406
418
 
407
419
  # Get Version IDs for Form
408
420
  # Get the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
409
- # @param id [String]
421
+ # @param id [String] The ID of the form
410
422
  # @param [Hash] opts the optional parameters
411
423
  # @return [Hash<String, Object>]
412
424
  def get_version_ids_for_form(id, opts = {})
@@ -414,9 +426,12 @@ module KlaviyoAPI
414
426
  data
415
427
  end
416
428
 
429
+ # alias of `get_version_ids_for_form`
430
+ alias get_form_relationships_form_versions get_version_ids_for_form
431
+
417
432
  # Get Version IDs for Form
418
433
  # Get the IDs of the form versions for the given form.&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;forms:read&#x60;
419
- # @param id [String]
434
+ # @param id [String] The ID of the form
420
435
  # @param [Hash] opts the optional parameters
421
436
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
422
437
  def get_version_ids_for_form_with_http_info(id, opts = {})
@@ -428,7 +443,7 @@ module KlaviyoAPI
428
443
  fail ArgumentError, "Missing the required parameter 'id' when calling FormsApi.get_version_ids_for_form"
429
444
  end
430
445
  # resource path
431
- local_var_path = '/api/forms/{id}/relationships/form-versions/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
446
+ local_var_path = '/api/forms/{id}/relationships/form-versions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
432
447
 
433
448
  # query parameters
434
449
  query_params = opts[:query_params] || {}
@@ -436,9 +451,9 @@ module KlaviyoAPI
436
451
  # header parameters
437
452
  header_params = opts[:header_params] || {}
438
453
  # klaviyo api revision
439
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
454
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
440
455
  # HTTP header 'Accept' (if needed)
441
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
456
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
442
457
 
443
458
  # form parameters
444
459
  form_params = opts[:form_params] || {}
@@ -469,39 +484,41 @@ module KlaviyoAPI
469
484
  return data, status_code, headers
470
485
  end
471
486
 
487
+ # alias of `get_version_ids_for_form_with_http_info`
488
+ alias get_form_relationships_form_versions_with_http_info get_version_ids_for_form_with_http_info
489
+
472
490
  # Get Versions for Form
473
491
  # Get the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
474
- # @param id [String]
492
+ # @param id [String] The ID of the form
475
493
  # @param [Hash] opts the optional parameters
476
- # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
477
- # @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;form_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
478
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
494
+ # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
495
+ # @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;form_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
496
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
479
497
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
480
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
498
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
481
499
  # @return [Hash<String, Object>]
482
500
  def get_versions_for_form(id, opts = {})
483
501
  data, _status_code, _headers = get_versions_for_form_with_http_info(id, opts)
484
502
  data
485
503
  end
486
504
 
505
+ # alias of `get_versions_for_form`
506
+ alias get_form_form_versions get_versions_for_form
507
+
487
508
  # Get Versions for Form
488
509
  # Get the form versions for the given form.&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;forms:read&#x60;
489
- # @param id [String]
510
+ # @param id [String] The ID of the form
490
511
  # @param [Hash] opts the optional parameters
491
- # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
492
- # @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;form_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
493
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
512
+ # @option opts [Array<String>] :fields_form_version For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
513
+ # @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;form_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
514
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
494
515
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
495
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
516
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
496
517
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
497
518
  def get_versions_for_form_with_http_info(id, opts = {})
498
519
  if @api_client.config.debugging
499
520
  @api_client.config.logger.debug 'Calling API: FormsApi.get_versions_for_form ...'
500
521
  end
501
- # verify the required parameter 'id' is set
502
- if @api_client.config.client_side_validation && id.nil?
503
- fail ArgumentError, "Missing the required parameter 'id' when calling FormsApi.get_versions_for_form"
504
- end
505
522
  allowable_values = ["form_type", "ab_test", "ab_test.variation_name", "status", "created_at", "updated_at"]
506
523
  if @api_client.config.client_side_validation && opts[:'fields_form_version'] && !opts[:'fields_form_version'].all? { |item| allowable_values.include?(item) }
507
524
  fail ArgumentError, "invalid value for \"fields_form_version\", must include one of #{allowable_values}"
@@ -519,7 +536,7 @@ module KlaviyoAPI
519
536
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
520
537
  end
521
538
  # resource path
522
- local_var_path = '/api/forms/{id}/form-versions/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
539
+ local_var_path = '/api/forms/{id}/form-versions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
523
540
 
524
541
  # query parameters
525
542
  query_params = opts[:query_params] || {}
@@ -532,9 +549,9 @@ module KlaviyoAPI
532
549
  # header parameters
533
550
  header_params = opts[:header_params] || {}
534
551
  # klaviyo api revision
535
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
552
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
536
553
  # HTTP header 'Accept' (if needed)
537
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
554
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
538
555
 
539
556
  # form parameters
540
557
  form_params = opts[:form_params] || {}
@@ -564,5 +581,8 @@ module KlaviyoAPI
564
581
  end
565
582
  return data, status_code, headers
566
583
  end
584
+
585
+ # alias of `get_versions_for_form_with_http_info`
586
+ alias get_form_form_versions_with_http_info get_versions_for_form_with_http_info
567
587
  end
568
588
  end
@@ -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
@@ -23,7 +23,7 @@ module KlaviyoAPI
23
23
  # Get the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
24
24
  # @param id [String] The ID of the image
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
26
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
27
27
  # @return [Hash<String, Object>]
28
28
  def get_image(id, opts = {})
29
29
  data, _status_code, _headers = get_image_with_http_info(id, opts)
@@ -34,7 +34,7 @@ module KlaviyoAPI
34
34
  # Get the image with the given image ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;images:read&#x60;
35
35
  # @param id [String] The ID of the image
36
36
  # @param [Hash] opts the optional parameters
37
- # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
37
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
38
38
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
39
39
  def get_image_with_http_info(id, opts = {})
40
40
  if @api_client.config.debugging
@@ -49,7 +49,7 @@ module KlaviyoAPI
49
49
  fail ArgumentError, "invalid value for \"fields_image\", must include one of #{allowable_values}"
50
50
  end
51
51
  # resource path
52
- local_var_path = '/api/images/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
52
+ local_var_path = '/api/images/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
53
53
 
54
54
  # query parameters
55
55
  query_params = opts[:query_params] || {}
@@ -58,9 +58,9 @@ module KlaviyoAPI
58
58
  # header parameters
59
59
  header_params = opts[:header_params] || {}
60
60
  # klaviyo api revision
61
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
61
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
62
62
  # HTTP header 'Accept' (if needed)
63
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
63
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
64
64
 
65
65
  # form parameters
66
66
  form_params = opts[:form_params] || {}
@@ -94,11 +94,11 @@ module KlaviyoAPI
94
94
  # Get Images
95
95
  # Get all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
96
96
  # @param [Hash] opts the optional parameters
97
- # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
98
- # @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;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
99
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
97
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
98
+ # @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;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
99
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
100
100
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
101
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
101
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
102
102
  # @return [Hash<String, Object>]
103
103
  def get_images(opts = {})
104
104
  data, _status_code, _headers = get_images_with_http_info(opts)
@@ -108,11 +108,11 @@ module KlaviyoAPI
108
108
  # Get Images
109
109
  # Get all images in an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;images:read&#x60;
110
110
  # @param [Hash] opts the optional parameters
111
- # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
112
- # @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;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
113
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
111
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sparse-fieldsets
112
+ # @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;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
113
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination
114
114
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
115
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
115
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting
116
116
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
117
117
  def get_images_with_http_info(opts = {})
118
118
  if @api_client.config.debugging
@@ -135,7 +135,7 @@ module KlaviyoAPI
135
135
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
136
136
  end
137
137
  # resource path
138
- local_var_path = '/api/images/'
138
+ local_var_path = '/api/images'
139
139
 
140
140
  # query parameters
141
141
  query_params = opts[:query_params] || {}
@@ -148,9 +148,9 @@ module KlaviyoAPI
148
148
  # header parameters
149
149
  header_params = opts[:header_params] || {}
150
150
  # klaviyo api revision
151
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
151
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
152
152
  # HTTP header 'Accept' (if needed)
153
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
153
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
154
154
 
155
155
  # form parameters
156
156
  form_params = opts[:form_params] || {}
@@ -211,7 +211,7 @@ module KlaviyoAPI
211
211
  fail ArgumentError, "Missing the required parameter 'image_partial_update_query' when calling ImagesApi.update_image"
212
212
  end
213
213
  # resource path
214
- local_var_path = '/api/images/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
214
+ local_var_path = '/api/images/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
215
215
 
216
216
  # query parameters
217
217
  query_params = opts[:query_params] || {}
@@ -219,11 +219,11 @@ module KlaviyoAPI
219
219
  # header parameters
220
220
  header_params = opts[:header_params] || {}
221
221
  # klaviyo api revision
222
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
222
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
223
223
  # HTTP header 'Accept' (if needed)
224
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
224
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
225
225
  # HTTP header 'Content-Type'
226
- content_type = @api_client.select_header_content_type(['application/json'])
226
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
227
227
  if !content_type.nil?
228
228
  header_params['Content-Type'] = content_type
229
229
  end
@@ -269,6 +269,9 @@ module KlaviyoAPI
269
269
  data
270
270
  end
271
271
 
272
+ # alias of `upload_image_from_file`
273
+ alias create_image_upload upload_image_from_file
274
+
272
275
  # Upload Image From File
273
276
  # Upload an image from a file. If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;100/m&#x60;&lt;br&gt;Daily: &#x60;100/d&#x60; **Scopes:** &#x60;images:write&#x60;
274
277
  # @param file [File] The image file to upload. Supported image formats: jpeg,png,gif. Maximum image size: 5MB.
@@ -285,7 +288,7 @@ module KlaviyoAPI
285
288
  fail ArgumentError, "Missing the required parameter 'file' when calling ImagesApi.upload_image_from_file"
286
289
  end
287
290
  # resource path
288
- local_var_path = '/api/image-upload/'
291
+ local_var_path = '/api/image-upload'
289
292
 
290
293
  # query parameters
291
294
  query_params = opts[:query_params] || {}
@@ -293,9 +296,9 @@ module KlaviyoAPI
293
296
  # header parameters
294
297
  header_params = opts[:header_params] || {}
295
298
  # klaviyo api revision
296
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
299
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
297
300
  # HTTP header 'Accept' (if needed)
298
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
301
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
299
302
  # HTTP header 'Content-Type'
300
303
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
301
304
  if !content_type.nil?
@@ -334,6 +337,9 @@ module KlaviyoAPI
334
337
  return data, status_code, headers
335
338
  end
336
339
 
340
+ # alias of `upload_image_from_file_with_http_info`
341
+ alias create_image_upload_with_http_info upload_image_from_file_with_http_info
342
+
337
343
  # Upload Image From URL
338
344
  # Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d` **Scopes:** `images:write`
339
345
  # @param image_create_query [ImageCreateQuery]
@@ -344,6 +350,9 @@ module KlaviyoAPI
344
350
  data
345
351
  end
346
352
 
353
+ # alias of `upload_image_from_url`
354
+ alias create_image upload_image_from_url
355
+
347
356
  # Upload Image From URL
348
357
  # Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;100/m&#x60;&lt;br&gt;Daily: &#x60;100/d&#x60; **Scopes:** &#x60;images:write&#x60;
349
358
  # @param image_create_query [ImageCreateQuery]
@@ -358,7 +367,7 @@ module KlaviyoAPI
358
367
  fail ArgumentError, "Missing the required parameter 'image_create_query' when calling ImagesApi.upload_image_from_url"
359
368
  end
360
369
  # resource path
361
- local_var_path = '/api/images/'
370
+ local_var_path = '/api/images'
362
371
 
363
372
  # query parameters
364
373
  query_params = opts[:query_params] || {}
@@ -366,11 +375,11 @@ module KlaviyoAPI
366
375
  # header parameters
367
376
  header_params = opts[:header_params] || {}
368
377
  # klaviyo api revision
369
- header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-07-15"
378
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-10-15"
370
379
  # HTTP header 'Accept' (if needed)
371
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
380
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
372
381
  # HTTP header 'Content-Type'
373
- content_type = @api_client.select_header_content_type(['application/json'])
382
+ content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
374
383
  if !content_type.nil?
375
384
  header_params['Content-Type'] = content_type
376
385
  end
@@ -403,5 +412,8 @@ module KlaviyoAPI
403
412
  end
404
413
  return data, status_code, headers
405
414
  end
415
+
416
+ # alias of `upload_image_from_url_with_http_info`
417
+ alias create_image_with_http_info upload_image_from_url_with_http_info
406
418
  end
407
419
  end