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
 
@@ -47,12 +47,12 @@ describe 'EventsApi' do
47
47
  # unit tests for get_event
48
48
  # Get Event
49
49
  # Get an event with the given event 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: `metrics`, `profiles`<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Events Read`
50
- # @param id
50
+ # @param id ID of the event
51
51
  # @param [Hash] opts the optional parameters
52
- # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
53
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
54
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
55
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
52
+ # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
53
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
54
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
55
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
56
56
  # @return [Hash<String, Object>]
57
57
  describe 'get_event test' do
58
58
  it 'should work' do
@@ -63,9 +63,9 @@ describe 'EventsApi' do
63
63
  # unit tests for get_event_metrics
64
64
  # Get Event Metrics
65
65
  # Get the metric for an event with the given event ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Events Read&#x60; &#x60;Metrics Read&#x60;
66
- # @param id
66
+ # @param id ID of the event
67
67
  # @param [Hash] opts the optional parameters
68
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
68
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
69
69
  # @return [Hash<String, Object>]
70
70
  describe 'get_event_metrics test' do
71
71
  it 'should work' do
@@ -76,9 +76,9 @@ describe 'EventsApi' do
76
76
  # unit tests for get_event_profiles
77
77
  # Get Event Profiles
78
78
  # Get the profile associated with an event with the given event ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Events Read&#x60; &#x60;Profiles Read&#x60;
79
- # @param id
79
+ # @param id ID of the event
80
80
  # @param [Hash] opts the optional parameters
81
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
81
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
82
82
  # @return [Hash<String, Object>]
83
83
  describe 'get_event_profiles test' do
84
84
  it 'should work' do
@@ -88,7 +88,7 @@ describe 'EventsApi' do
88
88
 
89
89
  # unit tests for get_event_relationships
90
90
  # Get Event Relationships
91
- # Get metrics or profile [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for an event with the given event ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Events Read&#x60; &#x60;Profiles Read&#x60;
91
+ # Get metrics or profile [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for an event with the given event ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Events Read&#x60; &#x60;Metrics Read&#x60; &#x60;Profiles Read&#x60;
92
92
  # @param id
93
93
  # @param related_resource
94
94
  # @param [Hash] opts the optional parameters
@@ -103,13 +103,13 @@ describe 'EventsApi' do
103
103
  # Get Events
104
104
  # Get all events in an account Requests can be sorted by the following fields: &#x60;datetime&#x60;, &#x60;timestamp&#x60; Use filters to narrow your results to specific metrics. 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;metrics&#x60;, &#x60;profiles&#x60; Returns a maximum of 200 events per page, which can be paginated with [cursor-based 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;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;Events Read&#x60;
105
105
  # @param [Hash] opts the optional parameters
106
- # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
107
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
108
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
109
- # @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;metric_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;datetime&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
110
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
111
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
112
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
106
+ # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
107
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
108
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
109
+ # @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;metric_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;datetime&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
110
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
111
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
112
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
113
113
  # @return [Hash<String, Object>]
114
114
  describe 'get_events test' do
115
115
  it 'should work' do
@@ -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
 
@@ -37,9 +37,9 @@ describe 'FlowsApi' do
37
37
  # 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;
38
38
  # @param id
39
39
  # @param [Hash] opts the optional parameters
40
- # @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
41
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
42
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
40
+ # @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
41
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
42
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
43
43
  # @return [Hash<String, Object>]
44
44
  describe 'get_flow test' do
45
45
  it 'should work' do
@@ -49,13 +49,13 @@ describe 'FlowsApi' do
49
49
 
50
50
  # unit tests for get_flow_action
51
51
  # Get Flow Action
52
- # 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: &#39;flows&#39;, &#39;flow-messages&#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;
52
+ # 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;
53
53
  # @param id
54
54
  # @param [Hash] opts the optional parameters
55
- # @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
56
- # @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
57
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
58
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
55
+ # @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
56
+ # @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
57
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
58
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
59
59
  # @return [Hash<String, Object>]
