klaviyo-api-sdk 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (324) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/README.md +314 -136
  4. data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
  5. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
  6. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
  7. data/docs/CampaignTagOp.md +18 -0
  8. data/docs/CampaignTagOpDataInner.md +20 -0
  9. data/docs/CampaignsApi.md +1277 -0
  10. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  11. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +6 -6
  12. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  13. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +2 -2
  14. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  15. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +2 -2
  16. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +2 -2
  17. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  18. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +21 -19
  19. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  20. data/docs/CatalogItemDeleteQueryAsSubResource.md +2 -2
  21. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  22. data/docs/CatalogItemUpdateQueryAsSubResource.md +2 -2
  23. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +18 -16
  24. data/docs/CatalogJobErrorPayload.md +8 -8
  25. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  26. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +27 -27
  27. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  28. data/docs/CatalogVariantDeleteQueryAsSubResource.md +2 -2
  29. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  30. data/docs/CatalogVariantUpdateQueryAsSubResource.md +2 -2
  31. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +22 -22
  32. data/docs/CatalogsApi.md +238 -238
  33. data/docs/ErrorSource.md +1 -1
  34. data/docs/EventsApi.md +26 -26
  35. data/docs/FlowsApi.md +64 -56
  36. data/docs/GetCampaigns4XXResponse.md +18 -0
  37. data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
  38. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
  39. data/docs/IncludedCategories.md +2 -2
  40. data/docs/IncludedCategoriesAttributes.md +5 -5
  41. data/docs/IncludedItems.md +2 -2
  42. data/docs/IncludedItemsAttributes.md +22 -20
  43. data/docs/IncludedLists.md +2 -2
  44. data/docs/IncludedListsAttributes.md +4 -4
  45. data/docs/IncludedProfiles.md +2 -2
  46. data/docs/IncludedProfilesAttributes.md +21 -21
  47. data/docs/IncludedSegments.md +1 -1
  48. data/docs/IncludedSegmentsAttributes.md +22 -0
  49. data/docs/IncludedTags.md +24 -0
  50. data/docs/IncludedVariants.md +2 -2
  51. data/docs/IncludedVariantsAttributes.md +28 -28
  52. data/docs/ListCreateQueryAsSubResourceAttributes.md +2 -2
  53. data/docs/ListPartialUpdateQueryAsSubResource.md +2 -2
  54. data/docs/ListsApi.md +30 -30
  55. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +5 -5
  56. data/docs/MetricsApi.md +9 -9
  57. data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
  58. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +18 -18
  59. data/docs/ProfileLocation.md +15 -15
  60. data/docs/ProfileLocationLongitude.md +49 -0
  61. data/docs/ProfilePartialUpdateQueryAsSubResource.md +2 -2
  62. data/docs/ProfilesApi.md +26 -26
  63. data/docs/STOScheduleOptions.md +18 -0
  64. data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
  65. data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
  66. data/docs/SegmentsApi.md +19 -19
  67. data/docs/SendOptionsSubObject.md +1 -3
  68. data/docs/SendStrategySubObject.md +4 -2
  69. data/docs/Subscription.md +8 -4
  70. data/docs/SubscriptionChannels.md +20 -0
  71. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +2 -2
  72. data/docs/Suppression.md +1 -1
  73. data/docs/TagsApi.md +24 -24
  74. data/docs/TemplateCloneQueryAsSubResource.md +0 -2
  75. data/docs/TemplatesApi.md +11 -11
  76. data/docs/ThrottledScheduleOptions.md +1 -1
  77. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
  78. data/klaviyo-api-sdk.gemspec +2 -2
  79. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
  80. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +299 -299
  81. data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
  82. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  83. data/lib/klaviyo-api-sdk/api/events_api.rb +33 -33
  84. data/lib/klaviyo-api-sdk/api/flows_api.rb +86 -74
  85. data/lib/klaviyo-api-sdk/api/lists_api.rb +39 -39
  86. data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
  87. data/lib/klaviyo-api-sdk/api/profiles_api.rb +34 -34
  88. data/lib/klaviyo-api-sdk/api/segments_api.rb +25 -25
  89. data/lib/klaviyo-api-sdk/api/tags_api.rb +41 -41
  90. data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
  91. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  92. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  93. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
  111. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +272 -0
  112. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +225 -0
  113. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
  120. data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +272 -0
  121. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +5 -2
  127. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +2 -2
  131. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +2 -2
  137. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +23 -3
  145. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +2 -2
  152. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +2 -2
  157. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +20 -2
  158. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +16 -8
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +2 -2
  172. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +2 -2
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +12 -2
  178. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
  185. data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
  192. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
  193. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
  194. data/lib/klaviyo-api-sdk/models/included_categories.rb +2 -2
  195. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +4 -1
  196. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/included_flows.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/included_items.rb +2 -1
  206. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +23 -2
  207. data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -1
  208. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +4 -1
  209. data/lib/klaviyo-api-sdk/models/included_metrics.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -1
  212. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +13 -1
  213. data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
  214. data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
  215. data/lib/klaviyo-api-sdk/models/included_tags.rb +301 -0
  216. data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -1
  217. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +16 -2
  218. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -1
  222. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  223. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -1
  227. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +17 -15
  230. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  235. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
  236. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +10 -1
  242. data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
  243. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
  244. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
  245. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -1
  247. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
  249. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +224 -0
  250. data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
  252. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
  253. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
  259. data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
  260. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
  261. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  275. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +2 -13
  284. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +1 -1
  287. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +1 -1
  288. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  289. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +1 -1
  291. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  304. data/lib/klaviyo-api-sdk/version.rb +1 -1
  305. data/lib/klaviyo-api-sdk.rb +14 -5
  306. data/spec/api/campaigns_api_spec.rb +284 -0
  307. data/spec/api_client_spec.rb +1 -1
  308. data/spec/configuration_spec.rb +1 -1
  309. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  310. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +44 -0
  311. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
  312. data/spec/models/campaign_tag_op_data_inner_spec.rb +44 -0
  313. data/spec/models/campaign_tag_op_spec.rb +34 -0
  314. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
  315. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
  316. data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
  317. data/spec/models/included_segments_attributes_spec.rb +46 -0
  318. data/spec/models/included_tags_spec.rb +56 -0
  319. data/spec/models/profile_location_longitude_spec.rb +31 -0
  320. data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
  321. data/spec/models/sto_schedule_options_spec.rb +34 -0
  322. data/spec/models/subscription_channels_spec.rb +48 -0
  323. data/spec/spec_helper.rb +1 -1
  324. metadata +51 -6
