klaviyo-api-sdk 1.1.0 → 1.2.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 (324) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/README.md +314 -136
  4. data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
  5. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
  6. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
  7. data/docs/CampaignTagOp.md +18 -0
  8. data/docs/CampaignTagOpDataInner.md +20 -0
  9. data/docs/CampaignsApi.md +1277 -0
  10. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  11. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +6 -6
  12. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  13. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +2 -2
  14. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  15. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +2 -2
  16. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +2 -2
  17. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  18. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +21 -19
  19. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  20. data/docs/CatalogItemDeleteQueryAsSubResource.md +2 -2
  21. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  22. data/docs/CatalogItemUpdateQueryAsSubResource.md +2 -2
  23. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +18 -16
  24. data/docs/CatalogJobErrorPayload.md +8 -8
  25. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  26. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +27 -27
  27. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  28. data/docs/CatalogVariantDeleteQueryAsSubResource.md +2 -2
  29. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  30. data/docs/CatalogVariantUpdateQueryAsSubResource.md +2 -2
  31. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +22 -22
  32. data/docs/CatalogsApi.md +238 -238
  33. data/docs/ErrorSource.md +1 -1
  34. data/docs/EventsApi.md +26 -26
  35. data/docs/FlowsApi.md +64 -56
  36. data/docs/GetCampaigns4XXResponse.md +18 -0
  37. data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
  38. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
  39. data/docs/IncludedCategories.md +2 -2
  40. data/docs/IncludedCategoriesAttributes.md +5 -5
  41. data/docs/IncludedItems.md +2 -2
  42. data/docs/IncludedItemsAttributes.md +22 -20
  43. data/docs/IncludedLists.md +2 -2
  44. data/docs/IncludedListsAttributes.md +4 -4
  45. data/docs/IncludedProfiles.md +2 -2
  46. data/docs/IncludedProfilesAttributes.md +21 -21
  47. data/docs/IncludedSegments.md +1 -1
  48. data/docs/IncludedSegmentsAttributes.md +22 -0
  49. data/docs/IncludedTags.md +24 -0
  50. data/docs/IncludedVariants.md +2 -2
  51. data/docs/IncludedVariantsAttributes.md +28 -28
  52. data/docs/ListCreateQueryAsSubResourceAttributes.md +2 -2
  53. data/docs/ListPartialUpdateQueryAsSubResource.md +2 -2
  54. data/docs/ListsApi.md +30 -30
  55. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +5 -5
  56. data/docs/MetricsApi.md +9 -9
  57. data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
  58. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +18 -18
  59. data/docs/ProfileLocation.md +15 -15
  60. data/docs/ProfileLocationLongitude.md +49 -0
  61. data/docs/ProfilePartialUpdateQueryAsSubResource.md +2 -2
  62. data/docs/ProfilesApi.md +26 -26
  63. data/docs/STOScheduleOptions.md +18 -0
  64. data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
  65. data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
  66. data/docs/SegmentsApi.md +19 -19
  67. data/docs/SendOptionsSubObject.md +1 -3
  68. data/docs/SendStrategySubObject.md +4 -2
  69. data/docs/Subscription.md +8 -4
  70. data/docs/SubscriptionChannels.md +20 -0
  71. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +2 -2
  72. data/docs/Suppression.md +1 -1
  73. data/docs/TagsApi.md +24 -24
  74. data/docs/TemplateCloneQueryAsSubResource.md +0 -2
  75. data/docs/TemplatesApi.md +11 -11
  76. data/docs/ThrottledScheduleOptions.md +1 -1
  77. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
  78. data/klaviyo-api-sdk.gemspec +2 -2
  79. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
  80. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +299 -299
  81. data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
  82. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  83. data/lib/klaviyo-api-sdk/api/events_api.rb +33 -33
  84. data/lib/klaviyo-api-sdk/api/flows_api.rb +86 -74
  85. data/lib/klaviyo-api-sdk/api/lists_api.rb +39 -39
  86. data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
  87. data/lib/klaviyo-api-sdk/api/profiles_api.rb +34 -34
  88. data/lib/klaviyo-api-sdk/api/segments_api.rb +25 -25
  89. data/lib/klaviyo-api-sdk/api/tags_api.rb +41 -41
  90. data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
  91. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  92. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  93. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
  111. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +272 -0
  112. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +225 -0
  113. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
  120. data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +272 -0
  121. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +5 -2
  127. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +2 -2
  131. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +2 -2
  137. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +23 -3
  145. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +2 -2
  152. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +2 -2
  157. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +20 -2
  158. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +16 -8
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +2 -2
  172. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +2 -2
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +12 -2
  178. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
  185. data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
  192. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
  193. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
  194. data/lib/klaviyo-api-sdk/models/included_categories.rb +2 -2
  195. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +4 -1
  196. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/included_flows.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/included_items.rb +2 -1
  206. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +23 -2
  207. data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -1
  208. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +4 -1
  209. data/lib/klaviyo-api-sdk/models/included_metrics.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -1
  212. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +13 -1
  213. data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
  214. data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
  215. data/lib/klaviyo-api-sdk/models/included_tags.rb +301 -0
  216. data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -1
  217. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +16 -2
  218. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -1
  222. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  223. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -1
  227. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +17 -15
  230. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  235. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
  236. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +10 -1
  242. data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
  243. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
  244. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
  245. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -1
  247. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
  249. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +224 -0
  250. data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
  252. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
  253. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
  259. data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
  260. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
  261. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  275. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +2 -13
  284. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +1 -1
  287. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +1 -1
  288. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  289. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +1 -1
  291. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  304. data/lib/klaviyo-api-sdk/version.rb +1 -1
  305. data/lib/klaviyo-api-sdk.rb +14 -5
  306. data/spec/api/campaigns_api_spec.rb +284 -0
  307. data/spec/api_client_spec.rb +1 -1
  308. data/spec/configuration_spec.rb +1 -1
  309. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  310. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +44 -0
  311. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
  312. data/spec/models/campaign_tag_op_data_inner_spec.rb +44 -0
  313. data/spec/models/campaign_tag_op_spec.rb +34 -0
  314. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
  315. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
  316. data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
  317. data/spec/models/included_segments_attributes_spec.rb +46 -0
  318. data/spec/models/included_tags_spec.rb +56 -0
  319. data/spec/models/profile_location_longitude_spec.rb +31 -0
  320. data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
  321. data/spec/models/sto_schedule_options_spec.rb +34 -0
  322. data/spec/models/subscription_channels_spec.rb +48 -0
  323. data/spec/spec_helper.rb +1 -1
  324. metadata +51 -6
