klaviyo-api-sdk 1.0.0 → 1.1.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 (529) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +335 -119
  4. data/docs/AudiencesSubObject.md +20 -0
  5. data/docs/CampaignCloneQuery.md +18 -0
  6. data/docs/CampaignCloneQueryAsSubResource.md +20 -0
  7. data/docs/CampaignCloneQueryAsSubResourceAttributes.md +20 -0
  8. data/docs/CampaignCreateQuery.md +18 -0
  9. data/docs/CampaignCreateQueryAsSubResource.md +20 -0
  10. data/docs/CampaignCreateQueryAsSubResourceAttributes.md +28 -0
  11. data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
  12. data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +20 -0
  13. data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +20 -0
  14. data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
  15. data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +22 -0
  16. data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +20 -0
  17. data/docs/CampaignPartialUpdateQuery.md +18 -0
  18. data/docs/CampaignPartialUpdateQueryAsSubResource.md +22 -0
  19. data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +26 -0
  20. data/docs/CampaignSendJobCreateQuery.md +18 -0
  21. data/docs/CampaignSendJobCreateQueryAsSubResource.md +20 -0
  22. data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +18 -0
  23. data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
  24. data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +22 -0
  25. data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +18 -0
  26. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +2 -2
  27. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +1 -1
  28. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +1 -1
  29. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +4 -4
  30. data/docs/CatalogItemDeleteQueryAsSubResource.md +1 -1
  31. data/docs/CatalogItemUpdateQueryAsSubResource.md +1 -1
  32. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +4 -4
  33. data/docs/CatalogVariantDeleteQueryAsSubResource.md +1 -1
  34. data/docs/CatalogVariantUpdateQueryAsSubResource.md +1 -1
  35. data/docs/CatalogsApi.md +202 -202
  36. data/docs/ClientApi.md +11 -11
  37. data/docs/ContentSubObject.md +28 -0
  38. data/docs/DataPrivacyApi.md +78 -0
  39. data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
  40. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +20 -0
  41. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +22 -0
  42. data/docs/ErrorSource.md +2 -2
  43. data/docs/EventCreateQueryAsSubResourceAttributes.md +8 -8
  44. data/docs/EventsApi.md +36 -36
  45. data/docs/FlowsApi.md +139 -69
  46. data/docs/IncludedCategories.md +1 -1
  47. data/docs/IncludedMetrics.md +1 -1
  48. data/docs/IncludedMetricsAttributes.md +4 -4
  49. data/docs/ListsApi.md +101 -25
  50. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +15 -15
  51. data/docs/MetricAggregateRowDTO.md +2 -2
  52. data/docs/MetricCreateQuery.md +3 -3
  53. data/docs/MetricsApi.md +14 -14
  54. data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +10 -10
  55. data/docs/ProfilesApi.md +31 -31
  56. data/docs/SegmentsApi.md +102 -23
  57. data/docs/SendOptionsSubObject.md +20 -0
  58. data/docs/SendStrategySubObject.md +22 -0
  59. data/docs/SendTimeSubObject.md +20 -0
  60. data/docs/StaticScheduleOptions.md +22 -0
  61. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
  62. data/docs/Suppression.md +1 -1
  63. data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  64. data/docs/TagCreateQuery.md +18 -0
  65. data/docs/TagCreateQueryAsSubResource.md +20 -0
  66. data/docs/TagCreateQueryAsSubResourceAttributes.md +20 -0
  67. data/docs/TagGroupCreateQuery.md +18 -0
  68. data/docs/TagGroupCreateQueryAsSubResource.md +20 -0
  69. data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +20 -0
  70. data/docs/TagGroupUpdateQuery.md +18 -0
  71. data/docs/TagGroupUpdateQueryAsSubResource.md +22 -0
  72. data/docs/{V2TemplateRenderQueryAsSubResourceAttributes.md → TagGroupUpdateQueryAsSubResourceAttributes.md} +4 -4
  73. data/docs/TagSegmentOp.md +18 -0
  74. data/docs/{ListDeleteQueryAsSubResource.md → TagSegmentOpDataInner.md} +2 -2
  75. data/docs/TagUpdateQuery.md +18 -0
  76. data/docs/TagUpdateQueryAsSubResource.md +22 -0
  77. data/docs/TagUpdateQueryAsSubResourceAttributes.md +18 -0
  78. data/docs/TagsApi.md +1205 -0
  79. data/docs/TemplateCloneQueryAsSubResource.md +2 -0
  80. data/docs/TemplateCloneQueryAsSubResourceAttributes.md +5 -3
  81. data/docs/TemplateCreateQueryAsSubResourceAttributes.md +14 -8
  82. data/docs/TemplateRenderQuery.md +18 -0
  83. data/docs/TemplateRenderQueryAsSubResource.md +20 -0
  84. data/docs/TemplateRenderQueryAsSubResourceAttributes.md +22 -0
  85. data/docs/TemplateUpdateQueryAsSubResource.md +1 -1
  86. data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +13 -7
  87. data/docs/TemplatesApi.md +40 -44
  88. data/docs/ThrottledScheduleOptions.md +20 -0
  89. data/docs/TrackingOptionsSubObject.md +24 -0
  90. data/docs/UTMParamsSubObject.md +20 -0
  91. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
  92. data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +1 -1
  93. data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +18 -0
  94. data/docs/V2TemplateRenderQueryAsSubResource.md +2 -4
  95. data/klaviyo-api-sdk.gemspec +3 -3
  96. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +277 -277
  97. data/lib/klaviyo-api-sdk/api/client_api.rb +12 -12
  98. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +92 -0
  99. data/lib/klaviyo-api-sdk/api/events_api.rb +46 -46
  100. data/lib/klaviyo-api-sdk/api/flows_api.rb +155 -93
  101. data/lib/klaviyo-api-sdk/api/lists_api.rb +114 -42
  102. data/lib/klaviyo-api-sdk/api/metrics_api.rb +21 -21
  103. data/lib/klaviyo-api-sdk/api/profiles_api.rb +51 -51
  104. data/lib/klaviyo-api-sdk/api/segments_api.rb +112 -33
  105. data/lib/klaviyo-api-sdk/api/tags_api.rb +1216 -0
  106. data/lib/klaviyo-api-sdk/api/templates_api.rb +57 -69
  107. data/lib/klaviyo-api-sdk/api_client.rb +24 -3
  108. data/lib/klaviyo-api-sdk/api_error.rb +2 -2
  109. data/lib/klaviyo-api-sdk/configuration.rb +2 -2
  110. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +234 -0
  111. data/lib/klaviyo-api-sdk/models/{v2_template_render_query.rb → campaign_clone_query.rb} +6 -6
  112. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +272 -0
  113. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +235 -0
  114. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +224 -0
  115. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +272 -0
  116. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +291 -0
  117. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +224 -0
  118. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +272 -0
  119. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +240 -0
  120. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +224 -0
  121. data/lib/klaviyo-api-sdk/models/{included_profile.rb → campaign_message_partial_update_query_as_sub_resource.rb} +12 -25
  122. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +229 -0
  123. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +224 -0
  124. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +287 -0
  125. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +256 -0
  126. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +224 -0
  127. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +272 -0
  128. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +225 -0
  129. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +224 -0
  130. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +287 -0
  131. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +225 -0
  132. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
  133. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +2 -2
  134. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -2
  135. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
  136. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +2 -2
  137. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +4 -2
  138. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
  139. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +2 -2
  140. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
  141. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +3 -2
  142. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  143. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
  144. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +2 -2
  145. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -2
  146. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
  147. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +3 -2
  148. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -2
  149. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  150. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
  151. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +2 -2
  152. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -2
  153. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
  154. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +2 -2
  155. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +6 -2
  156. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +2 -2
  157. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +2 -2
  158. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +2 -2
  159. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
  160. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +2 -2
  161. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
  162. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +3 -2
  163. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
  164. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +2 -2
  165. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -2
  166. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
  167. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +3 -2
  168. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +2 -2
  169. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +2 -2
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +2 -2
  172. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -2
  173. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +2 -2
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +6 -2
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +2 -2
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +2 -2
  178. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +2 -2
  179. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
  180. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +2 -2
  181. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -2
  182. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +3 -2
  183. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
  184. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +2 -2
  185. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -2
  186. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
  187. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +3 -2
  188. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +2 -2
  189. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +270 -0
  190. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +224 -0
  191. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +272 -0
  192. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +240 -0
  193. data/lib/klaviyo-api-sdk/models/email_message_content.rb +2 -2
  194. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +2 -2
  195. data/lib/klaviyo-api-sdk/models/error_source.rb +4 -2
  196. data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
  197. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +2 -2
  198. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +7 -2
  199. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
  200. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +2 -2
  201. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +2 -2
  202. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +2 -2
  203. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +2 -2
  204. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +2 -2
  205. data/lib/klaviyo-api-sdk/models/included_categories.rb +3 -2
  206. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +2 -2
  207. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +2 -2
  208. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +2 -2
  209. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +2 -2
  210. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +2 -2
  211. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +2 -2
  212. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +2 -2
  213. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +2 -2
  214. data/lib/klaviyo-api-sdk/models/included_flows.rb +2 -2
  215. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +2 -2
  216. data/lib/klaviyo-api-sdk/models/included_items.rb +2 -2
  217. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +2 -2
  218. data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -2
  219. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +2 -2
  220. data/lib/klaviyo-api-sdk/models/included_metrics.rb +3 -2
  221. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +6 -2
  222. data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -2
  223. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +2 -2
  224. data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
  225. data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -2
  226. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +2 -2
  227. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +2 -2
  228. data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
  229. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +2 -2
  230. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -2
  231. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +2 -2
  232. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -2
  233. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +2 -2
  234. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
  235. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -2
  236. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
  237. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +2 -2
  238. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +14 -8
  239. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +4 -2
  240. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +4 -2
  241. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
  242. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +2 -2
  243. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +2 -2
  244. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +2 -2
  245. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
  246. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +2 -2
  247. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +7 -2
  248. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
  249. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +2 -2
  250. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +2 -2
  251. data/lib/klaviyo-api-sdk/models/profile_location.rb +2 -2
  252. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -2
  253. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
  254. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -2
  255. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
  256. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
  257. data/lib/klaviyo-api-sdk/models/send_options.rb +2 -2
  258. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +230 -0
  259. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +243 -0
  260. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +240 -0
  261. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +2 -2
  262. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +2 -2
  263. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +2 -2
  264. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +245 -0
  265. data/lib/klaviyo-api-sdk/models/subscription.rb +2 -2
  266. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
  267. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +2 -2
  268. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +5 -2
  269. data/lib/klaviyo-api-sdk/models/suppression.rb +3 -2
  270. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
  271. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +2 -2
  272. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +3 -2
  273. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +224 -0
  274. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +272 -0
  275. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +235 -0
  276. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +224 -0
  277. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +272 -0
  278. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +234 -0
  279. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +224 -0
  280. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +287 -0
  281. data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource_attributes.rb → tag_group_update_query_as_sub_resource_attributes.rb} +16 -15
  282. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +226 -0
  283. data/lib/klaviyo-api-sdk/models/{list_delete_query_as_sub_resource.rb → tag_segment_op_data_inner.rb} +7 -7
  284. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +224 -0
  285. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +287 -0
  286. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +225 -0
  287. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
  288. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +14 -3
  289. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +20 -3
  290. data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
  291. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +2 -2
  292. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +7 -2
  293. data/lib/klaviyo-api-sdk/models/template_render_query.rb +224 -0
  294. data/lib/klaviyo-api-sdk/models/{template_delete_query_as_sub_resource.rb → template_render_query_as_sub_resource.rb} +15 -15
  295. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +252 -0
  296. data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
  297. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +3 -2
  298. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +6 -2
  299. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +240 -0
  300. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +252 -0
  301. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
  302. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +2 -2
  303. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +5 -7
  304. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
  305. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +3 -3
  306. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +227 -0
  307. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +2 -2
  308. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +240 -0
  309. data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +11 -62
  310. data/lib/klaviyo-api-sdk/version.rb +2 -2
  311. data/lib/klaviyo-api-sdk.rb +55 -7
  312. data/spec/api/catalogs_api_spec.rb +94 -94
  313. data/spec/api/client_api_spec.rb +5 -5
  314. data/spec/api/data_privacy_api_spec.rb +47 -0
  315. data/spec/api/events_api_spec.rb +19 -19
  316. data/spec/api/flows_api_spec.rb +44 -33
  317. data/spec/api/lists_api_spec.rb +28 -15
  318. data/spec/api/metrics_api_spec.rb +8 -8
  319. data/spec/api/profiles_api_spec.rb +21 -21
  320. data/spec/api/segments_api_spec.rb +24 -10
  321. data/spec/api/tags_api_spec.rb +245 -0
  322. data/spec/api/templates_api_spec.rb +18 -18
  323. data/spec/api_client_spec.rb +2 -2
  324. data/spec/configuration_spec.rb +2 -2
  325. data/spec/models/audiences_sub_object_spec.rb +40 -0
  326. data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +40 -0
  327. data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +44 -0
  328. data/spec/models/{v2_template_render_query_spec.rb → campaign_clone_query_spec.rb} +8 -8
  329. data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +64 -0
  330. data/spec/models/campaign_create_query_as_sub_resource_spec.rb +44 -0
  331. data/spec/models/campaign_create_query_spec.rb +34 -0
  332. data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +40 -0
  333. data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +44 -0
  334. data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
  335. data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +40 -0
  336. data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +50 -0
  337. data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
  338. data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +58 -0
  339. data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +50 -0
  340. data/spec/models/campaign_partial_update_query_spec.rb +34 -0
  341. data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  342. data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +44 -0
  343. data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
  344. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
  345. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +50 -0
  346. data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
  347. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  348. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +2 -2
  349. data/spec/models/catalog_category_create_job_create_query_spec.rb +2 -2
  350. data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +2 -2
  351. data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +2 -2
  352. data/spec/models/catalog_category_create_query_spec.rb +2 -2
  353. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  354. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  355. data/spec/models/catalog_category_delete_job_create_query_spec.rb +2 -2
  356. data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +2 -2
  357. data/spec/models/catalog_category_item_op_spec.rb +2 -2
  358. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  359. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +2 -2
  360. data/spec/models/catalog_category_update_job_create_query_spec.rb +2 -2
  361. data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +2 -2
  362. data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +2 -2
  363. data/spec/models/catalog_category_update_query_spec.rb +2 -2
  364. data/spec/models/catalog_item_category_op_spec.rb +2 -2
  365. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  366. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +2 -2
  367. data/spec/models/catalog_item_create_job_create_query_spec.rb +2 -2
  368. data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +2 -2
  369. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +2 -2
  370. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +2 -2
  371. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +2 -2
  372. data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +2 -2
  373. data/spec/models/catalog_item_create_query_spec.rb +2 -2
  374. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  375. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  376. data/spec/models/catalog_item_delete_job_create_query_spec.rb +2 -2
  377. data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +2 -2
  378. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  379. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +2 -2
  380. data/spec/models/catalog_item_update_job_create_query_spec.rb +2 -2
  381. data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +2 -2
  382. data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +2 -2
  383. data/spec/models/catalog_item_update_query_spec.rb +2 -2
  384. data/spec/models/catalog_job_error_payload_spec.rb +2 -2
  385. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  386. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +2 -2
  387. data/spec/models/catalog_variant_create_job_create_query_spec.rb +2 -2
  388. data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +2 -2
  389. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +2 -2
  390. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +2 -2
  391. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +2 -2
  392. data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +2 -2
  393. data/spec/models/catalog_variant_create_query_spec.rb +2 -2
  394. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  395. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +2 -2
  396. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +2 -2
  397. data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +2 -2
  398. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  399. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +2 -2
  400. data/spec/models/catalog_variant_update_job_create_query_spec.rb +2 -2
  401. data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +2 -2
  402. data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +2 -2
  403. data/spec/models/catalog_variant_update_query_spec.rb +2 -2
  404. data/spec/models/content_sub_object_spec.rb +64 -0
  405. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +46 -0
  406. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +44 -0
  407. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
  408. data/spec/models/email_message_content_spec.rb +2 -2
  409. data/spec/models/email_tracking_options_spec.rb +2 -2
  410. data/spec/models/error_source_spec.rb +2 -2
  411. data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +2 -2
  412. data/spec/models/event_create_query_as_sub_resource_spec.rb +2 -2
  413. data/spec/models/event_create_query_spec.rb +2 -2
  414. data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +2 -2
  415. data/spec/models/flow_update_query_as_sub_resource_spec.rb +2 -2
  416. data/spec/models/flow_update_query_spec.rb +2 -2
  417. data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +2 -2
  418. data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +2 -2
  419. data/spec/models/get_catalog_items4_xx_response_spec.rb +2 -2
  420. data/spec/models/included_categories_attributes_spec.rb +2 -2
  421. data/spec/models/included_categories_spec.rb +2 -2
  422. data/spec/models/included_flow_action_spec.rb +2 -2
  423. data/spec/models/included_flow_actions_attributes_spec.rb +2 -2
  424. data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +2 -2
  425. data/spec/models/included_flow_actions_spec.rb +2 -2
  426. data/spec/models/included_flow_messages_attributes_content_spec.rb +2 -2
  427. data/spec/models/included_flow_messages_attributes_spec.rb +2 -2
  428. data/spec/models/included_flow_messages_spec.rb +2 -2
  429. data/spec/models/included_flows_attributes_spec.rb +2 -2
  430. data/spec/models/included_flows_spec.rb +2 -2
  431. data/spec/models/included_items_attributes_spec.rb +2 -2
  432. data/spec/models/included_items_spec.rb +2 -2
  433. data/spec/models/included_lists_attributes_spec.rb +2 -2
  434. data/spec/models/included_lists_spec.rb +2 -2
  435. data/spec/models/included_metrics_attributes_spec.rb +2 -2
  436. data/spec/models/included_metrics_spec.rb +2 -2
  437. data/spec/models/included_profiles_attributes_spec.rb +2 -2
  438. data/spec/models/included_profiles_spec.rb +2 -2
  439. data/spec/models/included_segments_spec.rb +2 -2
  440. data/spec/models/included_variants_attributes_spec.rb +2 -2
  441. data/spec/models/included_variants_links_spec.rb +2 -2
  442. data/spec/models/included_variants_spec.rb +2 -2
  443. data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +2 -2
  444. data/spec/models/list_create_query_as_sub_resource_spec.rb +2 -2
  445. data/spec/models/list_create_query_spec.rb +2 -2
  446. data/spec/models/list_members_add_query_data_inner_spec.rb +2 -2
  447. data/spec/models/list_members_add_query_spec.rb +2 -2
  448. data/spec/models/list_members_delete_query_spec.rb +2 -2
  449. data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +2 -2
  450. data/spec/models/list_partial_update_query_spec.rb +2 -2
  451. data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +2 -2
  452. data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +2 -2
  453. data/spec/models/metric_aggregate_query_spec.rb +2 -2
  454. data/spec/models/metric_aggregate_row_dto_spec.rb +2 -2
  455. data/spec/models/metric_create_query_spec.rb +2 -2
  456. data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +2 -2
  457. data/spec/models/onsite_profile_create_query_spec.rb +2 -2
  458. data/spec/models/onsite_profile_meta_identifiers_spec.rb +2 -2
  459. data/spec/models/onsite_profile_meta_spec.rb +2 -2
  460. data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +2 -2
  461. data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +2 -2
  462. data/spec/models/onsite_subscription_create_query_spec.rb +2 -2
  463. data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +2 -2
  464. data/spec/models/profile_create_query_as_sub_resource_spec.rb +2 -2
  465. data/spec/models/profile_create_query_spec.rb +2 -2
  466. data/spec/models/profile_location_latitude_spec.rb +2 -2
  467. data/spec/models/profile_location_spec.rb +2 -2
  468. data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +2 -2
  469. data/spec/models/profile_partial_update_query_spec.rb +2 -2
  470. data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +2 -2
  471. data/spec/models/segment_partial_update_query_spec.rb +2 -2
  472. data/spec/models/send_options_spec.rb +2 -2
  473. data/spec/models/send_options_sub_object_spec.rb +40 -0
  474. data/spec/models/send_strategy_sub_object_spec.rb +46 -0
  475. data/spec/models/send_time_sub_object_spec.rb +40 -0
  476. data/spec/models/sms_message_content_spec.rb +2 -2
  477. data/spec/models/sms_render_options_spec.rb +2 -2
  478. data/spec/models/sms_tracking_options_spec.rb +2 -2
  479. data/spec/models/static_schedule_options_spec.rb +46 -0
  480. data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  481. data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
  482. data/spec/models/subscription_create_job_create_query_spec.rb +2 -2
  483. data/spec/models/subscription_spec.rb +2 -2
  484. data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  485. data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
  486. data/spec/models/suppression_create_job_create_query_spec.rb +2 -2
  487. data/spec/models/suppression_spec.rb +2 -2
  488. data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +40 -0
  489. data/spec/models/tag_create_query_as_sub_resource_spec.rb +44 -0
  490. data/spec/models/tag_create_query_spec.rb +34 -0
  491. data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +40 -0
  492. data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +44 -0
  493. data/spec/models/tag_group_create_query_spec.rb +34 -0
  494. data/spec/models/{v2_template_render_query_as_sub_resource_attributes_spec.rb → tag_group_update_query_as_sub_resource_attributes_spec.rb} +9 -9
  495. data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +50 -0
  496. data/spec/models/tag_group_update_query_spec.rb +34 -0
  497. data/spec/models/{list_delete_query_as_sub_resource_spec.rb → tag_segment_op_data_inner_spec.rb} +9 -9
  498. data/spec/models/tag_segment_op_spec.rb +34 -0
  499. data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +34 -0
  500. data/spec/models/{included_profile_spec.rb → tag_update_query_as_sub_resource_spec.rb} +9 -15
  501. data/spec/models/tag_update_query_spec.rb +34 -0
  502. data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +8 -2
  503. data/spec/models/template_clone_query_as_sub_resource_spec.rb +8 -2
  504. data/spec/models/template_clone_query_spec.rb +2 -2
  505. data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +2 -2
  506. data/spec/models/template_create_query_as_sub_resource_spec.rb +2 -2
  507. data/spec/models/template_create_query_spec.rb +2 -2
  508. data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +46 -0
  509. data/spec/models/{template_delete_query_as_sub_resource_spec.rb → template_render_query_as_sub_resource_spec.rb} +9 -9
  510. data/spec/models/template_render_query_spec.rb +34 -0
  511. data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +2 -2
  512. data/spec/models/template_update_query_as_sub_resource_spec.rb +2 -2
  513. data/spec/models/template_update_query_spec.rb +2 -2
  514. data/spec/models/throttled_schedule_options_spec.rb +40 -0
  515. data/spec/models/tracking_options_sub_object_spec.rb +52 -0
  516. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +2 -2
  517. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +2 -2
  518. data/spec/models/unsubscription_create_job_create_query_spec.rb +2 -2
  519. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  520. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +2 -2
  521. data/spec/models/unsuppression_create_job_create_query_spec.rb +2 -2
  522. data/spec/models/utm_param_info_spec.rb +2 -2
  523. data/spec/models/utm_params_sub_object_spec.rb +40 -0
  524. data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +3 -13
  525. data/spec/spec_helper.rb +2 -2
  526. metadata +165 -21
  527. data/docs/IncludedProfile.md +0 -24
  528. data/docs/TemplateDeleteQueryAsSubResource.md +0 -20
  529. data/docs/V2TemplateRenderQuery.md +0 -18