data/docs/CatalogsApi.md CHANGED
@@ -81,7 +81,7 @@ KlaviyoAPI.configure do |config|
81
81
  end
82
82
 
83
83
  api_instance = KlaviyoAPI::CatalogsApi.new
84
- catalog_category_create_query = KlaviyoAPI::CatalogCategoryCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResource.new({type: 'catalog-category', attributes: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', name: 'name_example'})})}) # CatalogCategoryCreateQuery |
84
+ catalog_category_create_query = KlaviyoAPI::CatalogCategoryCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResource.new({type: 'catalog-category', attributes: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new({external_id: 'SAMPLE-DATA-CATEGORY-APPAREL', name: 'Sample Data Category Apparel'})})}) # CatalogCategoryCreateQuery |
85
85
 
86
86
  begin
87
87
  # Create Catalog Category
@@ -226,7 +226,7 @@ KlaviyoAPI.configure do |config|
226
226
  end
227
227
 
228
228
  api_instance = KlaviyoAPI::CatalogsApi.new
229
- catalog_item_create_query = KlaviyoAPI::CatalogItemCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateQueryAsSubResource.new({type: 'catalog-item', attributes: KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', title: 'title_example', description: 'description_example', url: 'url_example'})})}) # CatalogItemCreateQuery |
229
+ catalog_item_create_query = KlaviyoAPI::CatalogItemCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateQueryAsSubResource.new({type: 'catalog-item', attributes: KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new({external_id: 'SAMPLE-DATA-ITEM-1', title: 'Ocean Blue Shirt (Sample)', description: 'Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.', url: 'https://via.placeholder.com/150'})})}) # CatalogItemCreateQuery |
230
230
 
231
231
  begin
232
232
  # Create Catalog Item
@@ -371,7 +371,7 @@ KlaviyoAPI.configure do |config|
371
371
  end
372
372
 
373
373
  api_instance = KlaviyoAPI::CatalogsApi.new
374
- catalog_variant_create_query = KlaviyoAPI::CatalogVariantCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateQueryAsSubResource.new({type: 'catalog-variant', attributes: KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', title: 'title_example', description: 'description_example', sku: 'sku_example', inventory_policy: 0, inventory_quantity: 3.56, price: 3.56, url: 'url_example'})})}) # CatalogVariantCreateQuery |
374
+ catalog_variant_create_query = KlaviyoAPI::CatalogVariantCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateQueryAsSubResource.new({type: 'catalog-variant', attributes: KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new({external_id: 'SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', title: 'Ocean Blue Shirt (Sample) Variant Medium', description: 'Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.', sku: 'OBS-MD', inventory_quantity: 25, price: 42, url: 'https://via.placeholder.com/150'})})}) # CatalogVariantCreateQuery |
375
375
 
376
376
  begin
377
377
  # Create Catalog Variant
@@ -442,7 +442,7 @@ KlaviyoAPI.configure do |config|
442
442
  end
443
443
 
444
444
  api_instance = KlaviyoAPI::CatalogsApi.new
445
- id = 'id_example' # String | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
445
+ id = '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL' # String | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
446
446
 
447
447
  begin
448
448
  # Delete Catalog Category
@@ -474,7 +474,7 @@ end
474
474
 
475
475
  | Name | Type | Description | Notes |
476
476
  | ---- | ---- | ----------- | ----- |
477
- | **id** | **String** | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
477
+ | **id** | **String** | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
478
478
 
479
479
  ### Return type
480
480
 
@@ -586,7 +586,7 @@ KlaviyoAPI.configure do |config|
586
586
  end
587
587
 
588
588
  api_instance = KlaviyoAPI::CatalogsApi.new
589
- id = 'id_example' # String | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
589
+ id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
590
590
 
591
591
  begin
592
592
  # Delete Catalog Item
@@ -618,7 +618,7 @@ end
618
618
 
619
619
  | Name | Type | Description | Notes |
620
620
  | ---- | ---- | ----------- | ----- |
621
- | **id** | **String** | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
621
+ | **id** | **String** | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
622
622
 
623
623
  ### Return type
624
624
 
@@ -730,7 +730,7 @@ KlaviyoAPI.configure do |config|
730
730
  end
731
731
 
732
732
  api_instance = KlaviyoAPI::CatalogsApi.new
733
- id = 'id_example' # String | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
733
+ id = '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM' # String | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
734
734
 
735
735
  begin
736
736
  # Delete Catalog Variant
@@ -762,7 +762,7 @@ end
762
762
 
763
763
  | Name | Type | Description | Notes |
764
764
  | ---- | ---- | ----------- | ----- |
765
- | **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
765
+ | **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
766
766
 
767
767
  ### Return type
768
768
 
@@ -801,10 +801,10 @@ end
801
801
 
802
802
  api_instance = KlaviyoAPI::CatalogsApi.new
803
803
  opts = {
804
- fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
805
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
806
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
807
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
804
+ fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
805
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
806
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
807
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
808
808
  }
809
809
 
810
810
  begin
@@ -838,10 +838,10 @@ end
838
838
 
839
839
  | Name | Type | Description | Notes |
840
840
  | ---- | ---- | ----------- | ----- |
841
- | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
842
- | **filter** | **String** | 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; | [optional] |
843
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
844
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
841
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
842
+ | **filter** | **String** | 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; | [optional] |
843
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
844
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
845
845
 
846
846
  ### Return type
847
847
 
@@ -879,9 +879,9 @@ KlaviyoAPI.configure do |config|
879
879
  end
880
880
 
881
881
  api_instance = KlaviyoAPI::CatalogsApi.new
882
- id = 'id_example' # String | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
882
+ id = '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL' # String | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
883
883
  opts = {
884
- fields_catalog_category: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
884
+ fields_catalog_category: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
885
885
  }
886
886
 
887
887
  begin
@@ -915,8 +915,8 @@ end
915
915
 
916
916
  | Name | Type | Description | Notes |
917
917
  | ---- | ---- | ----------- | ----- |
918
- | **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. | |
919
- | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
918
+ | **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;. | |
919
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
920
920
 
921
921
  ### Return type
922
922
 
@@ -954,14 +954,14 @@ KlaviyoAPI.configure do |config|
954
954
  end
955
955
 
956
956
  api_instance = KlaviyoAPI::CatalogsApi.new
957
- category_id = 'category_id_example' # String |
957
+ category_id = '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL' # String | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
958
958
  opts = {
959
- fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
960
- fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
961
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
962
- include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
963
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
964
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
959
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
960
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
961
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
962
+ include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
963
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
964
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
965
965
  }
966
966
 
967
967
  begin