@@ -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: 2023-01-24
6
+ The version of the OpenAPI document: 2023-02-22
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 a flow with the given flow ID. Include parameters can be provided to get the following related resource data: `flow-actions`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
24
24
  # @param id [String]
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
27
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
28
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
26
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
27
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
28
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
29
29
  # @return [Hash<String, Object>]
30
30
  def get_flow(id, opts = {})
31
31
  data, _status_code, _headers = get_flow_with_http_info(id, opts)
@@ -36,9 +36,9 @@ module KlaviyoAPI
36
36
  # Get a flow with the given flow ID. Include parameters can be provided to get the following related resource data: &#x60;flow-actions&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
37
37
  # @param id [String]
38
38
  # @param [Hash] opts the optional parameters
39
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
40
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
41
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
39
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
40
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
41
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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_flow_with_http_info(id, opts = {})
44
44
  if @api_client.config.debugging
@@ -72,7 +72,7 @@ module KlaviyoAPI
72
72
  # header parameters
73
73
  header_params = opts[:header_params] || {}
74
74
  # klaviyo api revision
75
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
75
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
76
76
  # HTTP header 'Accept' (if needed)
77
77
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
78
78
 
@@ -109,10 +109,10 @@ module KlaviyoAPI
109
109
  # Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: `flows`, `flow-messages`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
110
110
  # @param id [String]
111
111
  # @param [Hash] opts the optional parameters
112
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
113
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
114
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
115
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
112
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
113
+ # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
114
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
115
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
116
116
  # @return [Hash<String, Object>]
117
117
  def get_flow_action(id, opts = {})
118
118
  data, _status_code, _headers = get_flow_action_with_http_info(id, opts)
@@ -123,10 +123,10 @@ module KlaviyoAPI
123
123
  # Get a flow action from a flow with the given flow action ID. Include parameters can be provided to get the following related resource data: &#x60;flows&#x60;, &#x60;flow-messages&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
124
124
  # @param id [String]
125
125
  # @param [Hash] opts the optional parameters
126
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
127
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
128
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
129
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
126
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
127
+ # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
128
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
129
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
130
130
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
131
131
  def get_flow_action_with_http_info(id, opts = {})
132
132
  if @api_client.config.debugging
@@ -165,7 +165,7 @@ module KlaviyoAPI
165
165
  # header parameters
166
166
  header_params = opts[:header_params] || {}
167
167
  # klaviyo api revision
168
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
168
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
169
169
  # HTTP header 'Accept' (if needed)
170
170
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
171
171
 
@@ -202,7 +202,7 @@ module KlaviyoAPI
202
202
  # Get the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
