klaviyo-api-sdk 1.0.1 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (530) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -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 +3 -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 -22
  527. data/docs/IncludedProfile.md +0 -24
  528. data/docs/TemplateDeleteQueryAsSubResource.md +0 -20
  529. data/docs/V2TemplateRenderQuery.md +0 -18
  530. data/test.rb +0 -50
@@ -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
 
@@ -34,7 +34,7 @@ describe 'ProfilesApi' do
34
34
 
35
35
  # unit tests for create_profile
36
36
  # Create Profile
37
- # Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
37
+ # Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email`, `external_id`, or `anonymous_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Profiles Write`
38
38
  # @param profile_create_query
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [Hash<String, Object>]
@@ -46,13 +46,13 @@ describe 'ProfilesApi' do
46
46
 
47
47
  # unit tests for get_profile
48
48
  # Get Profile
49
- # Get the profile with the given profile 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;lists&#x60; memberships, &#x60;segments&#x60; memberships\&quot;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Profiles Read&#x60;
49
+ # Get the profile with the given profile 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;lists&#x60; memberships, &#x60;segments&#x60; memberships\&quot;&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;Profiles Read&#x60;
50
50
  # @param id
51
51
  # @param [Hash] opts the optional parameters
52
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
53
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
54
- # @option opts [Array<String>] :fields_segment 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_list For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
53
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
54
+ # @option opts [Array<String>] :fields_segment 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_profile test' do
58
58
  it 'should work' do
@@ -65,7 +65,7 @@ describe 'ProfilesApi' do
65
65
  # Get list memberships for a profile with the given profile 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;Profiles Read&#x60;
66
66
  # @param profile_id
67
67
  # @param [Hash] opts the optional parameters
68
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
68
+ # @option opts [Array<String>] :fields_list 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_profile_lists test' do
71
71
  it 'should work' do
@@ -75,7 +75,7 @@ describe 'ProfilesApi' do
75
75
 
76
76
  # unit tests for get_profile_relationships
77
77
  # Get Profile Relationships
78
- # Get list membership or segment membership relationships for a profile with the given profile 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;Profiles Read&#x60; &#x60;Segments Read&#x60;
78
+ # Get list membership or segment membership relationships for a profile with the given profile 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;Lists Read&#x60; &#x60;Profiles Read&#x60; &#x60;Segments Read&#x60;
79
79
  # @param id
80
80
  # @param related_resource
81
81
  # @param [Hash] opts the optional parameters
@@ -91,7 +91,7 @@ describe 'ProfilesApi' do
91
91
  # Get segment memberships for a profile with the given profile 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;Profiles Read&#x60; &#x60;Segments Read&#x60;
92
92
  # @param profile_id
93
93
  # @param [Hash] opts the optional parameters
94
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
94
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
95
95
  # @return [Hash<String, Object>]
96
96
  describe 'get_profile_segments test' do
97
97
  it 'should work' do
@@ -101,12 +101,12 @@ describe 'ProfilesApi' do
101
101
 
102
102
  # unit tests for get_profiles
103
103
  # Get Profiles
104
- # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: &#x60;id&#x60;, &#x60;created&#x60;, &#x60;email&#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 20 profiles 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;Profiles Write&#x60;
104
+ # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: &#x60;id&#x60;, &#x60;created&#x60;, &#x60;email&#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 20 profiles 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;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Profiles Read&#x60;
105
105
  # @param [Hash] opts the optional parameters
106
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
107
- # @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;, &#x60;equals&#x60;&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;anonymous_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;
108
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
109
- # @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_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
107
+ # @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;, &#x60;equals&#x60;&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;anonymous_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;
108
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
109
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
110
110
  # @return [Hash<String, Object>]
111
111
  describe 'get_profiles test' do
112
112
  it 'should work' do
@@ -116,7 +116,7 @@ describe 'ProfilesApi' do
116
116
 
117
117
  # unit tests for subscribe_profiles
118
118
  # Subscribe Profiles