@@ -995,13 +995,13 @@ end
995
995
 
996
996
  | Name | Type | Description | Notes |
997
997
  | ---- | ---- | ----------- | ----- |
998
- | **category_id** | **String** | | |
999
- | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1000
- | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1001
- | **filter** | **String** | 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; | [optional] |
1002
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
1003
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1004
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
998
+ | **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;. | |
999
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1000
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1001
+ | **filter** | **String** | 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; | [optional] |
1002
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
1003
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1004
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1005
1005
 
1006
1006
  ### Return type
1007
1007
 
@@ -1042,7 +1042,7 @@ api_instance = KlaviyoAPI::CatalogsApi.new
1042
1042
  id = 'id_example' # String |
1043
1043
  related_resource = 'items' # String |
1044
1044
  opts = {
1045
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1045
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1046
1046
  }
1047
1047
 
1048
1048
  begin
@@ -1078,7 +1078,7 @@ end
1078
1078
  | ---- | ---- | ----------- | ----- |
1079
1079
  | **id** | **String** | | |
1080
1080
  | **related_resource** | **String** | | |
1081
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1081
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1082
1082
 
1083
1083
  ### Return type
1084
1084
 
@@ -1116,11 +1116,11 @@ KlaviyoAPI.configure do |config|
1116
1116
  end
1117
1117
 
1118
1118
  api_instance = KlaviyoAPI::CatalogsApi.new
1119
- id = 'id_example' # String |
1119
+ id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
1120
1120
  opts = {
1121
- fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1122
- fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1123
- include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1121
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1122
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1123
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1124
1124
  }
1125
1125
 
1126
1126
  begin
@@ -1154,10 +1154,10 @@ end
1154
1154
 
1155
1155
  | Name | Type | Description | Notes |
1156
1156
  | ---- | ---- | ----------- | ----- |
1157
- | **id** | **String** | | |
1158
- | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1159
- | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1160
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
1157
+ | **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;. | |
1158
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1159
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1160
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
1161
1161
 
1162
1162
  ### Return type
1163
1163
 
@@ -1195,12 +1195,12 @@ KlaviyoAPI.configure do |config|
1195
1195
  end
1196
1196
 
1197
1197
  api_instance = KlaviyoAPI::CatalogsApi.new
1198
- item_id = 'item_id_example' # String |
1198
+ item_id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
1199
1199
  opts = {
1200
- fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1201
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
1202
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1203
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1200
+ fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1201
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`name`: `contains`
1202
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1203
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1204
1204
  }
1205
1205
 
1206
1206
  begin
@@ -1234,11 +1234,11 @@ end
1234
1234
 
1235
1235
  | Name | Type | Description | Notes |
1236
1236
  | ---- | ---- | ----------- | ----- |
1237
- | **item_id** | **String** | | |
1238
- | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1239
- | **filter** | **String** | 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; | [optional] |
1240
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1241
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
1237
+ | **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;. | |
1238
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1239
+ | **filter** | **String** | 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; | [optional] |
1240
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1241
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1242
1242
 
1243
1243
  ### Return type
1244
1244
 
@@ -1279,7 +1279,7 @@ api_instance = KlaviyoAPI::CatalogsApi.new
1279
1279
  id = 'id_example' # String |
1280
1280
  related_resource = 'categories' # String |
1281
1281
  opts = {
1282
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1282
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1283
1283
  }
1284
1284
 
1285
1285
  begin
@@ -1315,7 +1315,7 @@ end
1315
1315
  | ---- | ---- | ----------- | ----- |
1316
1316
  | **id** | **String** | | |
1317
1317
  | **related_resource** | **String** | | |
1318
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1318
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1319
1319
 
1320
1320
  ### Return type
1321
1321
 
@@ -1353,12 +1353,12 @@ KlaviyoAPI.configure do |config|
1353
1353
  end
1354
1354
 
1355
1355
  api_instance = KlaviyoAPI::CatalogsApi.new
1356
- item_id = 'item_id_example' # String | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
1356
+ item_id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
1357
1357
  opts = {
1358
- fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1359
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1360
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1361
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1358
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1359
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1360
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1361
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1362
1362
  }
1363
1363
 
1364
1364
  begin
@@ -1392,11 +1392,11 @@ end
1392
1392
 
1393
1393
  | Name | Type | Description | Notes |
1394
1394
  | ---- | ---- | ----------- | ----- |
1395
- | **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. | |
1396
- | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1397
- | **filter** | **String** | 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; | [optional] |
1398
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1399
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
1395
+ | **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;. | |
1396
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1397
+ | **filter** | **String** | 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; | [optional] |
1398
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1399
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1400
1400
 
1401
1401
  ### Return type
1402
1402
 
@@ -1435,12 +1435,12 @@ end
1435
1435
 
1436
1436
  api_instance = KlaviyoAPI::CatalogsApi.new
1437
1437
  opts = {
1438
- fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1439
- fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1440
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1441
- include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1442
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1443
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1438
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1439
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1440
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1441
+ include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1442
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1443
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1444
1444
  }
1445
1445
 
1446
1446
  begin
@@ -1474,12 +1474,12 @@ end
1474
1474
 
1475
1475
  | Name | Type | Description | Notes |
1476
1476
  | ---- | ---- | ----------- | ----- |
1477
- | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1478
- | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1479
- | **filter** | **String** | 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; | [optional] |
1480
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
1481
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1482
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
1477
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1478
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1479
+ | **filter** | **String** | 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; | [optional] |
1480
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
1481
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1482
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1483
1483
 
1484
1484
  ### Return type
1485
1485
 
@@ -1517,9 +1517,9 @@ KlaviyoAPI.configure do |config|
1517
1517
  end
1518
1518
 
1519
1519
  api_instance = KlaviyoAPI::CatalogsApi.new
1520
- id = 'id_example' # String | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
1520
+ id = '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM' # String | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
1521
1521
  opts = {
1522
- fields_catalog_variant: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1522
+ fields_catalog_variant: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1523
1523
  }
1524
1524
 
1525
1525
  begin
@@ -1553,8 +1553,8 @@ end
1553
1553
 
1554
1554
  | Name | Type | Description | Notes |
1555
1555
  | ---- | ---- | ----------- | ----- |
1556
- | **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. | |
1557
- | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1556
+ | **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;. | |
1557
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1558
1558
 
1559
1559
  ### Return type
1560
1560
 
@@ -1593,10 +1593,10 @@ end
1593
1593
 
1594
1594
  api_instance = KlaviyoAPI::CatalogsApi.new
1595
1595
  opts = {
1596
- fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1597
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1598
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1599
- sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting
1596
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1597
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1598
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1599
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1600
1600
  }