@@ -3,10 +3,10 @@
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: 2022-10-17
6
+ The version of the OpenAPI document: 2023-01-24
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.1
9
+ OpenAPI Generator version: 6.2.1
10
10
 
11
11
  =end
12
12
 
@@ -20,12 +20,12 @@ module KlaviyoAPI
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get Flow
23
- # Get a flow with the given flow ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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`
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/v2022-10-17/reference/api-overview#sparse-fieldsets
27
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
28
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
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
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)
@@ -33,12 +33,12 @@ module KlaviyoAPI
33
33
  end
34
34
 
35
35
  # Get Flow
36
- # Get a flow with the given flow ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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;
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/v2022-10-17/reference/api-overview#sparse-fieldsets
40
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
41
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
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
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'] || "2022-10-17"
75
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
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/v2022-10-17/reference/api-overview#sparse-fieldsets
113
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
114
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
115
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
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
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/v2022-10-17/reference/api-overview#sparse-fieldsets
127
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
128
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
129
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
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
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'] || "2022-10-17"
168
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
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/v2022-10-17/reference/api-overview#sparse-fieldsets
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
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/v2022-10-17/reference/api-overview#sparse-fieldsets
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
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'] || "2022-10-17"
240
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
241
241
  # HTTP header 'Accept' (if needed)
