klaviyo-api-sdk 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (324) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/README.md +314 -136
  4. data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
  5. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
  6. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
  7. data/docs/CampaignTagOp.md +18 -0
  8. data/docs/CampaignTagOpDataInner.md +20 -0
  9. data/docs/CampaignsApi.md +1277 -0
  10. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  11. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +6 -6
  12. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  13. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +2 -2
  14. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  15. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +2 -2
  16. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +2 -2
  17. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  18. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +21 -19
  19. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  20. data/docs/CatalogItemDeleteQueryAsSubResource.md +2 -2
  21. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  22. data/docs/CatalogItemUpdateQueryAsSubResource.md +2 -2
  23. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +18 -16
  24. data/docs/CatalogJobErrorPayload.md +8 -8
  25. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  26. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +27 -27
  27. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  28. data/docs/CatalogVariantDeleteQueryAsSubResource.md +2 -2
  29. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  30. data/docs/CatalogVariantUpdateQueryAsSubResource.md +2 -2
  31. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +22 -22
  32. data/docs/CatalogsApi.md +238 -238
  33. data/docs/ErrorSource.md +1 -1
  34. data/docs/EventsApi.md +26 -26
  35. data/docs/FlowsApi.md +64 -56
  36. data/docs/GetCampaigns4XXResponse.md +18 -0
  37. data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
  38. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
  39. data/docs/IncludedCategories.md +2 -2
  40. data/docs/IncludedCategoriesAttributes.md +5 -5
  41. data/docs/IncludedItems.md +2 -2
  42. data/docs/IncludedItemsAttributes.md +22 -20
  43. data/docs/IncludedLists.md +2 -2
  44. data/docs/IncludedListsAttributes.md +4 -4
  45. data/docs/IncludedProfiles.md +2 -2
  46. data/docs/IncludedProfilesAttributes.md +21 -21
  47. data/docs/IncludedSegments.md +1 -1
  48. data/docs/IncludedSegmentsAttributes.md +22 -0
  49. data/docs/IncludedTags.md +24 -0
  50. data/docs/IncludedVariants.md +2 -2
  51. data/docs/IncludedVariantsAttributes.md +28 -28
  52. data/docs/ListCreateQueryAsSubResourceAttributes.md +2 -2
  53. data/docs/ListPartialUpdateQueryAsSubResource.md +2 -2
  54. data/docs/ListsApi.md +30 -30
  55. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +5 -5
  56. data/docs/MetricsApi.md +9 -9
  57. data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
  58. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +18 -18
  59. data/docs/ProfileLocation.md +15 -15
  60. data/docs/ProfileLocationLongitude.md +49 -0
  61. data/docs/ProfilePartialUpdateQueryAsSubResource.md +2 -2
  62. data/docs/ProfilesApi.md +26 -26
  63. data/docs/STOScheduleOptions.md +18 -0
  64. data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
  65. data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
  66. data/docs/SegmentsApi.md +19 -19
  67. data/docs/SendOptionsSubObject.md +1 -3
  68. data/docs/SendStrategySubObject.md +4 -2
  69. data/docs/Subscription.md +8 -4
  70. data/docs/SubscriptionChannels.md +20 -0
  71. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +2 -2
  72. data/docs/Suppression.md +1 -1
  73. data/docs/TagsApi.md +24 -24
  74. data/docs/TemplateCloneQueryAsSubResource.md +0 -2
  75. data/docs/TemplatesApi.md +11 -11
  76. data/docs/ThrottledScheduleOptions.md +1 -1
  77. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
  78. data/klaviyo-api-sdk.gemspec +2 -2
  79. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
  80. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +299 -299
  81. data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
  82. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  83. data/lib/klaviyo-api-sdk/api/events_api.rb +33 -33
  84. data/lib/klaviyo-api-sdk/api/flows_api.rb +86 -74
  85. data/lib/klaviyo-api-sdk/api/lists_api.rb +39 -39
  86. data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
  87. data/lib/klaviyo-api-sdk/api/profiles_api.rb +34 -34
  88. data/lib/klaviyo-api-sdk/api/segments_api.rb +25 -25
  89. data/lib/klaviyo-api-sdk/api/tags_api.rb +41 -41
  90. data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
  91. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  92. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  93. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
  111. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +272 -0
  112. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +225 -0
  113. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
  120. data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +272 -0
  121. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +5 -2
  127. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +2 -2
  131. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +2 -2
  137. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +23 -3
  145. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +2 -2
  152. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +2 -2
  157. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +20 -2
  158. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +16 -8
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +2 -2
  172. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +2 -2
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +12 -2
  178. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
  185. data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
  192. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
  193. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
  194. data/lib/klaviyo-api-sdk/models/included_categories.rb +2 -2
  195. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +4 -1
  196. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/included_flows.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/included_items.rb +2 -1
  206. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +23 -2
  207. data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -1
  208. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +4 -1
  209. data/lib/klaviyo-api-sdk/models/included_metrics.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -1
  212. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +13 -1
  213. data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
  214. data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
  215. data/lib/klaviyo-api-sdk/models/included_tags.rb +301 -0
  216. data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -1
  217. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +16 -2
  218. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -1
  222. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  223. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -1
  227. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +17 -15
  230. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  235. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
  236. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +10 -1
  242. data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
  243. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
  244. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
  245. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -1
  247. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
  249. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +224 -0
  250. data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
  252. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
  253. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
  259. data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
  260. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
  261. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  275. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +2 -13
  284. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +1 -1
  287. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +1 -1
  288. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  289. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +1 -1
  291. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  304. data/lib/klaviyo-api-sdk/version.rb +1 -1
  305. data/lib/klaviyo-api-sdk.rb +14 -5
  306. data/spec/api/campaigns_api_spec.rb +284 -0
  307. data/spec/api_client_spec.rb +1 -1
  308. data/spec/configuration_spec.rb +1 -1
  309. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  310. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +44 -0
  311. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
  312. data/spec/models/campaign_tag_op_data_inner_spec.rb +44 -0
  313. data/spec/models/campaign_tag_op_spec.rb +34 -0
  314. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
  315. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
  316. data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
  317. data/spec/models/included_segments_attributes_spec.rb +46 -0
  318. data/spec/models/included_tags_spec.rb +56 -0
  319. data/spec/models/profile_location_longitude_spec.rb +31 -0
  320. data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
  321. data/spec/models/sto_schedule_options_spec.rb +34 -0
  322. data/spec/models/subscription_channels_spec.rb +48 -0
  323. data/spec/spec_helper.rb +1 -1
  324. metadata +51 -6
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
5
 
6
- The version of the OpenAPI document: 2023-01-24
6
+ The version of the OpenAPI document: 2023-02-22
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -51,7 +51,7 @@ module KlaviyoAPI
51
51
  # header parameters
52
52
  header_params = opts[:header_params] || {}
53
53
  # klaviyo api revision
54
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
54
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
55
55
  # HTTP header 'Accept' (if needed)
56
56
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
57
  # HTTP header 'Content-Type'
@@ -138,7 +138,7 @@ module KlaviyoAPI
138
138
  # header parameters
139
139
  header_params = opts[:header_params] || {}
140
140
  # klaviyo api revision
141
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
141
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
142
142
  # HTTP header 'Accept' (if needed)
143
143
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
144
144
  # HTTP header 'Content-Type'
@@ -208,7 +208,7 @@ module KlaviyoAPI
208
208
  # header parameters
209
209
  header_params = opts[:header_params] || {}
210
210
  # klaviyo api revision
211
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
211
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
212
212
  # HTTP header 'Accept' (if needed)
213
213
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
214
214
  # HTTP header 'Content-Type'
@@ -295,7 +295,7 @@ module KlaviyoAPI
295
295
  # header parameters
296
296
  header_params = opts[:header_params] || {}
297
297
  # klaviyo api revision
298
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
298
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
299
299
  # HTTP header 'Accept' (if needed)
300
300
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
301
301
  # HTTP header 'Content-Type'
@@ -365,7 +365,7 @@ module KlaviyoAPI
365
365
  # header parameters
366
366
  header_params = opts[:header_params] || {}
367
367
  # klaviyo api revision
368
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
368
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
369
369
  # HTTP header 'Accept' (if needed)
370
370
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
371
371
  # HTTP header 'Content-Type'
@@ -405,7 +405,7 @@ module KlaviyoAPI
405
405
 
406
406
  # Delete Catalog Category
407
407
  # Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
408
- # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
408
+ # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
409
409
  # @param [Hash] opts the optional parameters
410
410
  # @return [nil]
411
411
  def delete_catalog_category(id, opts = {})
@@ -415,7 +415,7 @@ module KlaviyoAPI
415
415
 
416
416
  # Delete Catalog Category
417
417
  # Delete a catalog category using the given category 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;Catalogs Write&#x60;
418
- # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
418
+ # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
419
419
  # @param [Hash] opts the optional parameters
420
420
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
421
421
  def delete_catalog_category_with_http_info(id, opts = {})
@@ -435,7 +435,7 @@ module KlaviyoAPI
435
435
  # header parameters