1601
1601
 
1602
1602
  begin
@@ -1630,10 +1630,10 @@ end
1630
1630
 
1631
1631
  | Name | Type | Description | Notes |
1632
1632
  | ---- | ---- | ----------- | ----- |
1633
- | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1634
- | **filter** | **String** | 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; | [optional] |
1635
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1636
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting | [optional] |
1633
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1634
+ | **filter** | **String** | 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; | [optional] |
1635
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1636
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1637
1637
 
1638
1638
  ### Return type
1639
1639
 
@@ -1655,7 +1655,7 @@ end
1655
1655
 
1656
1656
  Get Create Categories Job
1657
1657
 
1658
- 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`
1658
+ 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`
1659
1659
 
1660
1660
  ### Examples
1661
1661
 
@@ -1671,11 +1671,11 @@ KlaviyoAPI.configure do |config|
1671
1671
  end
1672
1672
 
1673
1673
  api_instance = KlaviyoAPI::CatalogsApi.new
1674
- job_id = 'job_id_example' # String |
1674
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
1675
1675
  opts = {
1676
- fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1677
- fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1678
- include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1676
+ fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1677
+ fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1678
+ include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1679
1679
  }
1680
1680
 
1681
1681
  begin
@@ -1709,10 +1709,10 @@ end
1709
1709
 
1710
1710
  | Name | Type | Description | Notes |
1711
1711
  | ---- | ---- | ----------- | ----- |
1712
- | **job_id** | **String** | | |
1713
- | **fields_catalog_category_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1714
- | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1715
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
1712
+ | **job_id** | **String** | ID of the job to retrieve. | |
1713
+ | **fields_catalog_category_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1714
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1715
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
1716
1716
 
1717
1717
  ### Return type
1718
1718
 
@@ -1751,9 +1751,9 @@ end
1751
1751
 
1752
1752
  api_instance = KlaviyoAPI::CatalogsApi.new
1753
1753
  opts = {
1754
- fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1755
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
1756
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1754
+ fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1755
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
1756
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1757
1757
  }
1758
1758
 
1759
1759
  begin
@@ -1787,9 +1787,9 @@ end
1787
1787
 
1788
1788
  | Name | Type | Description | Notes |
1789
1789
  | ---- | ---- | ----------- | ----- |
1790
- | **fields_catalog_category_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1791
- | **filter** | **String** | 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; | [optional] |
1792
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1790
+ | **fields_catalog_category_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1791
+ | **filter** | **String** | 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; | [optional] |
1792
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1793
1793
 
1794
1794
  ### Return type
1795
1795
 
@@ -1811,7 +1811,7 @@ end
1811
1811
 
1812
1812
  Get Create Items Job
1813
1813
 
1814
- 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`
1814
+ 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`
1815
1815
 
1816
1816
  ### Examples
1817
1817
 
@@ -1827,11 +1827,11 @@ KlaviyoAPI.configure do |config|
1827
1827
  end
1828
1828
 
1829
1829
  api_instance = KlaviyoAPI::CatalogsApi.new
1830
- job_id = 'job_id_example' # String |
1830
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
1831
1831
  opts = {
1832
- fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1833
- fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1834
- include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1832
+ fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1833
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1834
+ include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1835
1835
  }
1836
1836
 
1837
1837
  begin
@@ -1865,10 +1865,10 @@ end
1865
1865
 
1866
1866
  | Name | Type | Description | Notes |
1867
1867
  | ---- | ---- | ----------- | ----- |
1868
- | **job_id** | **String** | | |
1869
- | **fields_catalog_item_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1870
- | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1871
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
1868
+ | **job_id** | **String** | ID of the job to retrieve. | |
1869
+ | **fields_catalog_item_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1870
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1871
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
1872
1872
 
1873
1873
  ### Return type
1874
1874
 
@@ -1907,9 +1907,9 @@ end
1907
1907
 
1908
1908
  api_instance = KlaviyoAPI::CatalogsApi.new
1909
1909
  opts = {
1910
- fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1911
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
1912
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
1910
+ fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1911
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
1912
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1913
1913
  }
1914
1914
 
1915
1915
  begin
@@ -1943,9 +1943,9 @@ end
1943
1943
 
1944
1944
  | Name | Type | Description | Notes |
1945
1945
  | ---- | ---- | ----------- | ----- |
1946
- | **fields_catalog_item_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
1947
- | **filter** | **String** | 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; | [optional] |
1948
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
1946
+ | **fields_catalog_item_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
1947
+ | **filter** | **String** | 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; | [optional] |
1948
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1949
1949
 
1950
1950
  ### Return type
1951
1951
 
@@ -1967,7 +1967,7 @@ end
1967
1967
 
1968
1968
  Get Create Variants Job
1969
1969
 
1970
- 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`
1970
+ 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`
1971
1971
 
1972
1972
  ### Examples
1973
1973
 
@@ -1983,11 +1983,11 @@ KlaviyoAPI.configure do |config|
1983
1983
  end
1984
1984
 
1985
1985
  api_instance = KlaviyoAPI::CatalogsApi.new
1986
- job_id = 'job_id_example' # String |
1986
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
1987
1987
  opts = {
1988
- fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1989
- fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
1990
- include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
1988
+ fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1989
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1990
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1991
1991
  }
1992
1992
 
1993
1993
  begin
@@ -2021,10 +2021,10 @@ end
2021
2021
 
2022
2022
  | Name | Type | Description | Notes |
2023
2023
  | ---- | ---- | ----------- | ----- |
2024
- | **job_id** | **String** | | |
2025
- | **fields_catalog_variant_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2026
- | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2027
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
2024
+ | **job_id** | **String** | ID of the job to retrieve. | |
2025
+ | **fields_catalog_variant_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2026
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2027
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
2028
2028
 
2029
2029
  ### Return type
2030
2030
 
@@ -2063,9 +2063,9 @@ end
2063
2063
 
2064
2064
  api_instance = KlaviyoAPI::CatalogsApi.new
2065
2065
  opts = {
2066
- fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2067
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2068
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2066
+ fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2067
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2068
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2069
2069
  }
2070
2070
 
2071
2071
  begin
@@ -2099,9 +2099,9 @@ end
2099
2099
 
2100
2100
  | Name | Type | Description | Notes |
2101
2101
  | ---- | ---- | ----------- | ----- |
2102
- | **fields_catalog_variant_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2103
- | **filter** | **String** | 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; | [optional] |
2104
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
2102
+ | **fields_catalog_variant_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2103
+ | **filter** | **String** | 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; | [optional] |
2104
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2105
2105
 