60
60
  describe 'get_flow_action test' do
61
61
  it 'should work' do
@@ -68,7 +68,7 @@ describe 'FlowsApi' do
68
68
  # 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;
69
69
  # @param action_id
70
70
  # @param [Hash] opts the optional parameters
71
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
71
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
72
72
  # @return [Hash<String, Object>]
73
73
  describe 'get_flow_action_flow test' do
74
74
  it 'should work' do
@@ -78,12 +78,12 @@ describe 'FlowsApi' do
78
78
 
79
79
  # unit tests for get_flow_action_messages
80
80
  # Get Messages For Flow Action
81
- # Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: &#39;id&#39;, &#39;name&#39;, &#39;created&#39;, &#39;updated&#39; 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;
81
+ # 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; 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;
82
82
  # @param action_id
83
83
  # @param [Hash] opts the optional parameters
84
- # @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
85
- # @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;
86
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
84
+ # @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
85
+ # @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;
86
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
87
87
  # @return [Hash<String, Object>]
88
88
  describe 'get_flow_action_messages test' do
89
89
  it 'should work' do
@@ -93,12 +93,12 @@ describe 'FlowsApi' do
93
93
 
94
94
  # unit tests for get_flow_action_relationships
95
95
  # Get Flow Action Relationships
96
- # 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: &#39;id&#39;, &#39;name&#39;, &#39;created&#39;, &#39;updated&#39; 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;
96
+ # 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;
97
97
  # @param id
98
98
  # @param related_resource
99
99
  # @param [Hash] opts the optional parameters
100
- # @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;
101
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
100
+ # @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;
101
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
102
102
  # @return [Hash<String, Object>]
103
103
  describe 'get_flow_action_relationships test' do
104
104
  it 'should work' do
@@ -111,9 +111,9 @@ describe 'FlowsApi' do
111
111
  # 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;
112
112
  # @param flow_id
113
113
  # @param [Hash] opts the optional parameters
114
- # @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
115
- # @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;
116
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
114
+ # @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
115
+ # @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;
116
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
117
117
  # @return [Hash<String, Object>]
118
118
  describe 'get_flow_flow_actions test' do
119
119
  it 'should work' do
@@ -126,9 +126,9 @@ describe 'FlowsApi' do
126
126
  # 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;
127
127
  # @param id
128
128
  # @param [Hash] opts the optional parameters
129
- # @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
130
- # @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
131
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
129
+ # @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
130
+ # @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
131
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
132
132
  # @return [Hash<String, Object>]
133
133
  describe 'get_flow_message test' do
134
134
  it 'should work' do
@@ -141,7 +141,7 @@ describe 'FlowsApi' do
141
141
  # 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;
142
142
  # @param message_id
143
143
  # @param [Hash] opts the optional parameters
144
- # @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
144
+ # @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
145
145
  # @return [Hash<String, Object>]
146
146
  describe 'get_flow_message_action test' do
147
147
  it 'should work' do
@@ -164,12 +164,10 @@ describe 'FlowsApi' do
164
164
 
165
165
  # unit tests for get_flow_relationships
166
166
  # Get Flow Relationships
167
- # 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;
167
+ # 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;
168
168
  # @param id
169
169
  # @param related_resource
170
170
  # @param [Hash] opts the optional parameters
171
- # @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;
172
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
173
171
  # @return [Hash<String, Object>]
174
172
  describe 'get_flow_relationships test' do
175
173
  it 'should work' do
@@ -177,15 +175,28 @@ describe 'FlowsApi' do
177
175
  end
178
176
  end
179
177
 
178
+ # unit tests for get_flow_tags
179
+ # Get Flow Tags
180
+ # 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;
181
+ # @param flow_id
182
+ # @param [Hash] opts the optional parameters
183
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
184
+ # @return [Hash<String, Object>]
185
+ describe 'get_flow_tags test' do
186
+ it 'should work' do
187
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
188
+ end
189
+ end
190
+
180
191
  # unit tests for get_flows