119
- # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/v2022-10-17/reference/create_list_relationships).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
119
+ # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/v2022-10-17/reference/create_list_relationships). Maximum number of profile can be submitted for subscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
120
120
  # @param subscription_create_job_create_query Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
121
121
  # @param [Hash] opts the optional parameters
122
122
  # @return [nil]
@@ -128,7 +128,7 @@ describe 'ProfilesApi' do
128
128
 
129
129
  # unit tests for suppress_profiles
130
130
  # Suppress Profiles
131
- # Manually suppress one or more profiles. Manually suppressed profiles will not receive email marketing. Not supported for SMS marketing.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
131
+ # Manually suppress one or more profiles. Manually suppressed profiles will not receive email marketing. Not supported for SMS marketing. Maximum number of profile can be submitted for suppression: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
132
132
  # @param suppression_create_job_create_query Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
133
133
  # @param [Hash] opts the optional parameters
134
134
  # @return [nil]
@@ -140,7 +140,7 @@ describe 'ProfilesApi' do
140
140
 
141
141
  # unit tests for unsubscribe_profiles
142
142
  # Unsubscribe Profiles
143
- # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_list_relationships).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
143
+ # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/v2022-10-17/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;List Write&#x60; &#x60;Profiles Write&#x60; &#x60;Subscriptions Write&#x60;
144
144
  # @param unsubscription_create_job_create_query Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
145
145
  # @param [Hash] opts the optional parameters
146
146
  # @return [nil]
@@ -152,7 +152,7 @@ describe 'ProfilesApi' do
152
152
 
153
153
  # unit tests for unsuppress_profiles
154
154
  # Unsuppress Profiles
155
- # Unsuppress one or more profiles. Unsuppressed profiles will receive email marketing. Not supported for SMS marketing. Profiles suppressed due to a hard bounced email will not be unsuppressed.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Subscriptions Write&#x60;
155
+ # Unsuppress one or more profiles. Unsuppressed profiles will receive email marketing. Not supported for SMS marketing. Profiles suppressed due to a hard bounced email will not be unsuppressed. Maximum number of profile can be submitted for unsuppression: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Subscriptions Write&#x60;
156
156
  # @param unsuppression_create_job_create_query Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
157
157
  # @param [Hash] opts the optional parameters
158
158
  # @return [nil]
@@ -164,7 +164,7 @@ describe 'ProfilesApi' do
164
164
 
165
165
  # unit tests for update_profile
166
166
  # Update Profile
167
- # Update the profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Profiles Write&#x60;
167
+ # Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you&#39;ll need to include at least one other identifier attribute (&#x60;email&#x60;, &#x60;external_id&#x60;, or &#x60;anonymous_id&#x60;) in addition to the &#x60;phone_number&#x60; attribute for the API call to work.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;Profiles Write&#x60;
168
168
  # @param id
169
169
  # @param profile_partial_update_query
170
170
  # @param [Hash] opts the optional parameters
@@ -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,7 +37,7 @@ describe 'SegmentsApi' do
37
37
  # Get a segment with the given segment 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;Segments Read&#x60;
38
38
  # @param id
39
39
  # @param [Hash] opts the optional parameters
40
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
40
+ # @option opts [Array<String>] :fields_segment 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_segment test' do
43
43
  it 'should work' do
@@ -50,9 +50,10 @@ describe 'SegmentsApi' do
50
50
  # Get all profiles within the given segment 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;Profiles Read&#x60; &#x60;Segments Read&#x60;
51
51
  # @param segment_id
52
52
  # @param [Hash] opts the optional parameters
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;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;
54
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
55
- # @return [nil]
53
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
54
+ # @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;
55
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
56
+ # @return [Hash<String, Object>]
56
57
  describe 'get_segment_profiles test' do
57
58
  it 'should work' do
58
59
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -65,7 +66,7 @@ describe 'SegmentsApi' do
65
66
  # @param id
66
67
  # @param related_resource
67
68
  # @param [Hash] opts the optional parameters
68
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
69
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
69
70
  # @return [Hash<String, Object>]