242
242
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
243
243
 
@@ -271,12 +271,12 @@ 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: `id`, `name`, `created`, `updated` Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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 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`
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/v2022-10-17/reference/api-overview#sparse-fieldsets
278
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#sorting
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
280
280
  # @return [Hash<String, Object>]
281
281
  def get_flow_action_messages(action_id, opts = {})
282
282
  data, _status_code, _headers = get_flow_action_messages_with_http_info(action_id, opts)
@@ -284,12 +284,12 @@ module KlaviyoAPI
284
284
  end
285
285
 
286
286
  # 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: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, &#x60;updated&#x60; Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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;
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
288
  # @param action_id [String]
289
289
  # @param [Hash] opts the optional parameters
290
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
291
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#sorting
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
293
293
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
294
294
  def get_flow_action_messages_with_http_info(action_id, opts = {})
295
295
  if @api_client.config.debugging
@@ -319,7 +319,7 @@ module KlaviyoAPI
319
319
  # header parameters
320
320
  header_params = opts[:header_params] || {}
321
321
  # klaviyo api revision
322
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
322
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
323
323
  # HTTP header 'Accept' (if needed)
324
324
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
325
325
 
@@ -353,12 +353,12 @@ module KlaviyoAPI
353
353
  end
354
354
 
355
355
  # Get Flow Action Relationships
356
- # Get all [relationships](https://developers.klaviyo.com/en/v2022-10-17/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` Use filters to narrow your results. Returns a maximum of 50 flow message relationships per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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`
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`
357
357
  # @param id [String]