181
192
  # Get Flows
182
193
  # 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;
183
194
  # @param [Hash] opts the optional parameters
184
- # @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
185
- # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
186
- # @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;
187
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
188
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
195
+ # @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
196
+ # @option opts [Array<String>] :fields_flow For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
197
+ # @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;
198
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
199
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
189
200
  # @return [Hash<String, Object>]
190
201
  describe 'get_flows test' do
191
202
  it 'should work' do
@@ -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
 
@@ -46,7 +46,7 @@ describe 'ListsApi' do
46
46
 
47
47
  # unit tests for create_list_relationships
48
48
  # Add Profile to List
49
- # Add a profile to a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60;
49
+ # Add a profile to a list with the given list ID. It is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you&#39;re trying to give a profile consent to receive email marketing. This endpoint accepts a maximum of 1000 profiles per call.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60;
50
50
  # @param id
51
51
  # @param related_resource
52
52
  # @param list_members_add_query
@@ -72,7 +72,7 @@ describe 'ListsApi' do
72
72
 
73
73
  # unit tests for delete_list_relationships
74
74
  # Remove Profile from List
75
- # Remove a profile from a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60;
75
+ # Remove a profile from a list with the given list ID. The provided profile will no longer receive marketing from this particular list once removed. Removing a profile from a list will not impact the profile&#39;s consent status or subscription status in general. To update a profile&#39;s subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60;
76
76
  # @param id
77
77
  # @param related_resource
78
78
  # @param list_members_delete_query
@@ -89,7 +89,7 @@ describe 'ListsApi' do
89
89
  # Get a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Write&#x60;
90
90
  # @param id
91
91
  # @param [Hash] opts the optional parameters
92
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
92
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
93
93
  # @return [Hash<String, Object>]
94
94
  describe 'get_list test' do
95
95
  it 'should work' do
@@ -99,12 +99,12 @@ describe 'ListsApi' do
99
99
 
100
100
  # unit tests for get_list_profiles
101
101
  # Get List Profiles
102
- # Get all profiles within a list with the given list ID. Use filters to narrow your results. Returns a maximum of 10 results per page, which can be paginated with [cursor-based 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;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Read&#x60; &#x60;Profiles Read&#x60;
102
+ # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by &#x60;email&#x60;, &#x60;phone_number&#x60;, and &#x60;push_token&#x60; fields. Returns a maximum of 10 results per page, which can be paginated with [cursor-based 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;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Read&#x60; &#x60;Profiles Read&#x60;
103
103
  # @param list_id
104
104
  # @param [Hash] opts the optional parameters
105
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
106
- # @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;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;
107
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
105
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
106
+ # @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;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;
107
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
108
108
  # @return [Hash<String, Object>]
109
109
  describe 'get_list_profiles test' do
110
110
  it 'should work' do
@@ -113,12 +113,12 @@ describe 'ListsApi' do
113
113
  end
114
114
 
115
115
  # unit tests for get_list_relationships
116
- # Get List Profile Relationships
116
+ # Get List Relationships
117
117
  # Get profile membership [relationships](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#relationships) for a list with the given list ID. Returns a maximum of 10 results per page, which can be paginated with [cursor-based 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;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Read&#x60; &#x60;Profiles Read&#x60;
118
118
  # @param id
119
119
  # @param related_resource
120
120
  # @param [Hash] opts the optional parameters
121
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
121
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
122
122
  # @return [Hash<String, Object>]
123
123
  describe 'get_list_relationships test' do
124
124
  it 'should work' do
@@ -126,13 +126,26 @@ describe 'ListsApi' do
126
126
  end
127
127
  end
128
128
 