70
71
  describe 'get_segment_relationships test' do
71
72
  it 'should work' do
@@ -73,13 +74,26 @@ describe 'SegmentsApi' do
73
74
  end
74
75
  end
75
76
 
77
+ # unit tests for get_segment_tags
78
+ # Get Segment Tags
79
+ # Return all tags associated with the given segment ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Segments Read&#x60; &#x60;Tags Read&#x60;
80
+ # @param segment_id
81
+ # @param [Hash] opts the optional parameters
82
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
83
+ # @return [Hash<String, Object>]
84
+ describe 'get_segment_tags test' do
85
+ it 'should work' do
86
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
87
+ end
88
+ end
89
+
76
90
  # unit tests for get_segments
77
91
  # Get Segments
78
92
  # Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by &#x60;name&#x60;, &#x60;created&#x60;, and &#x60;updated&#x60; fields. Returns a maximum of 10 results per page, 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;Segments Read&#x60;
79
93
  # @param [Hash] opts the optional parameters
80
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
81
- # @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;
82
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination
94
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
95
+ # @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;
96
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
83
97
  # @return [Hash<String, Object>]
84
98
  describe 'get_segments test' do
85
99
  it 'should work' do
@@ -0,0 +1,245 @@
1
+ =begin
2
+ #Klaviyo API
3
+
4
+ #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
+
6
+ The version of the OpenAPI document: 2023-01-24
7
+ Contact: developers@klaviyo.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.2.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for KlaviyoAPI::TagsApi
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe 'TagsApi' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = KlaviyoAPI::TagsApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of TagsApi' do
30
+ it 'should create an instance of TagsApi' do
31
+ expect(@api_instance).to be_instance_of(KlaviyoAPI::TagsApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for create_tag
36
+ # Create Tag
37
+ # Create a tag. An account cannot have more than **500** unique tags. A tag belongs to a single tag group. If the &#x60;tag_group_id&#x60; is not specified, the tag is added to the account&#39;s default tag group.&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;Tags Read&#x60; &#x60;Tags Write&#x60;
38
+ # @param tag_create_query
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [Hash<String, Object>]
41
+ describe 'create_tag test' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ # unit tests for create_tag_group
48
+ # Create Tag Group
49
+ # Create a tag group. An account cannot have more than **50** unique tag groups. If &#x60;exclusive&#x60; is not specified &#x60;true&#x60; or &#x60;false&#x60;, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.&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;Tags Read&#x60; &#x60;Tags Write&#x60;
50
+ # @param tag_group_create_query
51
+ # @param [Hash] opts the optional parameters
52
+ # @return [Hash<String, Object>]
53
+ describe 'create_tag_group test' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ # unit tests for create_tag_relationships
60
+ # Create Tag Relationships
61
+ # Associate a tag with other resources. Any given resource cannot be associated with more than **100** tags. The &#x60;related_resource&#x60; can be one of &#x60;campaigns&#x60;, &#x60;flows&#x60;, &#x60;lists&#x60;, or &#x60;segments&#x60;. Use the request body to pass in the ID(s) of the related resource(s) that will be associated with the tag. The scopes listed below are conditionally required depending on the specified related resource.&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 Write&#x60; &#x60;Lists Write&#x60; &#x60;Segments Write&#x60; &#x60;Tags Write&#x60;
62
+ # @param id
63
+ # @param related_resource
64
+ # @param tag_segment_op
65
+ # @param [Hash] opts the optional parameters
66
+ # @return [nil]
67
+ describe 'create_tag_relationships test' do
68
+ it 'should work' do
69
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
70
+ end
71
+ end
72
+
73
+ # unit tests for delete_tag
74
+ # Delete Tag
75
+ # Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.&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;Tags Read&#x60; &#x60;Tags Write&#x60;
76
+ # @param id The Tag ID
77
+ # @param [Hash] opts the optional parameters
78
+ # @return [Hash<String, Object>]
79
+ describe 'delete_tag test' do
80
+ it 'should work' do
81
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
82
+ end
83
+ end
84
+
85
+ # unit tests for delete_tag_group
86
+ # Delete Tag Group
87
+ # Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.&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;Tags Read&#x60; &#x60;Tags Write&#x60;
88
+ # @param id The Tag Group ID
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Hash<String, Object>]
91
+ describe 'delete_tag_group test' do
92
+ it 'should work' do
93
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
94
+ end
95
+ end
96
+
97
+ # unit tests for delete_tag_relationships
98
+ # Delete Tag Relationships
99
+ # Remove a tag&#39;s association with other resources. The &#x60;related_resource&#x60; can be one of &#x60;campaigns&#x60;, &#x60;flows&#x60;, &#x60;lists&#x60;, or &#x60;segments&#x60;. Use the request body to pass in the ID(s) of the related resource(s) whose association with the tag will be removed. The scopes listed below are conditionally required depending on the specified related resource.&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 Write&#x60; &#x60;Lists Write&#x60; &#x60;Segments Write&#x60; &#x60;Tags Write&#x60;
100
+ # @param id
101
+ # @param related_resource
102
+ # @param tag_segment_op
103
+ # @param [Hash] opts the optional parameters
104
+ # @return [nil]
105
+ describe 'delete_tag_relationships test' do
106
+ it 'should work' do
107
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
108
+ end
109
+ end
110
+
111
+ # unit tests for get_tag
112
+ # Get Tag
113
+ # Retrieve the tag with the given tag 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;Tags Read&#x60;
114
+ # @param id The Tag ID
115
+ # @param [Hash] opts the optional parameters
116
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
117
+ # @return [Hash<String, Object>]
118
+ describe 'get_tag test' do
119
+ it 'should work' do
120
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
121
+ end
122
+ end
123
+
124
+ # unit tests for get_tag_group
125
+ # Get Tag Group
126
+ # Retrieve the tag group with the given tag group 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;Tags Read&#x60;
127
+ # @param id The Tag Group ID
128
+ # @param [Hash] opts the optional parameters
129
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
130
+ # @return [Hash<String, Object>]
131
+ describe 'get_tag_group test' do
132
+ it 'should work' do
133
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
134
+ end
135
+ end
136
+
137
+ # unit tests for get_tag_group_relationships
138
+ # Get Tag Group Relationships
139
+ # When &#x60;related_resource&#x60; is &#x60;tags&#x60;, returns the tag IDs of all tags inside the given tag group.&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;Tags Read&#x60;
140
+ # @param id
141
+ # @param related_resource
142
+ # @param [Hash] opts the optional parameters
143
+ # @return [Hash<String, Object>]
144
+ describe 'get_tag_group_relationships test' do
145
+ it 'should work' do
146
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
147
+ end
148
+ end
149
+
150
+ # unit tests for get_tag_group_tags
151
+ # Get Tag Group Tags
152
+ # Return the tags for a given tag group 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;Tags Read&#x60;
153
+ # @param id The Tag Group ID
154
+ # @param [Hash] opts the optional parameters
155
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
156
+ # @return [Hash<String, Object>]
157
+ describe 'get_tag_group_tags test' do
158
+ it 'should work' do
159
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
160
+ end
161
+ end
162
+
163
+ # unit tests for get_tag_groups
164
+ # Get Tag Groups
165
+ # List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by &#x60;name&#x60;, &#x60;exclusive&#x60;, and &#x60;default&#x60;, and sorted by &#x60;name&#x60; or &#x60;id&#x60; in ascending or descending order. Returns a maximum of 25 tag groups per request, 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;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Tags Read&#x60;
166
+ # @param [Hash] opts the optional parameters
167
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
168
+ # @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;exclusive&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;default&#x60;: &#x60;equals&#x60;
169
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
170
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
171
+ # @return [Hash<String, Object>]
172
+ describe 'get_tag_groups test' do
173
+ it 'should work' do
174
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
175
+ end
176
+ end
177
+
178
+ # unit tests for get_tag_relationships
179
+ # Get Tag Relationships
180
+ # Get the relationships for a tag. If &#x60;related_resource&#x60; is &#x60;tag-group&#x60;, the request will return the &#x60;tag_group_id&#x60; of the tag group to which the tag belongs. If &#x60;related_resource&#x60; is set to &#x60;campaigns&#x60;, &#x60;flows&#x60;, &#x60;lists&#x60;, or &#x60;segments&#x60;, the request will return the IDs of all associated resources of that type. The scopes listed below are conditionally required depending on the specified related resource.&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;Lists Read&#x60; &#x60;Segments Read&#x60; &#x60;Tags Read&#x60;
181
+ # @param id
182
+ # @param related_resource
183
+ # @param [Hash] opts the optional parameters
184
+ # @return [Hash<String, Object>]
185
+ describe 'get_tag_relationships 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
+
191
+ # unit tests for get_tag_tag_group
192
+ # Get Tag Tag Group
193
+ # Returns the tag group resource for a given tag 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;Tags Read&#x60;
194
+ # @param id The Tag ID
195
+ # @param [Hash] opts the optional parameters
196
+ # @option opts [Array<String>] :fields_tag_group For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
197
+ # @return [Hash<String, Object>]
198
+ describe 'get_tag_tag_group test' do
199
+ it 'should work' do
200
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
201
+ end
202
+ end
203
+
204
+ # unit tests for get_tags
205
+ # Get Tags
206
+ # List all tags in an account. Tags can be filtered by &#x60;name&#x60;, and sorted by &#x60;name&#x60; or &#x60;id&#x60; in ascending or descending order. Returns a maximum of 50 tags per request, 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;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;Tags Read&#x60;
207
+ # @param [Hash] opts the optional parameters
208
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
209
+ # @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;
210
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
211
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
212
+ # @return [Hash<String, Object>]
213
+ describe 'get_tags test' do
214
+ it 'should work' do
215
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
216
+ end
217
+ end
218
+
219
+ # unit tests for update_tag
220
+ # Update Tag
221
+ # Update the tag with the given tag ID. Only a tag&#39;s &#x60;name&#x60; can be changed. A tag cannot be moved from one tag group to another.&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;Tags Read&#x60; &#x60;Tags Write&#x60;
222
+ # @param id The Tag ID
223
+ # @param tag_update_query
224
+ # @param [Hash] opts the optional parameters
225
+ # @return [Hash<String, Object>]
226
+ describe 'update_tag test' do
227
+ it 'should work' do
228
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
229
+ end
230
+ end
231
+
232
+ # unit tests for update_tag_group
233
+ # Update Tag Group
234
+ # Update the tag group with the given tag group ID. Only a tag group&#39;s &#x60;name&#x60; can be changed. A tag group&#39;s &#x60;exclusive&#x60; or &#x60;default&#x60; value cannot be changed.&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;Tags Read&#x60; &#x60;Tags Write&#x60;
235
+ # @param id The Tag Group ID
236
+ # @param tag_group_update_query
237
+ # @param [Hash] opts the optional parameters
238
+ # @return [Hash<String, Object>]
239
+ describe 'update_tag_group test' do
240
+ it 'should work' do
241
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
242
+ end
243
+ end
244
+
245
+ end
@@ -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
 