358
358
  # @param related_resource [String]
359
359
  # @param [Hash] opts the optional parameters
360
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#sorting
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
362
362
  # @return [Hash<String, Object>]
363
363
  def get_flow_action_relationships(id, related_resource, opts = {})
364
364
  data, _status_code, _headers = get_flow_action_relationships_with_http_info(id, related_resource, opts)
@@ -366,12 +366,12 @@ module KlaviyoAPI
366
366
  end
367
367
 
368
368
  # Get Flow Action Relationships
369
- # Get all [relationships](https://developers.klaviyo.com/en/v2022-10-17/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; Use filters to narrow your results. Returns a maximum of 50 flow message relationships per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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;
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;
370
370
  # @param id [String]
371
371
  # @param related_resource [String]
372
372
  # @param [Hash] opts the optional parameters
373
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#sorting
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
375
375
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
376
376
  def get_flow_action_relationships_with_http_info(id, related_resource, opts = {})
377
377
  if @api_client.config.debugging
@@ -405,7 +405,7 @@ module KlaviyoAPI
405
405
  # header parameters
406
406
  header_params = opts[:header_params] || {}
407
407
  # klaviyo api revision
408
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
408
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
409
409
  # HTTP header 'Accept' (if needed)
410
410
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
411
411
 
@@ -439,12 +439,12 @@ module KlaviyoAPI
439
439
  end