203
203
  # @param action_id [String]
204
204
  # @param [Hash] opts the optional parameters
205
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
205
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
206
206
  # @return [Hash<String, Object>]
207
207
  def get_flow_action_flow(action_id, opts = {})
208
208
  data, _status_code, _headers = get_flow_action_flow_with_http_info(action_id, opts)
@@ -213,7 +213,7 @@ module KlaviyoAPI
213
213
  # Get the flow associated with the given action 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;Flows Read&#x60;
214
214
  # @param action_id [String]
215
215
  # @param [Hash] opts the optional parameters
216
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
216
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
217
217
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
218
218
  def get_flow_action_flow_with_http_info(action_id, opts = {})
219
219
  if @api_client.config.debugging
@@ -237,7 +237,7 @@ module KlaviyoAPI
237
237
  # header parameters
238
238
  header_params = opts[:header_params] || {}
239
239
  # klaviyo api revision
240
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
240
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
241
241
  # HTTP header 'Accept' (if needed)
242
242
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
243
243
 
@@ -271,12 +271,13 @@ module KlaviyoAPI
271
271
  end
272
272
 
273
273
  # Get Messages For Flow Action
274
- # Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: ascending: `id`, `name`, `created`, `updated` descending: `-id`, `-name`, `-created`, `-updated` Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
274
+ # Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
275
275
  # @param action_id [String]
276
276
  # @param [Hash] opts the optional parameters
277
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
278
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
279
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
277
+ # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
278
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
279
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
280
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
280
281
  # @return [Hash<String, Object>]
281
282
  def get_flow_action_messages(action_id, opts = {})
282
283
  data, _status_code, _headers = get_flow_action_messages_with_http_info(action_id, opts)
@@ -284,12 +285,13 @@ module KlaviyoAPI
284
285
  end
285
286
 
286
287
  # Get Messages For Flow Action
287
- # Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: ascending: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, &#x60;updated&#x60; descending: &#x60;-id&#x60;, &#x60;-name&#x60;, &#x60;-created&#x60;, &#x60;-updated&#x60; Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: &#x60;page[size]&#x60; and &#x60;page[number]&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
288
+ # Get all flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
288
289
  # @param action_id [String]
289
290
  # @param [Hash] opts the optional parameters
290
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
291
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
292
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
291
+ # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
292
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
293
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
294
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
293
295
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
294
296
  def get_flow_action_messages_with_http_info(action_id, opts = {})
295
297
  if @api_client.config.debugging
@@ -314,12 +316,13 @@ module KlaviyoAPI
314
316
  query_params = opts[:query_params] || {}
315
317
  query_params[:'fields[flow-message]'] = @api_client.build_collection_param(opts[:'fields_flow_message'], :csv) if !opts[:'fields_flow_message'].nil?
316
318
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
319
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
317
320
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
318
321
 
319
322
  # header parameters
320
323
  header_params = opts[:header_params] || {}
321
324
  # klaviyo api revision
322
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
325
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
323
326
  # HTTP header 'Accept' (if needed)
324
327
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
325
328
 
@@ -353,12 +356,13 @@ module KlaviyoAPI
353
356
  end
354
357
 
355
358
  # Get Flow Action Relationships
356
- # Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow messages associated with the given flow action ID. Flow message relationships can be sorted by the following fields, in ascending and descending order: `id`, `name`, `created`, `updated` Returns a maximum of 50 flow message relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
359
+ # Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
357
360
  # @param id [String]
358
361
  # @param related_resource [String]
359
362
  # @param [Hash] opts the optional parameters
360
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
361
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
363
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
364
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
365
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
362
366
  # @return [Hash<String, Object>]
363
367
  def get_flow_action_relationships(id, related_resource, opts = {})
364
368
  data, _status_code, _headers = get_flow_action_relationships_with_http_info(id, related_resource, opts)
@@ -366,12 +370,13 @@ module KlaviyoAPI
366
370
  end
367
371
 
368
372
  # Get Flow Action Relationships
369
- # Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow messages associated with the given flow action ID. Flow message relationships can be sorted by the following fields, in ascending and descending order: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, &#x60;updated&#x60; Returns a maximum of 50 flow message relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: &#x60;page[size]&#x60; and &#x60;page[number]&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
373
+ # Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
370
374
  # @param id [String]
371
375
  # @param related_resource [String]
372
376
  # @param [Hash] opts the optional parameters
373
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
374
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
377
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
378
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
379
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
375
380
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
376
381
  def get_flow_action_relationships_with_http_info(id, related_resource, opts = {})
377
382
  if @api_client.config.debugging