@@ -34,8 +34,8 @@ describe 'TemplatesApi' do
34
34
 
35
35
  # unit tests for create_template
36
36
  # Create Template
37
- # Create a new custom HTML template. 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;Templates Write&#x60;
38
- # @param template_create_query Query for creating a CODE template
37
+ # Create a new custom HTML template. If there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates that can be created via the API. 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;Templates Write&#x60;
38
+ # @param template_create_query
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [Hash<String, Object>]
41
41
  describe 'create_template test' do
@@ -47,8 +47,8 @@ describe 'TemplatesApi' do
47
47
  # unit tests for create_template_clone
48
48
  # Create Template Clone
49
49
  # Create a clone of a template with the given template 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;Templates Write&#x60;
50
- # @param id
51
- # @param template_clone_query Query for cloning a template
50
+ # @param id The ID of template to be cloned
51
+ # @param template_clone_query
52
52
  # @param [Hash] opts the optional parameters
53
53
  # @return [Hash<String, Object>]
54
54
  describe 'create_template_clone test' do
@@ -59,9 +59,9 @@ describe 'TemplatesApi' do
59
59
 
60
60
  # unit tests for create_template_render
61
61
  # Create Template Render
62
- # Render a template with the given template ID and context attribute. Returns the HTML and plain text versions of the email template. **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;context&#x60;: This is the context your email template will be rendered with. You must pass in a &#x60;context&#x60; object as a JSON object. Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding &#x60;context&#x60; values are treated as &#x60;FALSE&#x60; and output nothing. Ex. &#x60;{ \&quot;name\&quot; : \&quot;George Washington\&quot;, \&quot;state\&quot; : \&quot;VA\&quot; }&#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;Templates Read&#x60;
63
- # @param id
64
- # @param v2_template_render_query Query for rendering a template
62
+ # Render a template with the given template ID and context attribute. Returns the HTML and plain text versions of the email template. **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;context&#x60;: This is the context your email template will be rendered with. You must pass in a &#x60;context&#x60; object as a JSON object. Email templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding &#x60;context&#x60; values are treated as &#x60;FALSE&#x60; and output nothing. Ex. &#x60;{ \&quot;name\&quot; : \&quot;George Washington\&quot;, \&quot;state\&quot; : \&quot;VA\&quot; }&#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;Templates Read&#x60;
63
+ # @param id The ID of template
64
+ # @param template_render_query
65
65
  # @param [Hash] opts the optional parameters