2106
2106
  ### Return type
2107
2107
 
@@ -2139,9 +2139,9 @@ KlaviyoAPI.configure do |config|
2139
2139
  end
2140
2140
 
2141
2141
  api_instance = KlaviyoAPI::CatalogsApi.new
2142
- job_id = 'job_id_example' # String |
2142
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2143
2143
  opts = {
2144
- fields_catalog_category_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2144
+ fields_catalog_category_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2145
2145
  }
2146
2146
 
2147
2147
  begin
@@ -2175,8 +2175,8 @@ end
2175
2175
 
2176
2176
  | Name | Type | Description | Notes |
2177
2177
  | ---- | ---- | ----------- | ----- |
2178
- | **job_id** | **String** | | |
2179
- | **fields_catalog_category_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2178
+ | **job_id** | **String** | ID of the job to retrieve. | |
2179
+ | **fields_catalog_category_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2180
2180
 
2181
2181
  ### Return type
2182
2182
 
@@ -2215,9 +2215,9 @@ end
2215
2215
 
2216
2216
  api_instance = KlaviyoAPI::CatalogsApi.new
2217
2217
  opts = {
2218
- fields_catalog_category_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2219
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2220
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2218
+ fields_catalog_category_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2219
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2220
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2221
2221
  }
2222
2222
 
2223
2223
  begin
@@ -2251,9 +2251,9 @@ end
2251
2251
 
2252
2252
  | Name | Type | Description | Notes |
2253
2253
  | ---- | ---- | ----------- | ----- |
2254
- | **fields_catalog_category_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2255
- | **filter** | **String** | 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; | [optional] |
2256
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
2254
+ | **fields_catalog_category_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2255
+ | **filter** | **String** | 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; | [optional] |
2256
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2257
2257
 
2258
2258
  ### Return type
2259
2259
 
@@ -2291,9 +2291,9 @@ KlaviyoAPI.configure do |config|
2291
2291
  end
2292
2292
 
2293
2293
  api_instance = KlaviyoAPI::CatalogsApi.new
2294
- job_id = 'job_id_example' # String |
2294
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2295
2295
  opts = {
2296
- fields_catalog_item_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2296
+ fields_catalog_item_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2297
2297
  }
2298
2298
 
2299
2299
  begin
@@ -2327,8 +2327,8 @@ end
2327
2327
 
2328
2328
  | Name | Type | Description | Notes |
2329
2329
  | ---- | ---- | ----------- | ----- |
2330
- | **job_id** | **String** | | |
2331
- | **fields_catalog_item_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2330
+ | **job_id** | **String** | ID of the job to retrieve. | |
2331
+ | **fields_catalog_item_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2332
2332
 
2333
2333
  ### Return type
2334
2334
 
@@ -2367,9 +2367,9 @@ end
2367
2367
 
2368
2368
  api_instance = KlaviyoAPI::CatalogsApi.new
2369
2369
  opts = {
2370
- fields_catalog_item_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2371
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2372
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2370
+ fields_catalog_item_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2371
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2372
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2373
2373
  }
2374
2374
 
2375
2375
  begin
@@ -2403,9 +2403,9 @@ end
2403
2403
 
2404
2404
  | Name | Type | Description | Notes |
2405
2405
  | ---- | ---- | ----------- | ----- |
2406
- | **fields_catalog_item_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2407
- | **filter** | **String** | 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; | [optional] |
2408
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
2406
+ | **fields_catalog_item_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2407
+ | **filter** | **String** | 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; | [optional] |
2408
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2409
2409
 
2410
2410
  ### Return type
2411
2411
 
@@ -2443,9 +2443,9 @@ KlaviyoAPI.configure do |config|
2443
2443
  end
2444
2444
 
2445
2445
  api_instance = KlaviyoAPI::CatalogsApi.new
2446
- job_id = 'job_id_example' # String |
2446
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2447
2447
  opts = {
2448
- fields_catalog_variant_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2448
+ fields_catalog_variant_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2449
2449
  }
2450
2450
 
2451
2451
  begin
@@ -2479,8 +2479,8 @@ end
2479
2479
 
2480
2480
  | Name | Type | Description | Notes |
2481
2481
  | ---- | ---- | ----------- | ----- |
2482
- | **job_id** | **String** | | |
2483
- | **fields_catalog_variant_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2482
+ | **job_id** | **String** | ID of the job to retrieve. | |
2483
+ | **fields_catalog_variant_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2484
2484
 
2485
2485
  ### Return type
2486
2486
 
@@ -2519,9 +2519,9 @@ end
2519
2519
 
2520
2520
  api_instance = KlaviyoAPI::CatalogsApi.new
2521
2521
  opts = {
2522
- fields_catalog_variant_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2523
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2524
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2522
+ fields_catalog_variant_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2523
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2524
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2525
2525
  }
2526
2526
 
2527
2527
  begin
@@ -2555,9 +2555,9 @@ end
2555
2555
 
2556
2556
  | Name | Type | Description | Notes |
2557
2557
  | ---- | ---- | ----------- | ----- |
2558
- | **fields_catalog_variant_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2559
- | **filter** | **String** | 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; | [optional] |
2560
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
2558
+ | **fields_catalog_variant_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2559
+ | **filter** | **String** | 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; | [optional] |
2560
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2561
2561
 
2562
2562
  ### Return type
2563
2563
 
@@ -2579,7 +2579,7 @@ end
2579
2579
 
2580
2580
  Get Update Categories Job
2581
2581
 
2582
- 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`
2582
+ 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`
2583
2583
 
2584
2584
  ### Examples
2585
2585
 
@@ -2595,11 +2595,11 @@ KlaviyoAPI.configure do |config|
2595
2595
  end
2596
2596
 
2597
2597
  api_instance = KlaviyoAPI::CatalogsApi.new
2598
- job_id = 'job_id_example' # String |
2598
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2599
2599
  opts = {
2600
- fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2601
- fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2602
- include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2600
+ fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2601
+ fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2602
+ include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2603
2603
  }
2604
2604
 
2605
2605
  begin
@@ -2633,10 +2633,10 @@ end
2633
2633
 
2634
2634
  | Name | Type | Description | Notes |
2635
2635
  | ---- | ---- | ----------- | ----- |
2636
- | **job_id** | **String** | | |
2637
- | **fields_catalog_category_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2638
- | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2639
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
2636
+ | **job_id** | **String** | ID of the job to retrieve. | |
2637
+ | **fields_catalog_category_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2638
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2639
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
2640
2640
 
2641
2641
  ### Return type
2642
2642
 