@@ -400,12 +405,13 @@ module KlaviyoAPI
400
405
  # query parameters
401
406
  query_params = opts[:query_params] || {}
402
407
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
408
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
403
409
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
404
410
 
405
411
  # header parameters
406
412
  header_params = opts[:header_params] || {}
407
413
  # klaviyo api revision
408
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
414
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
409
415
  # HTTP header 'Accept' (if needed)
410
416
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
411
417
 
@@ -439,12 +445,13 @@ module KlaviyoAPI
439
445
  end
440
446
 
441
447
  # Get Flow Actions For Flow
442
- # Get all flow actions associated with the given flow ID. Flow actions can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated`, `action_type` Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
448
+ # Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
443
449
  # @param flow_id [String]
444
450
  # @param [Hash] opts the optional parameters
445
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
446
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;action_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
447
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
451
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
452
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;action_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
453
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
454
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
448
455
  # @return [Hash<String, Object>]
449
456
  def get_flow_flow_actions(flow_id, opts = {})
450
457
  data, _status_code, _headers = get_flow_flow_actions_with_http_info(flow_id, opts)
@@ -452,12 +459,13 @@ module KlaviyoAPI
452
459
  end
453
460
 
454
461
  # Get Flow Actions For Flow
455
- # Get all flow actions associated with the given flow ID. Flow actions can be sorted by the following fields, in ascending and descending order: &#x60;id&#x60;, &#x60;status&#x60;, &#x60;created&#x60;, &#x60;updated&#x60;, &#x60;action_type&#x60; Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: &#x60;page[size]&#x60; and &#x60;page[number]&#x60;.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
462
+ # Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
456
463
  # @param flow_id [String]
457
464
  # @param [Hash] opts the optional parameters
458
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
459
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;action_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
460
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
465
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
466
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;action_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
467
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
468
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
461
469
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
462
470
  def get_flow_flow_actions_with_http_info(flow_id, opts = {})
463
471
  if @api_client.config.debugging
@@ -482,12 +490,13 @@ module KlaviyoAPI
482
490
  query_params = opts[:query_params] || {}
483
491
  query_params[:'fields[flow-action]'] = @api_client.build_collection_param(opts[:'fields_flow_action'], :csv) if !opts[:'fields_flow_action'].nil?
484
492
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
493
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
485
494
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
486
495
 
487
496
  # header parameters
488
497
  header_params = opts[:header_params] || {}
489
498
  # klaviyo api revision
490
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
499
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
491
500
  # HTTP header 'Accept' (if needed)
492
501
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
493
502
 
@@ -524,9 +533,9 @@ module KlaviyoAPI
524
533
  # Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
525
534
  # @param id [String]
526
535
  # @param [Hash] opts the optional parameters
527
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
528
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
529
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
536
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
537
+ # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
538
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
530
539
  # @return [Hash<String, Object>]
531
540
  def get_flow_message(id, opts = {})
532
541
  data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
@@ -537,9 +546,9 @@ module KlaviyoAPI
537
546
  # Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: &#39;flow-actions&#39;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
538
547
  # @param id [String]
539
548
  # @param [Hash] opts the optional parameters
540
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
541
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
542
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
549
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
550
+ # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
551
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
543
552
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
544
553
  def get_flow_message_with_http_info(id, opts = {})
545
554
  if @api_client.config.debugging
@@ -573,7 +582,7 @@ module KlaviyoAPI
573
582
  # header parameters
574
583
  header_params = opts[:header_params] || {}
575
584
  # klaviyo api revision
576
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
585
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
577
586
  # HTTP header 'Accept' (if needed)
578
587
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
579
588
 
@@ -610,7 +619,7 @@ module KlaviyoAPI
610
619
  # Get the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
611
620
  # @param message_id [String]
612
621
  # @param [Hash] opts the optional parameters
613
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
622
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
614
623
  # @return [Hash<String, Object>]
615
624
  def get_flow_message_action(message_id, opts = {})
616
625
  data, _status_code, _headers = get_flow_message_action_with_http_info(message_id, opts)
@@ -621,7 +630,7 @@ module KlaviyoAPI
621
630
  # Get the flow action for a flow message with the given message 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;Flows Read&#x60;
622
631
  # @param message_id [String]
623
632
  # @param [Hash] opts the optional parameters
624
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
633
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
625
634
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
626
635
  def get_flow_message_action_with_http_info(message_id, opts = {})
627
636
  if @api_client.config.debugging
@@ -645,7 +654,7 @@ module KlaviyoAPI
645
654
  # header parameters
646
655
  header_params = opts[:header_params] || {}
647
656
  # klaviyo api revision