66
66
  # @return [Hash<String, Object>]
67
67
  describe 'create_template_render test' do
@@ -73,7 +73,7 @@ describe 'TemplatesApi' do
73
73
  # unit tests for delete_template
74
74
  # Delete Template
75
75
  # Delete a template with the given template 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;Templates Write&#x60;
76
- # @param id
76
+ # @param id The ID of template
77
77
  # @param [Hash] opts the optional parameters
78
78
  # @return [Hash<String, Object>]
79
79
  describe 'delete_template test' do
@@ -85,9 +85,9 @@ describe 'TemplatesApi' do
85
85
  # unit tests for get_template
86
86
  # Get Template
87
87
  # Get a template with the given template 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;Templates Read&#x60;
88
- # @param id
88
+ # @param id The ID of template
89
89
  # @param [Hash] opts the optional parameters
90
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
90
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
91
91
  # @return [Hash<String, Object>]
92
92
  describe 'get_template test' do
93
93
  it 'should work' do
@@ -99,10 +99,10 @@ describe 'TemplatesApi' do
99
99
  # Get Templates
100
100
  # Get all templates in an account. Filter to request a subset of all templates. Templates can be sorted by the following fields, in ascending and descending order: &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, &#x60;updated&#x60; Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#sparse-fieldsets). Returns a maximum of 20 results per page. Results 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;Templates Read&#x60;
101
101
  # @param [Hash] opts the optional parameters
102
- # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
103
- # @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;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#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;
104
- # @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 [String] :sort For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sorting
102
+ # @option opts [Array<String>] :fields_template For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
103
+ # @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;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#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;
104
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
105
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
106
106
  # @return [Hash<String, Object>]
107
107
  describe 'get_templates test' do
108
108
  it 'should work' do
@@ -113,8 +113,8 @@ describe 'TemplatesApi' do
113
113
  # unit tests for update_template
114
114
  # Update Template
115
115
  # Update a template with the given template 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;Templates Write&#x60;
116
- # @param id
117
- # @param template_update_query Query for updating a CODE template
116
+ # @param id The ID of template
117
+ # @param template_update_query
118
118
  # @param [Hash] opts the optional parameters
119
119
  # @return [Hash<String, Object>]
120
120
  describe 'update_template test' 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
 
@@ -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