440
440
 
441
441
  # 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` Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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`
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`
443
443
  # @param flow_id [String]
444
444
  # @param [Hash] opts the optional parameters
445
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
446
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#sorting
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
448
448
  # @return [Hash<String, Object>]
449
449
  def get_flow_flow_actions(flow_id, opts = {})
450
450
  data, _status_code, _headers = get_flow_flow_actions_with_http_info(flow_id, opts)
@@ -452,12 +452,12 @@ module KlaviyoAPI
452
452
  end
453
453
 
454
454
  # 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; Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 50 flows per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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;
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;
456
456
  # @param flow_id [String]
457
457
  # @param [Hash] opts the optional parameters
458
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
459
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#sorting
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
461
461
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
462
462
  def get_flow_flow_actions_with_http_info(flow_id, opts = {})
463
463
  if @api_client.config.debugging
@@ -487,7 +487,7 @@ module KlaviyoAPI
487
487
  # header parameters
488
488
  header_params = opts[:header_params] || {}
489
489
  # klaviyo api revision
490
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
490
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
491
491
  # HTTP header 'Accept' (if needed)
492
492
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
493
493
 
@@ -521,12 +521,12 @@ module KlaviyoAPI
521
521
  end
522
522
 
523
523
  # Get Flow Message
524
- # Get the flow message of a flow with the given message ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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`
524
+ # 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
525
  # @param id [String]