@@ -2675,9 +2675,9 @@ end
2675
2675
 
2676
2676
  api_instance = KlaviyoAPI::CatalogsApi.new
2677
2677
  opts = {
2678
- fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2679
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2680
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2678
+ fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2679
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2680
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2681
2681
  }
2682
2682
 
2683
2683
  begin
@@ -2711,9 +2711,9 @@ end
2711
2711
 
2712
2712
  | Name | Type | Description | Notes |
2713
2713
  | ---- | ---- | ----------- | ----- |
2714
- | **fields_catalog_category_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2715
- | **filter** | **String** | 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; | [optional] |
2716
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
2714
+ | **fields_catalog_category_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2715
+ | **filter** | **String** | 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; | [optional] |
2716
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2717
2717
 
2718
2718
  ### Return type
2719
2719
 
@@ -2735,7 +2735,7 @@ end
2735
2735
 
2736
2736
  Get Update Items Job
2737
2737
 
2738
- 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`
2738
+ 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`
2739
2739
 
2740
2740
  ### Examples
2741
2741
 
@@ -2751,11 +2751,11 @@ KlaviyoAPI.configure do |config|
2751
2751
  end
2752
2752
 
2753
2753
  api_instance = KlaviyoAPI::CatalogsApi.new
2754
- job_id = 'job_id_example' # String |
2754
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2755
2755
  opts = {
2756
- fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2757
- fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2758
- include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2756
+ fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2757
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2758
+ include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2759
2759
  }
2760
2760
 
2761
2761
  begin
@@ -2789,10 +2789,10 @@ end
2789
2789
 
2790
2790
  | Name | Type | Description | Notes |
2791
2791
  | ---- | ---- | ----------- | ----- |
2792
- | **job_id** | **String** | | |
2793
- | **fields_catalog_item_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2794
- | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2795
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
2792
+ | **job_id** | **String** | ID of the job to retrieve. | |
2793
+ | **fields_catalog_item_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2794
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2795
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
2796
2796
 
2797
2797
  ### Return type
2798
2798
 
@@ -2831,9 +2831,9 @@ end
2831
2831
 
2832
2832
  api_instance = KlaviyoAPI::CatalogsApi.new
2833
2833
  opts = {
2834
- fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2835
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2836
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2834
+ fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2835
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2836
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2837
2837
  }
2838
2838
 
2839
2839
  begin
@@ -2867,9 +2867,9 @@ end
2867
2867
 
2868
2868
  | Name | Type | Description | Notes |
2869
2869
  | ---- | ---- | ----------- | ----- |
2870
- | **fields_catalog_item_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2871
- | **filter** | **String** | 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; | [optional] |
2872
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
2870
+ | **fields_catalog_item_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2871
+ | **filter** | **String** | 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; | [optional] |
2872
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2873
2873
 
2874
2874
  ### Return type
2875
2875
 
@@ -2891,7 +2891,7 @@ end
2891
2891
 
2892
2892
  Get Update Variants Job
2893
2893
 
2894
- 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`
2894
+ 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`
2895
2895
 
2896
2896
  ### Examples
2897
2897
 
@@ -2907,11 +2907,11 @@ KlaviyoAPI.configure do |config|
2907
2907
  end
2908
2908
 
2909
2909
  api_instance = KlaviyoAPI::CatalogsApi.new
2910
- job_id = 'job_id_example' # String |
2910
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2911
2911
  opts = {
2912
- fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2913
- fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2914
- include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
2912
+ fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2913
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2914
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2915
2915
  }
2916
2916
 
2917
2917
  begin
@@ -2945,10 +2945,10 @@ end
2945
2945
 
2946
2946
  | Name | Type | Description | Notes |
2947
2947
  | ---- | ---- | ----------- | ----- |
2948
- | **job_id** | **String** | | |
2949
- | **fields_catalog_variant_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2950
- | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
2951
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships | [optional] |
2948
+ | **job_id** | **String** | ID of the job to retrieve. | |
2949
+ | **fields_catalog_variant_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2950
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
2951
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
2952
2952
 
2953
2953
  ### Return type
2954
2954
 
@@ -2987,9 +2987,9 @@ end
2987
2987
 
2988
2988
  api_instance = KlaviyoAPI::CatalogsApi.new
2989
2989
  opts = {
2990
- fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
2991
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2992
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
2990
+ fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
2991
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2992
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2993
2993
  }
2994
2994
 
2995
2995
  begin
@@ -3023,9 +3023,9 @@ end
3023
3023
 
3024
3024
  | Name | Type | Description | Notes |
3025
3025
  | ---- | ---- | ----------- | ----- |
3026
- | **fields_catalog_variant_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
3027
- | **filter** | **String** | 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; | [optional] |
3028
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
3026
+ | **fields_catalog_variant_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
3027
+ | **filter** | **String** | 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; | [optional] |
3028
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
3029
3029
 
3030
3030
  ### Return type
3031
3031
 
@@ -3047,7 +3047,7 @@ end
3047
3047
 
3048
3048
  Spawn Create Categories Job
3049
3049
 
3050
- 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`
3050
+ 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`
3051
3051
 
3052
3052
  ### Examples
3053
3053
 
@@ -3063,7 +3063,7 @@ KlaviyoAPI.configure do |config|
3063
3063
  end
3064
3064
 
3065
3065
  api_instance = KlaviyoAPI::CatalogsApi.new
3066
- catalog_category_create_job_create_query = KlaviyoAPI::CatalogCategoryCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-create-job', attributes: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryCreateQueryAsSubResource.new({type: 'catalog-category', attributes: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', name: 'name_example'})})]})})}) # CatalogCategoryCreateJobCreateQuery |
3066
+ catalog_category_create_job_create_query = KlaviyoAPI::CatalogCategoryCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-create-job', attributes: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryCreateQueryAsSubResource.new({type: 'catalog-category', attributes: KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new({external_id: 'SAMPLE-DATA-CATEGORY-APPAREL', name: 'Sample Data Category Apparel'})})]})})}) # CatalogCategoryCreateJobCreateQuery |
3067
3067
 
3068
3068
  begin
3069
3069
  # Spawn Create Categories Job
@@ -3118,7 +3118,7 @@ end
3118
3118
 
3119
3119
  Spawn Create Items Job
3120
3120
 
3121
- 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`
3121
+ 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`
3122
3122
 
3123
3123
  ### Examples
3124
3124
 
@@ -3134,7 +3134,7 @@ KlaviyoAPI.configure do |config|
3134
3134
  end
3135
3135
 
3136
3136
  api_instance = KlaviyoAPI::CatalogsApi.new