436
436
  header_params = opts[:header_params] || {}
437
437
  # klaviyo api revision
438
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
438
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
439
439
  # HTTP header 'Accept' (if needed)
440
440
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
441
441
 
@@ -517,7 +517,7 @@ module KlaviyoAPI
517
517
  # header parameters
518
518
  header_params = opts[:header_params] || {}
519
519
  # klaviyo api revision
520
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
520
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
521
521
  # HTTP header 'Accept' (if needed)
522
522
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
523
523
  # HTTP header 'Content-Type'
@@ -557,7 +557,7 @@ module KlaviyoAPI
557
557
 
558
558
  # Delete Catalog Item
559
559
  # Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
560
- # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
560
+ # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
561
561
  # @param [Hash] opts the optional parameters
562
562
  # @return [nil]
563
563
  def delete_catalog_item(id, opts = {})
@@ -567,7 +567,7 @@ module KlaviyoAPI
567
567
 
568
568
  # Delete Catalog Item
569
569
  # Delete a catalog item with the given item 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;Catalogs Write&#x60;
570
- # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
570
+ # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
571
571
  # @param [Hash] opts the optional parameters
572
572
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
573
573
  def delete_catalog_item_with_http_info(id, opts = {})
@@ -587,7 +587,7 @@ module KlaviyoAPI
587
587
  # header parameters
588
588
  header_params = opts[:header_params] || {}
589
589
  # klaviyo api revision
590
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
590
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
591
591
  # HTTP header 'Accept' (if needed)
592
592
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
593
593
 
@@ -669,7 +669,7 @@ module KlaviyoAPI
669
669
  # header parameters
670
670
  header_params = opts[:header_params] || {}
671
671
  # klaviyo api revision
672
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
672
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
673
673
  # HTTP header 'Accept' (if needed)
674
674
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
675
675
  # HTTP header 'Content-Type'
@@ -709,7 +709,7 @@ module KlaviyoAPI
709
709
 
710
710
  # Delete Catalog Variant
711
711
  # Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
712
- # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
712
+ # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
713
713
  # @param [Hash] opts the optional parameters
714
714
  # @return [nil]
715
715
  def delete_catalog_variant(id, opts = {})
@@ -719,7 +719,7 @@ module KlaviyoAPI
719
719
 
720
720
  # Delete Catalog Variant
721
721
  # Delete a catalog item variant with the given variant 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;Catalogs Write&#x60;
722
- # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
722
+ # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
723
723
  # @param [Hash] opts the optional parameters
724
724
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
725
725
  def delete_catalog_variant_with_http_info(id, opts = {})
@@ -739,7 +739,7 @@ module KlaviyoAPI
739
739
  # header parameters
740
740
  header_params = opts[:header_params] || {}
741
741
  # klaviyo api revision
742
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
742
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
743
743
  # HTTP header 'Accept' (if needed)
744
744
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
745
745
 
@@ -775,10 +775,10 @@ module KlaviyoAPI
775
775
  # Get Catalog Categories
776
776
  # Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
777
777
  # @param [Hash] opts the optional parameters
778
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
779
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
780
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
781
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
778
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
779
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
780
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
781
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
782
782
  # @return [Hash<String, Object>]
783
783
  def get_catalog_categories(opts = {})
784
784
  data, _status_code, _headers = get_catalog_categories_with_http_info(opts)
@@ -788,10 +788,10 @@ module KlaviyoAPI
788
788
  # Get Catalog Categories
789
789
  # Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Returns a maximum of 100 categories per request.&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;Catalogs Read&#x60;
790
790
  # @param [Hash] opts the optional parameters
791
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
792
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
793
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
794
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
791
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
792
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
793
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
794
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
795
795
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
796
796
  def get_catalog_categories_with_http_info(opts = {})
797
797
  if @api_client.config.debugging
@@ -818,7 +818,7 @@ module KlaviyoAPI
818
818
  # header parameters
819
819
  header_params = opts[:header_params] || {}
820
820
  # klaviyo api revision
821
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
821
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
822
822
  # HTTP header 'Accept' (if needed)
823
823
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
824
824
 
@@ -853,9 +853,9 @@ module KlaviyoAPI
853
853
 
854
854
  # Get Catalog Category
855
855
  # Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
856
- # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
856
+ # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
857
857
  # @param [Hash] opts the optional parameters
858
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
858
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
859
859
  # @return [Hash<String, Object>]
860
860
  def get_catalog_category(id, opts = {})
861
861
  data, _status_code, _headers = get_catalog_category_with_http_info(id, opts)
@@ -864,9 +864,9 @@ module KlaviyoAPI
864
864
 
865
865
  # Get Catalog Category
866
866
  # Get a catalog category with the given category 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;Catalogs Read&#x60;
867
- # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
867
+ # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
868
868
  # @param [Hash] opts the optional parameters
869
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
869
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
870
870
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
871
871
  def get_catalog_category_with_http_info(id, opts = {})
872
872
  if @api_client.config.debugging
@@ -890,7 +890,7 @@ module KlaviyoAPI
890
890
  # header parameters
891
891
  header_params = opts[:header_params] || {}
892
892
  # klaviyo api revision
893
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
893
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
894
894
  # HTTP header 'Accept' (if needed)
895
895
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
896
896
 
@@ -925,14 +925,14 @@ module KlaviyoAPI
925
925
 
926
926
  # Get Catalog Category Items
927
927
  # Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
928
- # @param category_id [String]
929
- # @param [Hash] opts the optional parameters
930
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
931
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
932
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
933
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
934
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
935
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
928
+ # @param category_id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
929
+ # @param [Hash] opts the optional parameters
930
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
931
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
932
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
933
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
934
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
935
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
936
936
  # @return [Hash<String, Object>]
937
937
  def get_catalog_category_items(category_id, opts = {})
938
938
  data, _status_code, _headers = get_catalog_category_items_with_http_info(category_id, opts)
@@ -941,14 +941,14 @@ module KlaviyoAPI
941
941
 
942
942
  # Get Catalog Category Items
943
943
  # Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Include parameters can be provided to get the following related resource data: &#x60;variants&#x60; Returns a maximum of 100 items per request.&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;Catalogs Read&#x60;
944
- # @param category_id [String]
945
- # @param [Hash] opts the optional parameters
946
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
947
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
948
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
949
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
950
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
951
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
944
+ # @param category_id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
945
+ # @param [Hash] opts the optional parameters
946
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
947
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
948
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
949
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
950
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
951
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
952
952
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
953
953
  def get_catalog_category_items_with_http_info(category_id, opts = {})
954
954
  if @api_client.config.debugging
@@ -958,7 +958,7 @@ module KlaviyoAPI
958
958
  if @api_client.config.client_side_validation && category_id.nil?
959
959
  fail ArgumentError, "Missing the required parameter 'category_id' when calling CatalogsApi.get_catalog_category_items"
960
960
  end