526
526
  # @param [Hash] opts the optional parameters
527
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
528
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
529
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
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
530
530
  # @return [Hash<String, Object>]
531
531
  def get_flow_message(id, opts = {})
532
532
  data, _status_code, _headers = get_flow_message_with_http_info(id, opts)
@@ -534,12 +534,12 @@ module KlaviyoAPI
534
534
  end
535
535
 
536
536
  # Get Flow Message
537
- # Get the flow message of a flow with the given message ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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;
537
+ # 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
538
  # @param id [String]
539
539
  # @param [Hash] opts the optional parameters
540
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
541
- # @option opts [Array<String>] :fields_flow_message For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
542
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
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
543
543
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
544
544
  def get_flow_message_with_http_info(id, opts = {})
545
545
  if @api_client.config.debugging
@@ -573,7 +573,7 @@ module KlaviyoAPI
573
573
  # header parameters
574
574
  header_params = opts[:header_params] || {}
575
575
  # klaviyo api revision
576
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
576
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
577
577
  # HTTP header 'Accept' (if needed)
578
578
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
579
579
 
@@ -607,10 +607,10 @@ module KlaviyoAPI
607
607
  end
608
608
 
609
609
  # Get Flow Action For Message
610
- # Get the flow action for a flow message with the given message ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
610
+ # 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
611
  # @param message_id [String]