3137
- catalog_item_create_job_create_query = KlaviyoAPI::CatalogItemCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-create-job', attributes: KlaviyoAPI::CatalogItemCreateJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemCreateQueryAsSubResource.new({type: 'catalog-item', attributes: KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', title: 'title_example', description: 'description_example', url: 'url_example'})})]})})}) # CatalogItemCreateJobCreateQuery |
3137
+ catalog_item_create_job_create_query = KlaviyoAPI::CatalogItemCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-create-job', attributes: KlaviyoAPI::CatalogItemCreateJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemCreateQueryAsSubResource.new({type: 'catalog-item', attributes: KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new({external_id: 'SAMPLE-DATA-ITEM-1', title: 'Ocean Blue Shirt (Sample)', description: 'Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.', url: 'https://via.placeholder.com/150'})})]})})}) # CatalogItemCreateJobCreateQuery |
3138
3138
 
3139
3139
  begin
3140
3140
  # Spawn Create Items Job
@@ -3189,7 +3189,7 @@ end
3189
3189
 
3190
3190
  Spawn Create Variants Job
3191
3191
 
3192
- 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`
3192
+ 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`
3193
3193
 
3194
3194
  ### Examples
3195
3195
 
@@ -3205,7 +3205,7 @@ KlaviyoAPI.configure do |config|
3205
3205
  end
3206
3206
 
3207
3207
  api_instance = KlaviyoAPI::CatalogsApi.new
3208
- catalog_variant_create_job_create_query = KlaviyoAPI::CatalogVariantCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-create-job', attributes: KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResource.new({type: 'catalog-variant', attributes: KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new({external_id: 'external_id_example', title: 'title_example', description: 'description_example', sku: 'sku_example', inventory_policy: 0, inventory_quantity: 3.56, price: 3.56, url: 'url_example'})})]})})}) # CatalogVariantCreateJobCreateQuery |
3208
+ catalog_variant_create_job_create_query = KlaviyoAPI::CatalogVariantCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-create-job', attributes: KlaviyoAPI::CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResource.new({type: 'catalog-variant', attributes: KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new({external_id: 'SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', title: 'Ocean Blue Shirt (Sample) Variant Medium', description: 'Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.', sku: 'OBS-MD', inventory_quantity: 25, price: 42, url: 'https://via.placeholder.com/150'})})]})})}) # CatalogVariantCreateJobCreateQuery |
3209
3209
 
3210
3210
  begin
3211
3211
  # Spawn Create Variants Job
@@ -3260,7 +3260,7 @@ end
3260
3260
 
3261
3261
  Spawn Delete Categories Job
3262
3262
 
3263
- 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`
3263
+ 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`
3264
3264
 
3265
3265
  ### Examples
3266
3266
 
@@ -3276,7 +3276,7 @@ KlaviyoAPI.configure do |config|
3276
3276
  end
3277
3277
 
3278
3278
  api_instance = KlaviyoAPI::CatalogsApi.new
3279
- catalog_category_delete_job_create_query = KlaviyoAPI::CatalogCategoryDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-delete-job', attributes: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryDeleteQueryAsSubResource.new({type: 'catalog-category', id: 'id_example'})]})})}) # CatalogCategoryDeleteJobCreateQuery |
3279
+ catalog_category_delete_job_create_query = KlaviyoAPI::CatalogCategoryDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-delete-job', attributes: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryDeleteQueryAsSubResource.new({type: 'catalog-category', id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'})]})})}) # CatalogCategoryDeleteJobCreateQuery |
3280
3280
 
3281
3281
  begin
3282
3282
  # Spawn Delete Categories Job
@@ -3331,7 +3331,7 @@ end
3331
3331
 
3332
3332
  Spawn Delete Items Job
3333
3333
 
3334
- 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`
3334
+ 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`
3335
3335
 
3336
3336
  ### Examples
3337
3337
 
@@ -3347,7 +3347,7 @@ KlaviyoAPI.configure do |config|
3347
3347
  end
3348
3348
 
3349
3349
  api_instance = KlaviyoAPI::CatalogsApi.new
3350
- catalog_item_delete_job_create_query = KlaviyoAPI::CatalogItemDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogItemDeleteJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-delete-job', attributes: KlaviyoAPI::CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemDeleteQueryAsSubResource.new({type: 'catalog-item', id: 'id_example'})]})})}) # CatalogItemDeleteJobCreateQuery |
3350
+ catalog_item_delete_job_create_query = KlaviyoAPI::CatalogItemDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogItemDeleteJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-delete-job', attributes: KlaviyoAPI::CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemDeleteQueryAsSubResource.new({type: 'catalog-item', id: '$custom:::$default:::SAMPLE-DATA-ITEM-1'})]})})}) # CatalogItemDeleteJobCreateQuery |
3351
3351
 
3352
3352
  begin
3353
3353
  # Spawn Delete Items Job
@@ -3402,7 +3402,7 @@ end
3402
3402
 
3403
3403
  Spawn Delete Variants Job
3404
3404
 
3405
- 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`
3405
+ 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`
3406
3406
 
3407
3407
  ### Examples
3408
3408
 
@@ -3418,7 +3418,7 @@ KlaviyoAPI.configure do |config|
3418
3418
  end
3419
3419
 
3420
3420
  api_instance = KlaviyoAPI::CatalogsApi.new
3421
- catalog_variant_delete_job_create_query = KlaviyoAPI::CatalogVariantDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-delete-job', attributes: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantDeleteQueryAsSubResource.new({type: 'catalog-variant', id: 'id_example'})]})})}) # CatalogVariantDeleteJobCreateQuery |
3421
+ catalog_variant_delete_job_create_query = KlaviyoAPI::CatalogVariantDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-delete-job', attributes: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantDeleteQueryAsSubResource.new({type: 'catalog-variant', id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'})]})})}) # CatalogVariantDeleteJobCreateQuery |
3422
3422
 
3423
3423
  begin
3424
3424
  # Spawn Delete Variants Job
@@ -3473,7 +3473,7 @@ end
3473
3473
 
3474
3474
  Spawn Update Categories Job
3475
3475
 
3476
- 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`
3476
+ 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`
3477
3477
 
3478
3478
  ### Examples
3479
3479
 
@@ -3489,7 +3489,7 @@ KlaviyoAPI.configure do |config|
3489
3489
  end
3490
3490
 
3491
3491
  api_instance = KlaviyoAPI::CatalogsApi.new