129
+ # unit tests for get_list_tags
130
+ # Get List Tags
131
+ # Return all tags associated with the given list 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;List Read&#x60; &#x60;Tags Read&#x60;
132
+ # @param list_id
133
+ # @param [Hash] opts the optional parameters
134
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
135
+ # @return [Hash<String, Object>]
136
+ describe 'get_list_tags test' do
137
+ it 'should work' do
138
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
139
+ end
140
+ end
141
+
129
142
  # unit tests for get_lists
130
143
  # Get Lists
131
- # Get all lists in an account. Use filters to narrow your results. Returns a maximum of 10 results per page, which can be paginated with [cursor-based 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;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Read&#x60;
144
+ # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, and &#x60;updated&#x60; fields. Returns a maximum of 10 results per page, which can be paginated with [cursor-based 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;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;List Read&#x60;
132
145
  # @param [Hash] opts the optional parameters
133
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
134
- # @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;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
135
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
146
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
147
+ # @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;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
148
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
136
149
  # @return [Hash<String, Object>]
137
150
  describe 'get_lists test' do
138
151
  it 'should work' do
@@ -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
 
@@ -35,9 +35,9 @@ describe 'MetricsApi' do
35
35
  # unit tests for get_metric
36
36
  # Get Metric
37
37
  # Get a metric with the given metric 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;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;Metrics Read&#x60;
38
- # @param id
38
+ # @param id Metric ID
39
39
  # @param [Hash] opts the optional parameters
40
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
40
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
41
41
  # @return [Hash<String, Object>]
42
42
  describe 'get_metric test' do
43
43
  it 'should work' do
@@ -49,9 +49,9 @@ describe 'MetricsApi' do
49
49
  # Get Metrics
50
50
  # Get all metrics in an account. Requests can be filtered by the following fields: integration &#x60;name&#x60;, integration &#x60;category&#x60; Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 200 results per page, which can be paginated with [cursor-based 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;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;Metrics Read&#x60;
51
51
  # @param [Hash] opts the optional parameters
52
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
53
- # @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;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
54
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
52
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
53
+ # @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;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
54
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
55
55
  # @return [Hash<String, Object>]
56
56
  describe 'get_metrics test' do
57
57
  it 'should work' do
@@ -61,7 +61,7 @@ describe 'MetricsApi' do
61
61
 
62
62
  # unit tests for query_metric_aggregates
63
63
  # Query Metric Aggregates