612
612
  # @param [Hash] opts the optional parameters
613
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
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
614
614
  # @return [Hash<String, Object>]
615
615
  def get_flow_message_action(message_id, opts = {})
616
616
  data, _status_code, _headers = get_flow_message_action_with_http_info(message_id, opts)
@@ -618,10 +618,10 @@ module KlaviyoAPI
618
618
  end
619
619
 
620
620
  # Get Flow Action For Message
621
- # Get the flow action for a flow message with the given message ID. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets).&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;
621
+ # 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
622
  # @param message_id [String]
623
623
  # @param [Hash] opts the optional parameters
624
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
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
625
625
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
626
626
  def get_flow_message_action_with_http_info(message_id, opts = {})
627
627
  if @api_client.config.debugging
@@ -645,7 +645,7 @@ module KlaviyoAPI
645
645
  # header parameters
646
646
  header_params = opts[:header_params] || {}
647
647
  # klaviyo api revision
648
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
648
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
649
649
  # HTTP header 'Accept' (if needed)
650
650
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
651
651
 
@@ -679,7 +679,7 @@ module KlaviyoAPI
679
679
  end
680
680
 
681
681
  # Get Flow Message Relationships
682
- # Get the [relationship](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
682
+ # Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
683
683
  # @param id [String]
684
684
  # @param related_resource [String]
685
685
  # @param [Hash] opts the optional parameters
@@ -690,7 +690,7 @@ module KlaviyoAPI
690
690
  end
691
691
 
692
692
  # Get Flow Message Relationships
693
- # Get the [relationship](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for a flow message&#39;s flow action, given the 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;
693
+ # Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message&#39;s flow action, given the 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;
694
694
  # @param id [String]
695
695
  # @param related_resource [String]
696
696
  # @param [Hash] opts the optional parameters
@@ -721,7 +721,7 @@ module KlaviyoAPI
721
721
  # header parameters
722
722
  header_params = opts[:header_params] || {}
723
723
  # klaviyo api revision
724
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
724
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
725
725
  # HTTP header 'Accept' (if needed)
726
726
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
727
727
 
@@ -755,12 +755,10 @@ module KlaviyoAPI
755
755
  end
756
756
 
757
757
  # Get Flow Relationships
758
- # Get all [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination)<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
758
+ # If the `related_resource` is `tags`, returns the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read` `Tags Read`
759
759
  # @param id [String]
760
760
  # @param related_resource [String]
761
761
  # @param [Hash] opts the optional parameters
762
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;action_type&#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;
763
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
764
762
  # @return [Hash<String, Object>]
765
763
  def get_flow_relationships(id, related_resource, opts = {})
766
764
  data, _status_code, _headers = get_flow_relationships_with_http_info(id, related_resource, opts)
@@ -768,12 +766,10 @@ module KlaviyoAPI
768
766
  end
769
767
 
770
768
  # Get Flow Relationships
771
- # Get all [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: &#x60;id&#x60;, &#x60;status&#x60;, &#x60;created&#x60;, &#x60;updated&#x60; Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with [offset pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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;
769
+ # If the &#x60;related_resource&#x60; is &#x60;tags&#x60;, returns the tag IDs of all tags associated with the given flow.&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;
772
770
  # @param id [String]
773
771
  # @param related_resource [String]
774
772
  # @param [Hash] opts the optional parameters
775
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;action_type&#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;
776
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
777
773
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
778
774
  def get_flow_relationships_with_http_info(id, related_resource, opts = {})
779
775
  if @api_client.config.debugging
@@ -788,26 +784,20 @@ module KlaviyoAPI
788
784
  fail ArgumentError, "Missing the required parameter 'related_resource' when calling FlowsApi.get_flow_relationships"
789
785
  end
790
786
  # verify enum value
791
- allowable_values = ["flow-actions"]
787
+ allowable_values = ["flow-actions", "tags"]
792
788
  if @api_client.config.client_side_validation && !allowable_values.include?(related_resource)