3492
- catalog_category_update_job_create_query = KlaviyoAPI::CatalogCategoryUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-update-job', attributes: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new({type: 'catalog-category', id: 'id_example', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogCategoryUpdateJobCreateQuery |
3492
+ catalog_category_update_job_create_query = KlaviyoAPI::CatalogCategoryUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryAsSubResource.new({type: 'catalog-category-bulk-update-job', attributes: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.new({categories: [KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new({type: 'catalog-category', id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogCategoryUpdateJobCreateQuery |
3493
3493
 
3494
3494
  begin
3495
3495
  # Spawn Update Categories Job
@@ -3544,7 +3544,7 @@ end
3544
3544
 
3545
3545
  Spawn Update Items Job
3546
3546
 
3547
- 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`
3547
+ 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`
3548
3548
 
3549
3549
  ### Examples
3550
3550
 
@@ -3560,7 +3560,7 @@ KlaviyoAPI.configure do |config|
3560
3560
  end
3561
3561
 
3562
3562
  api_instance = KlaviyoAPI::CatalogsApi.new
3563
- catalog_item_update_job_create_query = KlaviyoAPI::CatalogItemUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-update-job', attributes: KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new({type: 'catalog-item', id: 'id_example', attributes: KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogItemUpdateJobCreateQuery |
3563
+ catalog_item_update_job_create_query = KlaviyoAPI::CatalogItemUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResource.new({type: 'catalog-item-bulk-update-job', attributes: KlaviyoAPI::CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.new({items: [KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new({type: 'catalog-item', id: '$custom:::$default:::SAMPLE-DATA-ITEM-1', attributes: KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogItemUpdateJobCreateQuery |
3564
3564
 
3565
3565
  begin
3566
3566
  # Spawn Update Items Job
@@ -3615,7 +3615,7 @@ end
3615
3615
 
3616
3616
  Spawn Update Variants Job
3617
3617
 
3618
- 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`
3618
+ 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`
3619
3619
 
3620
3620
  ### Examples
3621
3621
 
@@ -3631,7 +3631,7 @@ KlaviyoAPI.configure do |config|
3631
3631
  end
3632
3632
 
3633
3633
  api_instance = KlaviyoAPI::CatalogsApi.new
3634
- catalog_variant_update_job_create_query = KlaviyoAPI::CatalogVariantUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-update-job', attributes: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new({type: 'catalog-variant', id: 'id_example', attributes: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogVariantUpdateJobCreateQuery |
3634
+ catalog_variant_update_job_create_query = KlaviyoAPI::CatalogVariantUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResource.new({type: 'catalog-variant-bulk-update-job', attributes: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.new({variants: [KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new({type: 'catalog-variant', id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', attributes: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new})]})})}) # CatalogVariantUpdateJobCreateQuery |
3635
3635
 
3636
3636
  begin
3637
3637
  # Spawn Update Variants Job
@@ -3702,8 +3702,8 @@ KlaviyoAPI.configure do |config|
3702
3702
  end
3703
3703
 
3704
3704
  api_instance = KlaviyoAPI::CatalogsApi.new
3705
- id = 'id_example' # String | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
3706
- catalog_category_update_query = KlaviyoAPI::CatalogCategoryUpdateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new({type: 'catalog-category', id: 'id_example', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new})}) # CatalogCategoryUpdateQuery |
3705
+ id = '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL' # String | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
3706
+ catalog_category_update_query = KlaviyoAPI::CatalogCategoryUpdateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new({type: 'catalog-category', id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new})}) # CatalogCategoryUpdateQuery |
3707
3707
 
3708
3708
  begin
3709
3709
  # Update Catalog Category
@@ -3736,7 +3736,7 @@ end
3736
3736
 
3737
3737
  | Name | Type | Description | Notes |
3738
3738
  | ---- | ---- | ----------- | ----- |
3739
- | **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. | |
3739
+ | **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;. | |
3740
3740
  | **catalog_category_update_query** | [**CatalogCategoryUpdateQuery**](CatalogCategoryUpdateQuery.md) | | |
3741
3741
 
3742
3742
  ### Return type
@@ -3849,8 +3849,8 @@ KlaviyoAPI.configure do |config|
3849
3849
  end
3850
3850
 
3851
3851
  api_instance = KlaviyoAPI::CatalogsApi.new
3852
- id = 'id_example' # String | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
3853
- catalog_item_update_query = KlaviyoAPI::CatalogItemUpdateQuery.new({data: KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new({type: 'catalog-item', id: 'id_example', attributes: KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new})}) # CatalogItemUpdateQuery |
3852
+ id = '$custom:::$default:::SAMPLE-DATA-ITEM-1' # String | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
3853
+ catalog_item_update_query = KlaviyoAPI::CatalogItemUpdateQuery.new({data: KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new({type: 'catalog-item', id: '$custom:::$default:::SAMPLE-DATA-ITEM-1', attributes: KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new})}) # CatalogItemUpdateQuery |
3854
3854
 
3855
3855
  begin
3856
3856
  # Update Catalog Item
@@ -3883,7 +3883,7 @@ end
3883
3883
 
3884
3884
  | Name | Type | Description | Notes |
3885
3885
  | ---- | ---- | ----------- | ----- |
3886
- | **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. | |
3886
+ | **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;. | |
3887
3887
  | **catalog_item_update_query** | [**CatalogItemUpdateQuery**](CatalogItemUpdateQuery.md) | | |
3888
3888
 
3889
3889
  ### Return type
@@ -3996,8 +3996,8 @@ KlaviyoAPI.configure do |config|
3996
3996
  end
3997
3997
 
3998
3998
  api_instance = KlaviyoAPI::CatalogsApi.new
3999
- id = 'id_example' # String | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming.
4000
- catalog_variant_update_query = KlaviyoAPI::CatalogVariantUpdateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new({type: 'catalog-variant', id: 'id_example', attributes: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new})}) # CatalogVariantUpdateQuery |
3999
+ id = '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM' # String | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
4000
+ catalog_variant_update_query = KlaviyoAPI::CatalogVariantUpdateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new({type: 'catalog-variant', id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', attributes: KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new})}) # CatalogVariantUpdateQuery |
4001
4001
 
4002
4002
  begin
4003
4003
  # Update Catalog Variant
@@ -4030,7 +4030,7 @@ end
4030
4030
 
4031
4031
  | Name | Type | Description | Notes |
4032
4032
  | ---- | ---- | ----------- | ----- |
4033
- | **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. | |
4033
+ | **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;. | |
4034
4034
  | **catalog_variant_update_query** | [**CatalogVariantUpdateQuery**](CatalogVariantUpdateQuery.md) | | |
4035
4035
 
4036
4036
  ### Return type