961
- allowable_values = ["external_id", "title", "description", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
961
+ allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
962
962
  if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
963
963
  fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
964
964
  end
@@ -989,7 +989,7 @@ module KlaviyoAPI
989
989
  # header parameters
990
990
  header_params = opts[:header_params] || {}
991
991
  # klaviyo api revision
992
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
992
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
993
993
  # HTTP header 'Accept' (if needed)
994
994
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
995
995
 
@@ -1027,7 +1027,7 @@ module KlaviyoAPI
1027
1027
  # @param id [String]
1028
1028
  # @param related_resource [String]
1029
1029
  # @param [Hash] opts the optional parameters
1030
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1030
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1031
1031
  # @return [Hash<String, Object>]
1032
1032
  def get_catalog_category_relationships(id, related_resource, opts = {})
1033
1033
  data, _status_code, _headers = get_catalog_category_relationships_with_http_info(id, related_resource, opts)
@@ -1039,7 +1039,7 @@ module KlaviyoAPI
1039
1039
  # @param id [String]
1040
1040
  # @param related_resource [String]
1041
1041
  # @param [Hash] opts the optional parameters
1042
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1042
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1043
1043
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1044
1044
  def get_catalog_category_relationships_with_http_info(id, related_resource, opts = {})
1045
1045
  if @api_client.config.debugging
@@ -1068,7 +1068,7 @@ module KlaviyoAPI
1068
1068
  # header parameters
1069
1069
  header_params = opts[:header_params] || {}
1070
1070
  # klaviyo api revision
1071
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1071
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1072
1072
  # HTTP header 'Accept' (if needed)
1073
1073
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1074
1074
 
@@ -1103,11 +1103,11 @@ module KlaviyoAPI
1103
1103
 
1104
1104
  # Get Catalog Item
1105
1105
  # Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1106
- # @param id [String]
1106
+ # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
1107
1107
  # @param [Hash] opts the optional parameters
1108
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1109
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1110
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1108
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1109
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1110
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1111
1111
  # @return [Hash<String, Object>]
1112
1112
  def get_catalog_item(id, opts = {})
1113
1113
  data, _status_code, _headers = get_catalog_item_with_http_info(id, opts)
@@ -1116,11 +1116,11 @@ module KlaviyoAPI
1116
1116
 
1117
1117
  # Get Catalog Item
1118
1118
  # Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: &#x60;variants&#x60;&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;Catalogs Read&#x60;
1119
- # @param id [String]
1119
+ # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
1120
1120
  # @param [Hash] opts the optional parameters
1121
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1122
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1123
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1121
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1122
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1123
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1124
1124
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1125
1125
  def get_catalog_item_with_http_info(id, opts = {})
1126
1126
  if @api_client.config.debugging
@@ -1130,7 +1130,7 @@ module KlaviyoAPI
1130
1130
  if @api_client.config.client_side_validation && id.nil?
1131
1131
  fail ArgumentError, "Missing the required parameter 'id' when calling CatalogsApi.get_catalog_item"
1132
1132
  end
1133
- allowable_values = ["external_id", "title", "description", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
1133
+ allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
1134
1134
  if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
1135
1135
  fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
1136
1136
  end
@@ -1154,7 +1154,7 @@ module KlaviyoAPI
1154
1154
  # header parameters
1155
1155
  header_params = opts[:header_params] || {}
1156
1156
  # klaviyo api revision
1157
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1157
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1158
1158
  # HTTP header 'Accept' (if needed)
1159
1159
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1160
1160
 
@@ -1189,12 +1189,12 @@ module KlaviyoAPI
1189
1189
 
1190
1190
  # Get Catalog Item Categories
1191
1191
  # Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1192
- # @param item_id [String]
1192
+ # @param item_id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
1193
1193
  # @param [Hash] opts the optional parameters
1194
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1195
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
1196
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1197
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1194
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1195
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
1196
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1197
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1198
1198
  # @return [Hash<String, Object>]
1199
1199
  def get_catalog_item_categories(item_id, opts = {})
1200
1200
  data, _status_code, _headers = get_catalog_item_categories_with_http_info(item_id, opts)
@@ -1203,12 +1203,12 @@ module KlaviyoAPI
1203
1203
 
1204
1204
  # Get Catalog Item Categories
1205
1205
  # Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Returns a maximum of 100 categories per request.&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;Catalogs Read&#x60;
1206
- # @param item_id [String]
1206
+ # @param item_id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
1207
1207
  # @param [Hash] opts the optional parameters
1208
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1209
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
1210
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1211
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1208
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1209
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
1210
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1211
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1212
1212
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1213
1213
  def get_catalog_item_categories_with_http_info(item_id, opts = {})
1214
1214
  if @api_client.config.debugging
@@ -1239,7 +1239,7 @@ module KlaviyoAPI
1239
1239
  # header parameters
1240
1240
  header_params = opts[:header_params] || {}
1241
1241
  # klaviyo api revision
1242
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1242
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1243
1243
  # HTTP header 'Accept' (if needed)
1244
1244
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1245
1245
 
@@ -1277,7 +1277,7 @@ module KlaviyoAPI
1277
1277
  # @param id [String]
1278
1278
  # @param related_resource [String]
1279
1279
  # @param [Hash] opts the optional parameters
1280
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1280
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1281
1281
  # @return [Hash<String, Object>]
1282
1282
  def get_catalog_item_relationships(id, related_resource, opts = {})
1283
1283
  data, _status_code, _headers = get_catalog_item_relationships_with_http_info(id, related_resource, opts)
@@ -1289,7 +1289,7 @@ module KlaviyoAPI
1289
1289
  # @param id [String]
1290
1290
  # @param related_resource [String]
1291
1291
  # @param [Hash] opts the optional parameters
1292
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1292
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1293
1293
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1294
1294
  def get_catalog_item_relationships_with_http_info(id, related_resource, opts = {})
1295
1295
  if @api_client.config.debugging
@@ -1318,7 +1318,7 @@ module KlaviyoAPI
1318
1318
  # header parameters
1319
1319
  header_params = opts[:header_params] || {}
1320
1320
  # klaviyo api revision
1321
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1321
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1322
1322
  # HTTP header 'Accept' (if needed)
1323
1323
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1324
1324
 
@@ -1353,12 +1353,12 @@ module KlaviyoAPI
1353
1353
 
1354
1354
  # Get Catalog Item Variants
1355
1355
  # Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1356
- # @param item_id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
1356
+ # @param item_id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
1357
1357
  # @param [Hash] opts the optional parameters
1358
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1359
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1360
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1361
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1358
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1359
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1360
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1361
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1362
1362
  # @return [Hash<String, Object>]
1363
1363
  def get_catalog_item_variants(item_id, opts = {})
1364
1364
  data, _status_code, _headers = get_catalog_item_variants_with_http_info(item_id, opts)
@@ -1367,12 +1367,12 @@ module KlaviyoAPI
1367
1367
 
1368
1368
  # Get Catalog Item Variants
1369
1369
  # Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Returns a maximum of 100 variants per request.&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;Catalogs Read&#x60;
1370
- # @param item_id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
1370
+ # @param item_id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
1371
1371
  # @param [Hash] opts the optional parameters
1372
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1373
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1374
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1375
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1372
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1373
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1374
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1375
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1376
1376
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1377
1377
  def get_catalog_item_variants_with_http_info(item_id, opts = {})
1378
1378
  if @api_client.config.debugging
@@ -1403,7 +1403,7 @@ module KlaviyoAPI
1403
1403
  # header parameters
1404
1404
  header_params = opts[:header_params] || {}
1405
1405
  # klaviyo api revision
1406
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1406
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1407
1407
  # HTTP header 'Accept' (if needed)
1408
1408
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1409
1409
 
@@ -1439,12 +1439,12 @@ module KlaviyoAPI
1439
1439
  # Get Catalog Items
1440
1440
  # Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1441
1441
  # @param [Hash] opts the optional parameters
1442
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1443
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1444
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1445
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1446
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1447
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1442
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1443
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1444
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1445
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1446
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1447
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1448
1448
  # @return [Hash<String, Object>]
1449
1449
  def get_catalog_items(opts = {})
1450
1450
  data, _status_code, _headers = get_catalog_items_with_http_info(opts)
@@ -1454,18 +1454,18 @@ module KlaviyoAPI
1454
1454
  # Get Catalog Items
1455
1455
  # Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Include parameters can be provided to get the following related resource data: &#x60;variants&#x60; Returns a maximum of 100 items per request.&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;Catalogs Read&#x60;
1456
1456
  # @param [Hash] opts the optional parameters
1457
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1458
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1459
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1460
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1461
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1462
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1457
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1458
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1459
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;category&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1460
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1461
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1462
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1463
1463
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1464
1464
  def get_catalog_items_with_http_info(opts = {})
1465
1465
  if @api_client.config.debugging
1466
1466
  @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_items ...'
1467
1467
  end
1468
- allowable_values = ["external_id", "title", "description", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
1468
+ allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
1469
1469
  if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
1470
1470
  fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
1471
1471
  end
@@ -1496,7 +1496,7 @@ module KlaviyoAPI
1496
1496
  # header parameters
1497
1497
  header_params = opts[:header_params] || {}
1498
1498
  # klaviyo api revision
1499
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1499
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1500
1500
  # HTTP header 'Accept' (if needed)
1501
1501
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1502
1502
 
@@ -1531,9 +1531,9 @@ module KlaviyoAPI
1531
1531
 
1532
1532
  # Get Catalog Variant
1533
1533
  # Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1534
- # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
1534
+ # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
1535
1535
  # @param [Hash] opts the optional parameters
1536
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1536
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1537
1537
  # @return [Hash<String, Object>]
1538
1538
  def get_catalog_variant(id, opts = {})
1539
1539
  data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts)
@@ -1542,9 +1542,9 @@ module KlaviyoAPI
1542
1542
 
1543
1543
  # Get Catalog Variant
1544
1544
  # Get a catalog item variant with the given variant 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;Catalogs Read&#x60;
1545
- # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
1545
+ # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
1546
1546
  # @param [Hash] opts the optional parameters
1547
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1547
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1548
1548
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1549
1549
  def get_catalog_variant_with_http_info(id, opts = {})
1550
1550
  if @api_client.config.debugging
@@ -1568,7 +1568,7 @@ module KlaviyoAPI
1568
1568
  # header parameters
1569
1569
  header_params = opts[:header_params] || {}
1570
1570
  # klaviyo api revision
1571
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1571
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1572
1572
  # HTTP header 'Accept' (if needed)
1573
1573
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1574
1574
 
@@ -1604,10 +1604,10 @@ module KlaviyoAPI
1604
1604
  # Get Catalog Variants
1605
1605
  # Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1606
1606
  # @param [Hash] opts the optional parameters
1607
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1608
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1609
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1610
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1607
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1608
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1609
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1610
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1611
1611
  # @return [Hash<String, Object>]
1612
1612
  def get_catalog_variants(opts = {})
1613
1613
  data, _status_code, _headers = get_catalog_variants_with_http_info(opts)
@@ -1617,10 +1617,10 @@ module KlaviyoAPI
1617
1617
  # Get Catalog Variants
1618
1618
  # Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Returns a maximum of 100 variants per request.&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;Catalogs Read&#x60;
1619
1619
  # @param [Hash] opts the optional parameters
1620
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1621
- # @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;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1622
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1623
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1620
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1621
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
1622
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1623
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1624
1624
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1625
1625
  def get_catalog_variants_with_http_info(opts = {})
1626
1626
  if @api_client.config.debugging
@@ -1647,7 +1647,7 @@ module KlaviyoAPI
1647
1647
  # header parameters
1648
1648
  header_params = opts[:header_params] || {}
1649
1649
  # klaviyo api revision
1650
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1650
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1651
1651
  # HTTP header 'Accept' (if needed)
1652
1652
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1653
1653
 
@@ -1681,12 +1681,12 @@ module KlaviyoAPI
1681
1681
  end
1682
1682
 
1683
1683
  # Get Create Categories Job
1684
- # Get a catalog category bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: `categories`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1685
- # @param job_id [String]
1684
+ # Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1685
+ # @param job_id [String] ID of the job to retrieve.
1686
1686
  # @param [Hash] opts the optional parameters
1687
- # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1688
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1689
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1687
+ # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1688
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1689
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1690
1690
  # @return [Hash<String, Object>]
1691
1691
  def get_create_categories_job(job_id, opts = {})
1692
1692
  data, _status_code, _headers = get_create_categories_job_with_http_info(job_id, opts)
@@ -1694,12 +1694,12 @@ module KlaviyoAPI
1694
1694
  end
1695
1695
 
1696
1696
  # Get Create Categories Job
1697
- # Get a catalog category bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;categories&#x60;&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;Catalogs Read&#x60;
1698
- # @param job_id [String]
1697
+ # Get a catalog category bulk create job with the given job ID. An &#x60;include&#x60; parameter can be provided to get the following related resource data: &#x60;categories&#x60;.&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;Catalogs Read&#x60;
1698
+ # @param job_id [String] ID of the job to retrieve.
1699
1699
  # @param [Hash] opts the optional parameters
1700
- # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1701
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1702
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1700
+ # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1701
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1702
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1703
1703
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1704
1704
  def get_create_categories_job_with_http_info(job_id, opts = {})
1705
1705
  if @api_client.config.debugging
@@ -1733,7 +1733,7 @@ module KlaviyoAPI
1733
1733
  # header parameters
1734
1734
  header_params = opts[:header_params] || {}
1735
1735
  # klaviyo api revision
1736
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1736
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1737
1737
  # HTTP header 'Accept' (if needed)
1738
1738
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1739
1739
 
@@ -1769,9 +1769,9 @@ module KlaviyoAPI
1769
1769
  # Get Create Categories Jobs
1770
1770
  # Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1771
1771
  # @param [Hash] opts the optional parameters
1772
- # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1773
- # @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;status&#x60;: &#x60;equals&#x60;
1774
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1772
+ # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1773
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
1774
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1775
1775
  # @return [Hash<String, Object>]
1776
1776
  def get_create_categories_jobs(opts = {})
1777
1777
  data, _status_code, _headers = get_create_categories_jobs_with_http_info(opts)
@@ -1781,9 +1781,9 @@ module KlaviyoAPI
1781
1781
  # Get Create Categories Jobs
1782
1782
  # Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
1783
1783
  # @param [Hash] opts the optional parameters
1784
- # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1785
- # @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;status&#x60;: &#x60;equals&#x60;
1786
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1784
+ # @option opts [Array<String>] :fields_catalog_category_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1785
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
1786
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1787
1787
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1788
1788
  def get_create_categories_jobs_with_http_info(opts = {})
1789
1789
  if @api_client.config.debugging
@@ -1805,7 +1805,7 @@ module KlaviyoAPI
1805
1805
  # header parameters
1806
1806
  header_params = opts[:header_params] || {}
1807
1807
  # klaviyo api revision
1808
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1808
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1809
1809
  # HTTP header 'Accept' (if needed)
1810
1810
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1811
1811
 
@@ -1839,12 +1839,12 @@ module KlaviyoAPI
1839
1839
  end
1840
1840
 
1841
1841
  # Get Create Items Job
1842
- # Get a catalog item bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: `items`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1843
- # @param job_id [String]
1842
+ # Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1843
+ # @param job_id [String] ID of the job to retrieve.
1844
1844
  # @param [Hash] opts the optional parameters
1845
- # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1846
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1847
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1845
+ # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1846
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1847
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1848
1848
  # @return [Hash<String, Object>]
1849
1849
  def get_create_items_job(job_id, opts = {})
1850
1850
  data, _status_code, _headers = get_create_items_job_with_http_info(job_id, opts)
@@ -1852,12 +1852,12 @@ module KlaviyoAPI
1852
1852
  end
1853
1853
 
1854
1854
  # Get Create Items Job
1855
- # Get a catalog item bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;items&#x60;&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;Catalogs Read&#x60;
1856
- # @param job_id [String]
1855
+ # Get a catalog item bulk create job with the given job ID. An &#x60;include&#x60; parameter can be provided to get the following related resource data: &#x60;items&#x60;.&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;Catalogs Read&#x60;
1856
+ # @param job_id [String] ID of the job to retrieve.
1857
1857
  # @param [Hash] opts the optional parameters
1858
- # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1859
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1860
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1858
+ # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1859
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1860
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1861
1861
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1862
1862
  def get_create_items_job_with_http_info(job_id, opts = {})
1863
1863
  if @api_client.config.debugging
@@ -1871,7 +1871,7 @@ module KlaviyoAPI
1871
1871
  if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_create_job'] && !opts[:'fields_catalog_item_bulk_create_job'].all? { |item| allowable_values.include?(item) }
1872
1872
  fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_create_job\", must include one of #{allowable_values}"
1873
1873
  end
1874
- allowable_values = ["external_id", "title", "description", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
1874
+ allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
1875
1875
  if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
1876
1876
  fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
1877
1877
  end
@@ -1891,7 +1891,7 @@ module KlaviyoAPI
1891
1891
  # header parameters
1892
1892
  header_params = opts[:header_params] || {}
1893
1893
  # klaviyo api revision
1894
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1894
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1895
1895
  # HTTP header 'Accept' (if needed)
1896
1896
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1897
1897
 
@@ -1927,9 +1927,9 @@ module KlaviyoAPI
1927
1927
  # Get Create Items Jobs
1928
1928
  # Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1929
1929
  # @param [Hash] opts the optional parameters
1930
- # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1931
- # @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;status&#x60;: &#x60;equals&#x60;
1932
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1930
+ # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1931
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
1932
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1933
1933
  # @return [Hash<String, Object>]
1934
1934
  def get_create_items_jobs(opts = {})
1935
1935
  data, _status_code, _headers = get_create_items_jobs_with_http_info(opts)
@@ -1939,9 +1939,9 @@ module KlaviyoAPI
1939
1939
  # Get Create Items Jobs
1940
1940
  # Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
1941
1941
  # @param [Hash] opts the optional parameters
1942
- # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1943
- # @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;status&#x60;: &#x60;equals&#x60;
1944
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1942
+ # @option opts [Array<String>] :fields_catalog_item_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1943
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
1944
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1945
1945
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1946
1946
  def get_create_items_jobs_with_http_info(opts = {})
1947
1947
  if @api_client.config.debugging
@@ -1963,7 +1963,7 @@ module KlaviyoAPI
1963
1963
  # header parameters
1964
1964
  header_params = opts[:header_params] || {}
1965
1965
  # klaviyo api revision
1966
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
1966
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
1967
1967
  # HTTP header 'Accept' (if needed)
1968
1968
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1969
1969
 
@@ -1997,12 +1997,12 @@ module KlaviyoAPI
1997
1997
  end
1998
1998
 
1999
1999
  # Get Create Variants Job
2000
- # Get a catalog variant bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2001
- # @param job_id [String]
2000
+ # Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2001
+ # @param job_id [String] ID of the job to retrieve.
2002
2002
  # @param [Hash] opts the optional parameters
2003
- # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2004
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2005
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2003
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2004
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2005
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2006
2006
  # @return [Hash<String, Object>]
2007
2007
  def get_create_variants_job(job_id, opts = {})
2008
2008
  data, _status_code, _headers = get_create_variants_job_with_http_info(job_id, opts)
@@ -2010,12 +2010,12 @@ module KlaviyoAPI
2010
2010
  end
2011
2011
 
2012
2012
  # Get Create Variants Job
2013
- # Get a catalog variant bulk create job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;variants&#x60;.&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;Catalogs Read&#x60;
2014
- # @param job_id [String]
2013
+ # Get a catalog variant bulk create job with the given job ID. An &#x60;include&#x60; parameter can be provided to get the following related resource data: &#x60;variants&#x60;.&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;Catalogs Read&#x60;
2014
+ # @param job_id [String] ID of the job to retrieve.
2015
2015
  # @param [Hash] opts the optional parameters
2016
- # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2017
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2018
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2016
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2017
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2018
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2019
2019
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2020
2020
  def get_create_variants_job_with_http_info(job_id, opts = {})
2021
2021
  if @api_client.config.debugging
@@ -2049,7 +2049,7 @@ module KlaviyoAPI
2049
2049
  # header parameters
2050
2050
  header_params = opts[:header_params] || {}
2051
2051
  # klaviyo api revision
2052
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2052
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2053
2053
  # HTTP header 'Accept' (if needed)
2054
2054
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2055
2055
 
@@ -2085,9 +2085,9 @@ module KlaviyoAPI
2085
2085
  # Get Create Variants Jobs
2086
2086
  # Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2087
2087
  # @param [Hash] opts the optional parameters
2088
- # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2089
- # @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;status&#x60;: &#x60;equals&#x60;
2090
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2088
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2089
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2090
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2091
2091
  # @return [Hash<String, Object>]
2092
2092
  def get_create_variants_jobs(opts = {})
2093
2093
  data, _status_code, _headers = get_create_variants_jobs_with_http_info(opts)
@@ -2097,9 +2097,9 @@ module KlaviyoAPI
2097
2097
  # Get Create Variants Jobs
2098
2098
  # Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
2099
2099
  # @param [Hash] opts the optional parameters
2100
- # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2101
- # @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;status&#x60;: &#x60;equals&#x60;
2102
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2100
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2101
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2102
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2103
2103
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2104
2104
  def get_create_variants_jobs_with_http_info(opts = {})
2105
2105
  if @api_client.config.debugging
@@ -2121,7 +2121,7 @@ module KlaviyoAPI
2121
2121
  # header parameters
2122
2122
  header_params = opts[:header_params] || {}
2123
2123
  # klaviyo api revision
2124
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2124
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2125
2125
  # HTTP header 'Accept' (if needed)
2126
2126
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2127
2127
 
@@ -2156,9 +2156,9 @@ module KlaviyoAPI
2156
2156
 
2157
2157
  # Get Delete Categories Job
2158
2158
  # Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2159
- # @param job_id [String]
2159
+ # @param job_id [String] ID of the job to retrieve.
2160
2160
  # @param [Hash] opts the optional parameters
2161
- # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2161
+ # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2162
2162
  # @return [Hash<String, Object>]
2163
2163
  def get_delete_categories_job(job_id, opts = {})
2164
2164
  data, _status_code, _headers = get_delete_categories_job_with_http_info(job_id, opts)
@@ -2167,9 +2167,9 @@ module KlaviyoAPI
2167
2167
 
2168
2168
  # Get Delete Categories Job
2169
2169
  # Get a catalog category bulk delete job with the given job 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;Catalogs Read&#x60;
2170
- # @param job_id [String]
2170
+ # @param job_id [String] ID of the job to retrieve.
2171
2171
  # @param [Hash] opts the optional parameters
2172
- # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2172
+ # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2173
2173
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2174
2174
  def get_delete_categories_job_with_http_info(job_id, opts = {})
2175
2175
  if @api_client.config.debugging
@@ -2193,7 +2193,7 @@ module KlaviyoAPI
2193
2193
  # header parameters
2194
2194
  header_params = opts[:header_params] || {}
2195
2195
  # klaviyo api revision
2196
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2196
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2197
2197
  # HTTP header 'Accept' (if needed)
2198
2198
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2199
2199
 
@@ -2229,9 +2229,9 @@ module KlaviyoAPI
2229
2229
  # Get Delete Categories Jobs
2230
2230
  # Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2231
2231
  # @param [Hash] opts the optional parameters
2232
- # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2233
- # @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;status&#x60;: &#x60;equals&#x60;
2234
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2232
+ # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2233
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2234
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2235
2235
  # @return [Hash<String, Object>]
2236
2236
  def get_delete_categories_jobs(opts = {})
2237
2237
  data, _status_code, _headers = get_delete_categories_jobs_with_http_info(opts)
@@ -2241,9 +2241,9 @@ module KlaviyoAPI
2241
2241
  # Get Delete Categories Jobs
2242
2242
  # Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
2243
2243
  # @param [Hash] opts the optional parameters
2244
- # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2245
- # @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;status&#x60;: &#x60;equals&#x60;
2246
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2244
+ # @option opts [Array<String>] :fields_catalog_category_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2245
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2246
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2247
2247
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2248
2248
  def get_delete_categories_jobs_with_http_info(opts = {})
2249
2249
  if @api_client.config.debugging
@@ -2265,7 +2265,7 @@ module KlaviyoAPI
2265
2265
  # header parameters
2266
2266
  header_params = opts[:header_params] || {}
2267
2267
  # klaviyo api revision
2268
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2268
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2269
2269
  # HTTP header 'Accept' (if needed)
2270
2270
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2271
2271
 
@@ -2300,9 +2300,9 @@ module KlaviyoAPI
2300
2300
 
2301
2301
  # Get Delete Items Job
2302
2302
  # Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2303
- # @param job_id [String]
2303
+ # @param job_id [String] ID of the job to retrieve.
2304
2304
  # @param [Hash] opts the optional parameters
2305
- # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2305
+ # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2306
2306
  # @return [Hash<String, Object>]
2307
2307
  def get_delete_items_job(job_id, opts = {})
2308
2308
  data, _status_code, _headers = get_delete_items_job_with_http_info(job_id, opts)
@@ -2311,9 +2311,9 @@ module KlaviyoAPI
2311
2311
 
2312
2312
  # Get Delete Items Job
2313
2313
  # Get a catalog item bulk delete job with the given job 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;Catalogs Read&#x60;
2314
- # @param job_id [String]
2314
+ # @param job_id [String] ID of the job to retrieve.
2315
2315
  # @param [Hash] opts the optional parameters
2316
- # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2316
+ # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2317
2317
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2318
2318
  def get_delete_items_job_with_http_info(job_id, opts = {})
2319
2319
  if @api_client.config.debugging
@@ -2337,7 +2337,7 @@ module KlaviyoAPI
2337
2337
  # header parameters
2338
2338
  header_params = opts[:header_params] || {}
2339
2339
  # klaviyo api revision
2340
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2340
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2341
2341
  # HTTP header 'Accept' (if needed)
2342
2342
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2343
2343
 
@@ -2373,9 +2373,9 @@ module KlaviyoAPI
2373
2373
  # Get Delete Items Jobs
2374
2374
  # Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2375
2375
  # @param [Hash] opts the optional parameters
2376
- # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2377
- # @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;status&#x60;: &#x60;equals&#x60;
2378
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2376
+ # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2377
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2378
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2379
2379
  # @return [Hash<String, Object>]
2380
2380
  def get_delete_items_jobs(opts = {})
2381
2381
  data, _status_code, _headers = get_delete_items_jobs_with_http_info(opts)
@@ -2385,9 +2385,9 @@ module KlaviyoAPI
2385
2385
  # Get Delete Items Jobs
2386
2386
  # Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
2387
2387
  # @param [Hash] opts the optional parameters
2388
- # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2389
- # @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;status&#x60;: &#x60;equals&#x60;
2390
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2388
+ # @option opts [Array<String>] :fields_catalog_item_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2389
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2390
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2391
2391
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2392
2392
  def get_delete_items_jobs_with_http_info(opts = {})
2393
2393
  if @api_client.config.debugging
@@ -2409,7 +2409,7 @@ module KlaviyoAPI
2409
2409
  # header parameters
2410
2410
  header_params = opts[:header_params] || {}
2411
2411
  # klaviyo api revision
2412
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2412
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2413
2413
  # HTTP header 'Accept' (if needed)
2414
2414
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2415
2415
 
@@ -2444,9 +2444,9 @@ module KlaviyoAPI
2444
2444
 
2445
2445
  # Get Delete Variants Job
2446
2446
  # Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2447
- # @param job_id [String]
2447
+ # @param job_id [String] ID of the job to retrieve.
2448
2448
  # @param [Hash] opts the optional parameters
2449
- # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2449
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2450
2450
  # @return [Hash<String, Object>]
2451
2451
  def get_delete_variants_job(job_id, opts = {})
2452
2452
  data, _status_code, _headers = get_delete_variants_job_with_http_info(job_id, opts)
@@ -2455,9 +2455,9 @@ module KlaviyoAPI
2455
2455
 
2456
2456
  # Get Delete Variants Job
2457
2457
  # Get a catalog variant bulk delete job with the given job 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;Catalogs Read&#x60;
2458
- # @param job_id [String]
2458
+ # @param job_id [String] ID of the job to retrieve.
2459
2459
  # @param [Hash] opts the optional parameters
2460
- # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2460
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2461
2461
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2462
2462
  def get_delete_variants_job_with_http_info(job_id, opts = {})
2463
2463
  if @api_client.config.debugging
@@ -2481,7 +2481,7 @@ module KlaviyoAPI
2481
2481
  # header parameters
2482
2482
  header_params = opts[:header_params] || {}
2483
2483
  # klaviyo api revision
2484
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2484
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2485
2485
  # HTTP header 'Accept' (if needed)
2486
2486
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2487
2487
 
@@ -2517,9 +2517,9 @@ module KlaviyoAPI
2517
2517
  # Get Delete Variants Jobs
2518
2518
  # Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2519
2519
  # @param [Hash] opts the optional parameters
2520
- # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2521
- # @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;status&#x60;: &#x60;equals&#x60;
2522
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2520
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2521
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2522
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2523
2523
  # @return [Hash<String, Object>]
2524
2524
  def get_delete_variants_jobs(opts = {})
2525
2525
  data, _status_code, _headers = get_delete_variants_jobs_with_http_info(opts)
@@ -2529,9 +2529,9 @@ module KlaviyoAPI
2529
2529
  # Get Delete Variants Jobs
2530
2530
  # Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
2531
2531
  # @param [Hash] opts the optional parameters
2532
- # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2533
- # @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;status&#x60;: &#x60;equals&#x60;
2534
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2532
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2533
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2534
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2535
2535
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2536
2536
  def get_delete_variants_jobs_with_http_info(opts = {})
2537
2537
  if @api_client.config.debugging
@@ -2553,7 +2553,7 @@ module KlaviyoAPI
2553
2553
  # header parameters
2554
2554
  header_params = opts[:header_params] || {}
2555
2555
  # klaviyo api revision
2556
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2556
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2557
2557
  # HTTP header 'Accept' (if needed)
2558
2558
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2559
2559
 
@@ -2587,12 +2587,12 @@ module KlaviyoAPI
2587
2587
  end
2588
2588
 
2589
2589
  # Get Update Categories Job
2590
- # Get a catalog category bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: `categories`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2591
- # @param job_id [String]
2590
+ # Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2591
+ # @param job_id [String] ID of the job to retrieve.
2592
2592
  # @param [Hash] opts the optional parameters
2593
- # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2594
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2595
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2593
+ # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2594
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2595
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2596
2596
  # @return [Hash<String, Object>]
2597
2597
  def get_update_categories_job(job_id, opts = {})
2598
2598
  data, _status_code, _headers = get_update_categories_job_with_http_info(job_id, opts)
@@ -2600,12 +2600,12 @@ module KlaviyoAPI
2600
2600
  end
2601
2601
 
2602
2602
  # Get Update Categories Job
2603
- # Get a catalog category bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;categories&#x60;&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;Catalogs Read&#x60;
2604
- # @param job_id [String]
2603
+ # Get a catalog category bulk update job with the given job ID. An &#x60;include&#x60; parameter can be provided to get the following related resource data: &#x60;categories&#x60;.&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;Catalogs Read&#x60;
2604
+ # @param job_id [String] ID of the job to retrieve.
2605
2605
  # @param [Hash] opts the optional parameters
2606
- # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2607
- # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2608
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2606
+ # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2607
+ # @option opts [Array<String>] :fields_catalog_category For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2608
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2609
2609
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2610
2610
  def get_update_categories_job_with_http_info(job_id, opts = {})
2611
2611
  if @api_client.config.debugging
@@ -2639,7 +2639,7 @@ module KlaviyoAPI
2639
2639
  # header parameters
2640
2640
  header_params = opts[:header_params] || {}
2641
2641
  # klaviyo api revision
2642
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2642
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2643
2643
  # HTTP header 'Accept' (if needed)
2644
2644
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2645
2645
 
@@ -2675,9 +2675,9 @@ module KlaviyoAPI
2675
2675
  # Get Update Categories Jobs
2676
2676
  # Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2677
2677
  # @param [Hash] opts the optional parameters
2678
- # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2679
- # @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;status&#x60;: &#x60;equals&#x60;
2680
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2678
+ # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2679
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2680
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2681
2681
  # @return [Hash<String, Object>]
2682
2682
  def get_update_categories_jobs(opts = {})
2683
2683
  data, _status_code, _headers = get_update_categories_jobs_with_http_info(opts)
@@ -2687,9 +2687,9 @@ module KlaviyoAPI
2687
2687
  # Get Update Categories Jobs
2688
2688
  # Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
2689
2689
  # @param [Hash] opts the optional parameters
2690
- # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2691
- # @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;status&#x60;: &#x60;equals&#x60;
2692
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2690
+ # @option opts [Array<String>] :fields_catalog_category_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2691
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2692
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2693
2693
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2694
2694
  def get_update_categories_jobs_with_http_info(opts = {})
2695
2695
  if @api_client.config.debugging
@@ -2711,7 +2711,7 @@ module KlaviyoAPI
2711
2711
  # header parameters
2712
2712
  header_params = opts[:header_params] || {}
2713
2713
  # klaviyo api revision
2714
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2714
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2715
2715
  # HTTP header 'Accept' (if needed)
2716
2716
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2717
2717
 
@@ -2745,12 +2745,12 @@ module KlaviyoAPI
2745
2745
  end
2746
2746
 
2747
2747
  # Get Update Items Job
2748
- # Get a catalog item bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: `items`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2749
- # @param job_id [String]
2748
+ # Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2749
+ # @param job_id [String] ID of the job to retrieve.
2750
2750
  # @param [Hash] opts the optional parameters
2751
- # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2752
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2753
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2751
+ # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2752
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2753
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2754
2754
  # @return [Hash<String, Object>]
2755
2755
  def get_update_items_job(job_id, opts = {})
2756
2756
  data, _status_code, _headers = get_update_items_job_with_http_info(job_id, opts)
@@ -2758,12 +2758,12 @@ module KlaviyoAPI
2758
2758
  end
2759
2759
 
2760
2760
  # Get Update Items Job
2761
- # Get a catalog item bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;items&#x60;&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;Catalogs Read&#x60;
2762
- # @param job_id [String]
2761
+ # Get a catalog item bulk update job with the given job ID. An &#x60;include&#x60; parameter can be provided to get the following related resource data: &#x60;items&#x60;.&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;Catalogs Read&#x60;
2762
+ # @param job_id [String] ID of the job to retrieve.
2763
2763
  # @param [Hash] opts the optional parameters
2764
- # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2765
- # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2766
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2764
+ # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2765
+ # @option opts [Array<String>] :fields_catalog_item For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2766
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2767
2767
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2768
2768
  def get_update_items_job_with_http_info(job_id, opts = {})
2769
2769
  if @api_client.config.debugging
@@ -2777,7 +2777,7 @@ module KlaviyoAPI
2777
2777
  if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_update_job'] && !opts[:'fields_catalog_item_bulk_update_job'].all? { |item| allowable_values.include?(item) }
2778
2778
  fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_update_job\", must include one of #{allowable_values}"
2779
2779
  end
2780
- allowable_values = ["external_id", "title", "description", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
2780
+ allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"]
2781
2781
  if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) }
2782
2782
  fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}"
2783
2783
  end
@@ -2797,7 +2797,7 @@ module KlaviyoAPI
2797
2797
  # header parameters
2798
2798
  header_params = opts[:header_params] || {}
2799
2799
  # klaviyo api revision
2800
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2800
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2801
2801
  # HTTP header 'Accept' (if needed)
2802
2802
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2803
2803
 
@@ -2833,9 +2833,9 @@ module KlaviyoAPI
2833
2833
  # Get Update Items Jobs
2834
2834
  # Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2835
2835
  # @param [Hash] opts the optional parameters
2836
- # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2837
- # @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;status&#x60;: &#x60;equals&#x60;
2838
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2836
+ # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2837
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2838
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2839
2839
  # @return [Hash<String, Object>]
2840
2840
  def get_update_items_jobs(opts = {})
2841
2841
  data, _status_code, _headers = get_update_items_jobs_with_http_info(opts)
@@ -2845,9 +2845,9 @@ module KlaviyoAPI
2845
2845
  # Get Update Items Jobs
2846
2846
  # Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
2847
2847
  # @param [Hash] opts the optional parameters
2848
- # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2849
- # @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;status&#x60;: &#x60;equals&#x60;
2850
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2848
+ # @option opts [Array<String>] :fields_catalog_item_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2849
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2850
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2851
2851
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2852
2852
  def get_update_items_jobs_with_http_info(opts = {})
2853
2853
  if @api_client.config.debugging
@@ -2869,7 +2869,7 @@ module KlaviyoAPI
2869
2869
  # header parameters
2870
2870
  header_params = opts[:header_params] || {}
2871
2871
  # klaviyo api revision
2872
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2872
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2873
2873
  # HTTP header 'Accept' (if needed)
2874
2874
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2875
2875
 
@@ -2903,12 +2903,12 @@ module KlaviyoAPI
2903
2903
  end
2904
2904
 
2905
2905
  # Get Update Variants Job
2906
- # Get a catalog variate bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2907
- # @param job_id [String]
2906
+ # Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2907
+ # @param job_id [String] ID of the job to retrieve.
2908
2908
  # @param [Hash] opts the optional parameters
2909
- # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2910
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2911
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2909
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2910
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2911
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2912
2912
  # @return [Hash<String, Object>]
2913
2913
  def get_update_variants_job(job_id, opts = {})
2914
2914
  data, _status_code, _headers = get_update_variants_job_with_http_info(job_id, opts)
@@ -2916,12 +2916,12 @@ module KlaviyoAPI
2916
2916
  end
2917
2917
 
2918
2918
  # Get Update Variants Job
2919
- # Get a catalog variate bulk update job with the given job ID. Include parameters can be provided to get the following related resource data: &#x60;variants&#x60;.&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;Catalogs Read&#x60;
2920
- # @param job_id [String]
2919
+ # Get a catalog variate bulk update job with the given job ID. An &#x60;include&#x60; parameter can be provided to get the following related resource data: &#x60;variants&#x60;.&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;Catalogs Read&#x60;
2920
+ # @param job_id [String] ID of the job to retrieve.
2921
2921
  # @param [Hash] opts the optional parameters
2922
- # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2923
- # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2924
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2922
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2923
+ # @option opts [Array<String>] :fields_catalog_variant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2924
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2925
2925
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
2926
2926
  def get_update_variants_job_with_http_info(job_id, opts = {})
2927
2927
  if @api_client.config.debugging
@@ -2955,7 +2955,7 @@ module KlaviyoAPI
2955
2955
  # header parameters
2956
2956
  header_params = opts[:header_params] || {}
2957
2957
  # klaviyo api revision
2958
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
2958
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
2959
2959
  # HTTP header 'Accept' (if needed)
2960
2960
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2961
2961
 
@@ -2991,9 +2991,9 @@ module KlaviyoAPI
2991
2991
  # Get Update Variants Jobs
2992
2992
  # Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
2993
2993
  # @param [Hash] opts the optional parameters
2994
- # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2995
- # @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;status&#x60;: &#x60;equals&#x60;
2996
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2994
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2995
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
2996
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2997
2997
  # @return [Hash<String, Object>]
2998
2998
  def get_update_variants_jobs(opts = {})
2999
2999
  data, _status_code, _headers = get_update_variants_jobs_with_http_info(opts)
@@ -3003,9 +3003,9 @@ module KlaviyoAPI
3003
3003
  # Get Update Variants Jobs
3004
3004
  # Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.&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;Catalogs Read&#x60;
3005
3005
  # @param [Hash] opts the optional parameters
3006
- # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
3007
- # @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;status&#x60;: &#x60;equals&#x60;
3008
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
3006
+ # @option opts [Array<String>] :fields_catalog_variant_bulk_update_job For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
3007
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;
3008
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
3009
3009
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
3010
3010
  def get_update_variants_jobs_with_http_info(opts = {})
3011
3011
  if @api_client.config.debugging
@@ -3027,7 +3027,7 @@ module KlaviyoAPI
3027
3027
  # header parameters
3028
3028
  header_params = opts[:header_params] || {}
3029
3029
  # klaviyo api revision
3030
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3030
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3031
3031
  # HTTP header 'Accept' (if needed)
3032
3032
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3033
3033
 
@@ -3061,7 +3061,7 @@ module KlaviyoAPI
3061
3061
  end
3062
3062
 
3063
3063
  # Spawn Create Categories Job
3064
- # Create a catalog category bulk create job to create a batch of catalog categories.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3064
+ # Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3065
3065
  # @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery]
3066
3066
  # @param [Hash] opts the optional parameters
3067
3067
  # @return [Hash<String, Object>]
@@ -3071,7 +3071,7 @@ module KlaviyoAPI
3071
3071
  end
3072
3072
 
3073
3073
  # Spawn Create Categories Job
3074
- # Create a catalog category bulk create job to create a batch of catalog categories.&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;Catalogs Write&#x60;
3074
+ # Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3075
3075
  # @param catalog_category_create_job_create_query [CatalogCategoryCreateJobCreateQuery]
3076
3076
  # @param [Hash] opts the optional parameters
3077
3077
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3092,7 +3092,7 @@ module KlaviyoAPI
3092
3092
  # header parameters
3093
3093
  header_params = opts[:header_params] || {}
3094
3094
  # klaviyo api revision
3095
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3095
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3096
3096
  # HTTP header 'Accept' (if needed)
3097
3097
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3098
3098
  # HTTP header 'Content-Type'
@@ -3131,7 +3131,7 @@ module KlaviyoAPI
3131
3131
  end
3132
3132
 
3133
3133
  # Spawn Create Items Job
3134
- # Create a catalog item bulk create job to create a batch of catalog items.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3134
+ # Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3135
3135
  # @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery]
3136
3136
  # @param [Hash] opts the optional parameters
3137
3137
  # @return [Hash<String, Object>]
@@ -3141,7 +3141,7 @@ module KlaviyoAPI
3141
3141
  end
3142
3142
 
3143
3143
  # Spawn Create Items Job
3144
- # Create a catalog item bulk create job to create a batch of catalog items.&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;Catalogs Write&#x60;
3144
+ # Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3145
3145
  # @param catalog_item_create_job_create_query [CatalogItemCreateJobCreateQuery]
3146
3146
  # @param [Hash] opts the optional parameters
3147
3147
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3162,7 +3162,7 @@ module KlaviyoAPI
3162
3162
  # header parameters
3163
3163
  header_params = opts[:header_params] || {}
3164
3164
  # klaviyo api revision
3165
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3165
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3166
3166
  # HTTP header 'Accept' (if needed)
3167
3167
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3168
3168
  # HTTP header 'Content-Type'
@@ -3201,7 +3201,7 @@ module KlaviyoAPI
3201
3201
  end
3202
3202
 
3203
3203
  # Spawn Create Variants Job
3204
- # Create a catalog variant bulk create job to create a batch of catalog variants.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3204
+ # Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3205
3205
  # @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery]
3206
3206
  # @param [Hash] opts the optional parameters
3207
3207
  # @return [Hash<String, Object>]
@@ -3211,7 +3211,7 @@ module KlaviyoAPI
3211
3211
  end
3212
3212
 
3213
3213
  # Spawn Create Variants Job
3214
- # Create a catalog variant bulk create job to create a batch of catalog variants.&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;Catalogs Write&#x60;
3214
+ # Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3215
3215
  # @param catalog_variant_create_job_create_query [CatalogVariantCreateJobCreateQuery]
3216
3216
  # @param [Hash] opts the optional parameters
3217
3217
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3232,7 +3232,7 @@ module KlaviyoAPI
3232
3232
  # header parameters
3233
3233
  header_params = opts[:header_params] || {}
3234
3234
  # klaviyo api revision
3235
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3235
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3236
3236
  # HTTP header 'Accept' (if needed)
3237
3237
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3238
3238
  # HTTP header 'Content-Type'
@@ -3271,7 +3271,7 @@ module KlaviyoAPI
3271
3271
  end
3272
3272
 
3273
3273
  # Spawn Delete Categories Job
3274
- # Create a catalog category bulk delete job to delete a batch of catalog categories.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3274
+ # Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3275
3275
  # @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery]
3276
3276
  # @param [Hash] opts the optional parameters
3277
3277
  # @return [Hash<String, Object>]
@@ -3281,7 +3281,7 @@ module KlaviyoAPI
3281
3281
  end
3282
3282
 
3283
3283
  # Spawn Delete Categories Job
3284
- # Create a catalog category bulk delete job to delete a batch of catalog categories.&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;Catalogs Write&#x60;
3284
+ # Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3285
3285
  # @param catalog_category_delete_job_create_query [CatalogCategoryDeleteJobCreateQuery]
3286
3286
  # @param [Hash] opts the optional parameters
3287
3287
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3302,7 +3302,7 @@ module KlaviyoAPI
3302
3302
  # header parameters
3303
3303
  header_params = opts[:header_params] || {}
3304
3304
  # klaviyo api revision
3305
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3305
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3306
3306
  # HTTP header 'Accept' (if needed)
3307
3307
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3308
3308
  # HTTP header 'Content-Type'
@@ -3341,7 +3341,7 @@ module KlaviyoAPI
3341
3341
  end
3342
3342
 
3343
3343
  # Spawn Delete Items Job
3344
- # Create a catalog item bulk delete job to delete a batch of catalog items.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3344
+ # Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3345
3345
  # @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery]
3346
3346
  # @param [Hash] opts the optional parameters
3347
3347
  # @return [Hash<String, Object>]
@@ -3351,7 +3351,7 @@ module KlaviyoAPI
3351
3351
  end
3352
3352
 
3353
3353
  # Spawn Delete Items Job
3354
- # Create a catalog item bulk delete job to delete a batch of catalog items.&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;Catalogs Write&#x60;
3354
+ # Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3355
3355
  # @param catalog_item_delete_job_create_query [CatalogItemDeleteJobCreateQuery]
3356
3356
  # @param [Hash] opts the optional parameters
3357
3357
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3372,7 +3372,7 @@ module KlaviyoAPI
3372
3372
  # header parameters
3373
3373
  header_params = opts[:header_params] || {}
3374
3374
  # klaviyo api revision
3375
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3375
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3376
3376
  # HTTP header 'Accept' (if needed)
3377
3377
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3378
3378
  # HTTP header 'Content-Type'
@@ -3411,7 +3411,7 @@ module KlaviyoAPI
3411
3411
  end
3412
3412
 
3413
3413
  # Spawn Delete Variants Job
3414
- # Create a catalog variant bulk delete job to delete a batch of catalog variants.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3414
+ # Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3415
3415
  # @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery]
3416
3416
  # @param [Hash] opts the optional parameters
3417
3417
  # @return [Hash<String, Object>]
@@ -3421,7 +3421,7 @@ module KlaviyoAPI
3421
3421
  end
3422
3422
 
3423
3423
  # Spawn Delete Variants Job
3424
- # Create a catalog variant bulk delete job to delete a batch of catalog variants.&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;Catalogs Write&#x60;
3424
+ # Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3425
3425
  # @param catalog_variant_delete_job_create_query [CatalogVariantDeleteJobCreateQuery]
3426
3426
  # @param [Hash] opts the optional parameters
3427
3427
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3442,7 +3442,7 @@ module KlaviyoAPI
3442
3442
  # header parameters
3443
3443
  header_params = opts[:header_params] || {}
3444
3444
  # klaviyo api revision
3445
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3445
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3446
3446
  # HTTP header 'Accept' (if needed)
3447
3447
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3448
3448
  # HTTP header 'Content-Type'
@@ -3481,7 +3481,7 @@ module KlaviyoAPI
3481
3481
  end
3482
3482
 
3483
3483
  # Spawn Update Categories Job
3484
- # Create a catalog category bulk update job to update a batch of catalog categories.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3484
+ # Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3485
3485
  # @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery]
3486
3486
  # @param [Hash] opts the optional parameters
3487
3487
  # @return [Hash<String, Object>]
@@ -3491,7 +3491,7 @@ module KlaviyoAPI
3491
3491
  end
3492
3492
 
3493
3493
  # Spawn Update Categories Job
3494
- # Create a catalog category bulk update job to update a batch of catalog categories.&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;Catalogs Write&#x60;
3494
+ # Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3495
3495
  # @param catalog_category_update_job_create_query [CatalogCategoryUpdateJobCreateQuery]
3496
3496
  # @param [Hash] opts the optional parameters
3497
3497
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3512,7 +3512,7 @@ module KlaviyoAPI
3512
3512
  # header parameters
3513
3513
  header_params = opts[:header_params] || {}
3514
3514
  # klaviyo api revision
3515
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3515
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3516
3516
  # HTTP header 'Accept' (if needed)
3517
3517
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3518
3518
  # HTTP header 'Content-Type'
@@ -3551,7 +3551,7 @@ module KlaviyoAPI
3551
3551
  end
3552
3552
 
3553
3553
  # Spawn Update Items Job
3554
- # Create a catalog item bulk update job to update a batch of catalog items.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3554
+ # Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3555
3555
  # @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery]
3556
3556
  # @param [Hash] opts the optional parameters
3557
3557
  # @return [Hash<String, Object>]
@@ -3561,7 +3561,7 @@ module KlaviyoAPI
3561
3561
  end
3562
3562
 
3563
3563
  # Spawn Update Items Job
3564
- # Create a catalog item bulk update job to update a batch of catalog items.&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;Catalogs Write&#x60;
3564
+ # Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3565
3565
  # @param catalog_item_update_job_create_query [CatalogItemUpdateJobCreateQuery]
3566
3566
  # @param [Hash] opts the optional parameters
3567
3567
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3582,7 +3582,7 @@ module KlaviyoAPI
3582
3582
  # header parameters
3583
3583
  header_params = opts[:header_params] || {}
3584
3584
  # klaviyo api revision
3585
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3585
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3586
3586
  # HTTP header 'Accept' (if needed)
3587
3587
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3588
3588
  # HTTP header 'Content-Type'
@@ -3621,7 +3621,7 @@ module KlaviyoAPI
3621
3621
  end
3622
3622
 
3623
3623
  # Spawn Update Variants Job
3624
- # Create a catalog variant bulk update job to update a batch of catalog variants.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3624
+ # Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3625
3625
  # @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery]
3626
3626
  # @param [Hash] opts the optional parameters
3627
3627
  # @return [Hash<String, Object>]
@@ -3631,7 +3631,7 @@ module KlaviyoAPI
3631
3631
  end
3632
3632
 
3633
3633
  # Spawn Update Variants Job
3634
- # Create a catalog variant bulk update job to update a batch of catalog variants.&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;Catalogs Write&#x60;
3634
+ # Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.&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;Catalogs Write&#x60;
3635
3635
  # @param catalog_variant_update_job_create_query [CatalogVariantUpdateJobCreateQuery]
3636
3636
  # @param [Hash] opts the optional parameters
3637
3637
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3652,7 +3652,7 @@ module KlaviyoAPI
3652
3652
  # header parameters
3653
3653
  header_params = opts[:header_params] || {}
3654
3654
  # klaviyo api revision
3655
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3655
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3656
3656
  # HTTP header 'Accept' (if needed)
3657
3657
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3658
3658
  # HTTP header 'Content-Type'
@@ -3692,7 +3692,7 @@ module KlaviyoAPI
3692
3692
 
3693
3693
  # Update Catalog Category
3694
3694
  # Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3695
- # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
3695
+ # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
3696
3696
  # @param catalog_category_update_query [CatalogCategoryUpdateQuery]
3697
3697
  # @param [Hash] opts the optional parameters
3698
3698
  # @return [Hash<String, Object>]
@@ -3703,7 +3703,7 @@ module KlaviyoAPI
3703
3703
 
3704
3704
  # Update Catalog Category
3705
3705
  # Update a catalog category with the given category 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;Catalogs Write&#x60;
3706
- # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
3706
+ # @param id [String] The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
3707
3707
  # @param catalog_category_update_query [CatalogCategoryUpdateQuery]
3708
3708
  # @param [Hash] opts the optional parameters
3709
3709
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3728,7 +3728,7 @@ module KlaviyoAPI
3728
3728
  # header parameters
3729
3729
  header_params = opts[:header_params] || {}
3730
3730
  # klaviyo api revision
3731
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3731
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3732
3732
  # HTTP header 'Accept' (if needed)
3733
3733
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3734
3734
  # HTTP header 'Content-Type'
@@ -3815,7 +3815,7 @@ module KlaviyoAPI
3815
3815
  # header parameters
3816
3816
  header_params = opts[:header_params] || {}
3817
3817
  # klaviyo api revision
3818
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3818
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3819
3819
  # HTTP header 'Accept' (if needed)
3820
3820
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3821
3821
  # HTTP header 'Content-Type'
@@ -3855,7 +3855,7 @@ module KlaviyoAPI
3855
3855
 
3856
3856
  # Update Catalog Item
3857
3857
  # Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3858
- # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
3858
+ # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
3859
3859
  # @param catalog_item_update_query [CatalogItemUpdateQuery]
3860
3860
  # @param [Hash] opts the optional parameters
3861
3861
  # @return [Hash<String, Object>]
@@ -3866,7 +3866,7 @@ module KlaviyoAPI
3866
3866
 
3867
3867
  # Update Catalog Item
3868
3868
  # Update a catalog item with the given item 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;Catalogs Write&#x60;
3869
- # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
3869
+ # @param id [String] The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
3870
3870
  # @param catalog_item_update_query [CatalogItemUpdateQuery]
3871
3871
  # @param [Hash] opts the optional parameters
3872
3872
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -3891,7 +3891,7 @@ module KlaviyoAPI
3891
3891
  # header parameters
3892
3892
  header_params = opts[:header_params] || {}
3893
3893
  # klaviyo api revision
3894
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3894
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3895
3895
  # HTTP header 'Accept' (if needed)
3896
3896
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3897
3897
  # HTTP header 'Content-Type'
@@ -3978,7 +3978,7 @@ module KlaviyoAPI
3978
3978
  # header parameters
3979
3979
  header_params = opts[:header_params] || {}
3980
3980
  # klaviyo api revision
3981
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
3981
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
3982
3982
  # HTTP header 'Accept' (if needed)
3983
3983
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3984
3984
  # HTTP header 'Content-Type'
@@ -4018,7 +4018,7 @@ module KlaviyoAPI
4018
4018
 
4019
4019
  # Update Catalog Variant
4020
4020
  # Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
4021
- # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
4021
+ # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
4022
4022
  # @param catalog_variant_update_query [CatalogVariantUpdateQuery]
4023
4023
  # @param [Hash] opts the optional parameters
4024
4024
  # @return [Hash<String, Object>]
@@ -4029,7 +4029,7 @@ module KlaviyoAPI
4029
4029
 
4030
4030
  # Update Catalog Variant
4031
4031
  # Update a catalog item variant with the given variant 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;Catalogs Write&#x60;
4032
- # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;, but support for multiple catalogs &amp; non-custom integrations is forthcoming.
4032
+ # @param id [String] The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
4033
4033
  # @param catalog_variant_update_query [CatalogVariantUpdateQuery]
4034
4034
  # @param [Hash] opts the optional parameters
4035
4035
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -4054,7 +4054,7 @@ module KlaviyoAPI
4054
4054
  # header parameters
4055
4055
  header_params = opts[:header_params] || {}
4056
4056
  # klaviyo api revision
4057
- header_params['revision'] = ENV['API_REVISION'] || "2023-01-24"
4057
+ header_params['revision'] = ENV['API_REVISION'] || "2023-02-22"
4058
4058
  # HTTP header 'Accept' (if needed)
4059
4059
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4060
4060
  # HTTP header 'Content-Type'