793
789
  fail ArgumentError, "invalid value for \"related_resource\", must be one of #{allowable_values}"
794
790
  end
795
- allowable_values = ["created", "-created", "id", "-id", "status", "-status", "updated", "-updated"]
796
- if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
797
- fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
798
- end
799
791
  # resource path
800
792
  local_var_path = '/api/flows/{id}/relationships/{related_resource}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'related_resource' + '}', CGI.escape(related_resource.to_s))
801
793
 
802
794
  # query parameters
803
795
  query_params = opts[:query_params] || {}
804
- query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
805
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
806
796
 
807
797
  # header parameters
808
798
  header_params = opts[:header_params] || {}
809
799
  # klaviyo api revision
810
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
800
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
811
801
  # HTTP header 'Accept' (if needed)
812
802
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
813
803
 
@@ -840,14 +830,86 @@ module KlaviyoAPI
840
830
  return data, status_code, headers
841
831
  end
842
832
 
833
+ # Get Flow Tags
834
+ # 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
+ # @param flow_id [String]
836
+ # @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
838
+ # @return [Hash<String, Object>]
839
+ def get_flow_tags(flow_id, opts = {})
840
+ data, _status_code, _headers = get_flow_tags_with_http_info(flow_id, opts)
841
+ data
842
+ end
843
+
844
+ # Get Flow Tags
845
+ # 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
+ # @param flow_id [String]
847
+ # @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
849
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
850
+ def get_flow_tags_with_http_info(flow_id, opts = {})
851
+ if @api_client.config.debugging
852
+ @api_client.config.logger.debug 'Calling API: FlowsApi.get_flow_tags ...'
853
+ end
854
+ # verify the required parameter 'flow_id' is set
855
+ if @api_client.config.client_side_validation && flow_id.nil?
856
+ fail ArgumentError, "Missing the required parameter 'flow_id' when calling FlowsApi.get_flow_tags"
857
+ end
858
+ allowable_values = ["name"]
859
+ if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) }
860
+ fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}"
861
+ end
862
+ # resource path
863
+ local_var_path = '/api/flows/{flow_id}/tags/'.sub('{' + 'flow_id' + '}', CGI.escape(flow_id.to_s))
864
+
865
+ # query parameters
866
+ query_params = opts[:query_params] || {}
867
+ query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].nil?
868
+
869
+ # header parameters
870
+ header_params = opts[:header_params] || {}
871
+ # klaviyo api revision
872
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
873
+ # HTTP header 'Accept' (if needed)
874
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
875
+
876
+ # form parameters
877
+ form_params = opts[:form_params] || {}
878
+
879
+ # http body (model)
880
+ post_body = opts[:debug_body]
881
+
882
+ # return_type
883
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
884
+
885
+ # auth_names
886
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
887
+
888
+ new_options = opts.merge(
889
+ :operation => :"FlowsApi.get_flow_tags",
890
+ :header_params => header_params,
891
+ :query_params => query_params,
892
+ :form_params => form_params,
893
+ :body => post_body,
894
+ :auth_names => auth_names,
895
+ :return_type => return_type
896
+ )
897
+
898
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
899
+ if @api_client.config.debugging
900
+ @api_client.config.logger.debug "API called: FlowsApi#get_flow_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
901
+ end
902
+ return data, status_code, headers
903
+ end
904
+
843
905
  # Get Flows
844
- # 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` Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination)<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Flows Read`
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`
845
907
  # @param [Hash] opts the optional parameters
846
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
847
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
848
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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;
849
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
850
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
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
851
913
  # @return [Hash<String, Object>]
852
914
  def get_flows(opts = {})
853
915
  data, _status_code, _headers = get_flows_with_http_info(opts)
@@ -855,13 +917,13 @@ module KlaviyoAPI
855
917
  end
856
918
 
857
919
  # Get Flows
858
- # 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; Use filters to narrow your results. Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). 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](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#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;
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;
859
921
  # @param [Hash] opts the optional parameters
860
- # @option opts [Array<String>] :fields_flow_action For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
861
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
862
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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;
863
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
864
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
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
865
927
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
866
928
  def get_flows_with_http_info(opts = {})
867
929
  if @api_client.config.debugging
@@ -897,7 +959,7 @@ module KlaviyoAPI
897
959
  # header parameters
898
960
  header_params = opts[:header_params] || {}
899
961
  # klaviyo api revision
900
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
962
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
901
963
  # HTTP header 'Accept' (if needed)
902
964
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
903
965
 
@@ -968,7 +1030,7 @@ module KlaviyoAPI
968
1030
  # header parameters
969
1031
  header_params = opts[:header_params] || {}
970
1032
  # klaviyo api revision
971
- header_params['revision'] = ENV['API_REVISION'] || "2022-10-17"
1033
+ header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
972
1034
  # HTTP header 'Accept' (if needed)
973
1035
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
974
1036
  # HTTP header 'Content-Type'