64
- # Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your &#x60;POST&#x60; request. Results can be filtered and grouped by time, event, or profile dimensions. **Request body parameters** (nested under &#x60;attributes&#x60;): * &#x60;return_fields&#x60;: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets) * &#x60;sort&#x60;: sort results by a specified field, such as &#x60;\&quot;-timestamp\&quot;&#x60; * &#x60;page_cursor&#x60;: returns a maximum of ## results per page, which can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination) * &#x60;page_size&#x60;: limit the number of returned results per page * &#x60;by&#x60;: optional attributes used to group by the aggregation function * When using &#x60;by&#x60; attributes, an empty &#x60;dimensions&#x60; response is expected when the counts for the events do not have the associated dimension requested by the set &#x60;by&#x60; attribute. For example, a query including &#x60;\&quot;by\&quot;: [\&quot;$flow\&quot;]&#x60; will return an empty dimensions response for counts of metrics not associated with a &#x60;$flow&#x60; * &#x60;measurement&#x60;: the measurement key supports the following values: * &#x60;\&quot;sum_value\&quot;&#x60;: perform a summation of the &#x60;_Event Value_&#x60;, optionally partitioned over any dimension provided in the &#x60;by&#x60; field * &#x60;\&quot;count\&quot;&#x60;: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the &#x60;by&#x60; field * &#x60;\&quot;unique\&quot;&#x60; counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the &#x60;by&#x60; field * &#x60;interval&#x60;: aggregation interval, such as &#x60;\&quot;hour\&quot;&#x60;,&#x60;\&quot;day\&quot;&#x60;,&#x60;\&quot;week\&quot;&#x60;, and &#x60;\&quot;month\&quot;&#x60; * &#x60;metric_id&#x60;: the metric ID used in the aggregation * &#x60;filter&#x60;: list of filters for specific fields, must include time range using ISO 8601 format (&#x60;\&quot;YYYY-MM-DDTHH:MM:SS.mmmmmm\&quot;&#x60;) * The time range can be filtered by providing a &#x60;greater_or_equal&#x60; filter on the datetime field, such as &#x60;\&quot;greater-or-equal(datetime,2021-07-01T00:00:00)\&quot;&#x60; and a &#x60;less-than&#x60; filter on the same datetime field, such as &#x60;\&quot;less-than(datetime,2022-07-01T00:00:00)\&quot;&#x60; * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as &#x60;\&quot;equals(URL,\\\&quot;https://www.klaviyo.com/\\\&quot;)\&quot;&#x60; * &#x60;timezone&#x60;: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/v2022-10-17/docs/supported_metrics_and_attributes).&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;Metrics Read&#x60;
64
+ # Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your &#x60;POST&#x60; request. Results can be filtered and grouped by time, event, or profile dimensions. **Request body parameters** (nested under &#x60;attributes&#x60;): * &#x60;return_fields&#x60;: request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets) * &#x60;sort&#x60;: sort results by a specified field, such as &#x60;\&quot;-timestamp\&quot;&#x60; * &#x60;page_cursor&#x60;: results can be paginated with [cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination) * &#x60;page_size&#x60;: limit the number of returned results per page * &#x60;by&#x60;: optional attributes used to group by the aggregation function * When using &#x60;by&#x60; attributes, an empty &#x60;dimensions&#x60; response is expected when the counts for the events do not have the associated dimension requested by the set &#x60;by&#x60; attribute. For example, a query including &#x60;\&quot;by\&quot;: [\&quot;$flow\&quot;]&#x60; will return an empty dimensions response for counts of metrics not associated with a &#x60;$flow&#x60; * &#x60;measurement&#x60;: the measurement key supports the following values: * &#x60;\&quot;sum_value\&quot;&#x60;: perform a summation of the &#x60;_Event Value_&#x60;, optionally partitioned over any dimension provided in the &#x60;by&#x60; field * &#x60;\&quot;count\&quot;&#x60;: counts the number of events associated to a metric, optionally partitioned over any dimension provided in the &#x60;by&#x60; field * &#x60;\&quot;unique\&quot;&#x60; counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the &#x60;by&#x60; field * &#x60;interval&#x60;: aggregation interval, such as &#x60;\&quot;hour\&quot;&#x60;,&#x60;\&quot;day\&quot;&#x60;,&#x60;\&quot;week\&quot;&#x60;, and &#x60;\&quot;month\&quot;&#x60; * &#x60;metric_id&#x60;: the metric ID used in the aggregation * &#x60;filter&#x60;: list of filters for specific fields, must include time range using ISO 8601 format (&#x60;\&quot;YYYY-MM-DDTHH:MM:SS.mmmmmm\&quot;&#x60;) * The time range can be filtered by providing a &#x60;greater_or_equal&#x60; filter on the datetime field, such as &#x60;\&quot;greater-or-equal(datetime,2021-07-01T00:00:00)\&quot;&#x60; and a &#x60;less-than&#x60; filter on the same datetime field, such as &#x60;\&quot;less-than(datetime,2022-07-01T00:00:00)\&quot;&#x60; * The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date * Filter the list of supported aggregate dimensions using the common filter syntax, such as &#x60;\&quot;equals(URL,\\\&quot;https://www.klaviyo.com/\\\&quot;)\&quot;&#x60; * &#x60;timezone&#x60;: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones) For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/v2022-10-17/docs/supported_metrics_and_attributes).&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;Metrics Read&#x60;
65
65
  # @param metric_aggregate_query Retrieve Metric Aggregations
66
66
  # @param [Hash] opts the optional parameters
67
67
  # @return [Hash<String, Object>]