648
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
657
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
649
658
  # HTTP header 'Accept' (if needed)
650
659
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
651
660
 
@@ -721,7 +730,7 @@ module KlaviyoAPI
721
730
  # header parameters
722
731
  header_params = opts[:header_params] || {}
723
732
  # klaviyo api revision
724
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
733
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
725
734
  # HTTP header 'Accept' (if needed)
726
735
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
727
736
 
@@ -797,7 +806,7 @@ module KlaviyoAPI
797
806
  # header parameters
798
807
  header_params = opts[:header_params] || {}
799
808
  # klaviyo api revision
800
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
809
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
801
810
  # HTTP header 'Accept' (if needed)
802
811
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
803
812
 
@@ -834,7 +843,7 @@ module KlaviyoAPI
834
843
  # Return all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` `Tags Read`
835
844
  # @param flow_id [String]
836
845
  # @param [Hash] opts the optional parameters
837
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
846
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
838
847
  # @return [Hash<String, Object>]
839
848
  def get_flow_tags(flow_id, opts = {})
840
849
  data, _status_code, _headers = get_flow_tags_with_http_info(flow_id, opts)
@@ -845,7 +854,7 @@ module KlaviyoAPI
845
854
  # Return all tags associated with the given flow 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;Flows Read&#x60; &#x60;Tags Read&#x60;
846
855
  # @param flow_id [String]
847
856
  # @param [Hash] opts the optional parameters
848
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
857
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
849
858
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
850
859
  def get_flow_tags_with_http_info(flow_id, opts = {})
851
860
  if @api_client.config.debugging
@@ -869,7 +878,7 @@ module KlaviyoAPI
869
878
  # header parameters
870
879
  header_params = opts[:header_params] || {}
871
880
  # klaviyo api revision
872
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
881
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
873
882
  # HTTP header 'Accept' (if needed)
874
883
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
875
884
 
@@ -903,13 +912,14 @@ module KlaviyoAPI
903
912
  end
904
913
 
905
914
  # Get Flows
906
- # Get all flows in an account. Flows can be sorted by the following fields, in ascending and descending order: `id`, `name`, `status`, `trigger_type`, `created`, `updated` Include parameters can be provided to get the following related resource data: `flow-actions` Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
915
+ # Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
907
916
  # @param [Hash] opts the optional parameters
908
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
909
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
910
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;trigger_type&#x60;: &#x60;equals&#x60;
911
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
912
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
917
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
918
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
919
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;trigger_type&#x60;: &#x60;equals&#x60;
920
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
921
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
922
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
913
923
  # @return [Hash<String, Object>]
914
924
  def get_flows(opts = {})
915
925
  data, _status_code, _headers = get_flows_with_http_info(opts)
@@ -917,13 +927,14 @@ module KlaviyoAPI
917
927
  end
918
928
 
919
929
  # Get Flows
920
- # Get all flows in an account. Flows can be sorted by the following fields, in ascending and descending order: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;status&#x60;, &#x60;trigger_type&#x60;, &#x60;created&#x60;, &#x60;updated&#x60; Include parameters can be provided to get the following related resource data: &#x60;flow-actions&#x60; Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: &#x60;page[size]&#x60; and &#x60;page[number]&#x60;.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
930
+ # Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Flows Read&#x60;
921
931
  # @param [Hash] opts the optional parameters
922
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
923
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
924
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;trigger_type&#x60;: &#x60;equals&#x60;
925
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
926
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
932
+ # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
933
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
934
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;equals&#x60;, &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;trigger_type&#x60;: &#x60;equals&#x60;
935
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
936
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
937
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
927
938
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
928
939
  def get_flows_with_http_info(opts = {})
929
940
  if @api_client.config.debugging
@@ -954,12 +965,13 @@ module KlaviyoAPI
954
965
  query_params[:'fields[flow]'] = @api_client.build_collection_param(opts[:'fields_flow'], :csv) if !opts[:'fields_flow'].nil?
955
966
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
956
967
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
968
+ query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
957
969
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
958
970
 
959
971
  # header parameters
960
972
  header_params = opts[:header_params] || {}
961
973
  # klaviyo api revision
962
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
974
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
963
975
  # HTTP header 'Accept' (if needed)
964
976
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
965
977
 
@@ -1030,7 +1042,7 @@ module KlaviyoAPI
1030
1042
  # header parameters
1031
1043
  header_params = opts[:header_params] || {}
1032
1044
  # klaviyo api revision
1033
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1045
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1034
1046
  # HTTP header 'Accept' (if needed)
1035
1047
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1036
1048
  # HTTP header 'Content-Type'