klaviyo-api-sdk 1.1.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1107) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +507 -170
  3. data/docs/CampaignCloneQuery.md +1 -1
  4. data/docs/CampaignCloneQueryResourceObject.md +20 -0
  5. data/docs/CampaignCloneQueryResourceObjectAttributes.md +20 -0
  6. data/docs/CampaignCreateQuery.md +1 -1
  7. data/docs/CampaignCreateQueryResourceObject.md +20 -0
  8. data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
  9. data/docs/CampaignEnum.md +15 -0
  10. data/docs/CampaignMessageAssignTemplateQuery.md +1 -1
  11. data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +20 -0
  12. data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +20 -0
  13. data/docs/CampaignMessageEnum.md +15 -0
  14. data/docs/CampaignMessagePartialUpdateQuery.md +1 -1
  15. data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
  16. data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +20 -0
  17. data/docs/CampaignPartialUpdateQuery.md +1 -1
  18. data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
  19. data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
  20. data/docs/CampaignRecipientEstimationEnum.md +15 -0
  21. data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
  22. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
  23. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +18 -0
  24. data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
  25. data/docs/CampaignSendJobCreateQuery.md +1 -1
  26. data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
  27. data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +18 -0
  28. data/docs/CampaignSendJobEnum.md +15 -0
  29. data/docs/CampaignSendJobPartialUpdateQuery.md +1 -1
  30. data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
  31. data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
  32. data/docs/CampaignsApi.md +1275 -0
  33. data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
  34. data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
  35. data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
  36. data/docs/CatalogCategoryCreateJobCreateQuery.md +1 -1
  37. data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
  38. data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  39. data/docs/CatalogCategoryCreateQuery.md +1 -1
  40. data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
  41. data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
  42. data/docs/CatalogCategoryDeleteJobCreateQuery.md +1 -1
  43. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
  44. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  45. data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
  46. data/docs/CatalogCategoryEnum.md +15 -0
  47. data/docs/CatalogCategoryItemOp.md +1 -1
  48. data/docs/CatalogCategoryUpdateJobCreateQuery.md +1 -1
  49. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
  50. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  51. data/docs/CatalogCategoryUpdateQuery.md +1 -1
  52. data/docs/CatalogCategoryUpdateQueryResourceObject.md +24 -0
  53. data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +18 -0
  54. data/docs/CatalogItemBulkCreateJobEnum.md +15 -0
  55. data/docs/CatalogItemBulkDeleteJobEnum.md +15 -0
  56. data/docs/CatalogItemBulkUpdateJobEnum.md +15 -0
  57. data/docs/CatalogItemCategoryOp.md +1 -1
  58. data/docs/CatalogItemCreateJobCreateQuery.md +1 -1
  59. data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
  60. data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  61. data/docs/CatalogItemCreateQuery.md +1 -1
  62. data/docs/CatalogItemCreateQueryResourceObject.md +22 -0
  63. data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +40 -0
  64. data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +18 -0
  65. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +18 -0
  66. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +20 -0
  67. data/docs/CatalogItemDeleteJobCreateQuery.md +1 -1
  68. data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
  69. data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  70. data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
  71. data/docs/CatalogItemEnum.md +15 -0
  72. data/docs/CatalogItemUpdateJobCreateQuery.md +1 -1
  73. data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
  74. data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  75. data/docs/CatalogItemUpdateQuery.md +1 -1
  76. data/docs/CatalogItemUpdateQueryResourceObject.md +24 -0
  77. data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +34 -0
  78. data/docs/CatalogJobErrorPayload.md +8 -8
  79. data/docs/CatalogVariantBulkCreateJobEnum.md +15 -0
  80. data/docs/CatalogVariantBulkDeleteJobEnum.md +15 -0
  81. data/docs/CatalogVariantBulkUpdateJobEnum.md +15 -0
  82. data/docs/CatalogVariantCreateJobCreateQuery.md +1 -1
  83. data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
  84. data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  85. data/docs/CatalogVariantCreateQuery.md +1 -1
  86. data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
  87. data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
  88. data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
  89. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItems.md +18 -0
  90. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.md +20 -0
  91. data/docs/CatalogVariantDeleteJobCreateQuery.md +1 -1
  92. data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
  93. data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  94. data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
  95. data/docs/CatalogVariantEnum.md +15 -0
  96. data/docs/CatalogVariantUpdateJobCreateQuery.md +1 -1
  97. data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
  98. data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  99. data/docs/CatalogVariantUpdateQuery.md +1 -1
  100. data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
  101. data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
  102. data/docs/CatalogsApi.md +340 -356
  103. data/docs/ClientApi.md +3 -3
  104. data/docs/CollectionLinks.md +26 -0
  105. data/docs/DataPrivacyApi.md +1 -1
  106. data/docs/DataPrivacyCreateDeletionJobQuery.md +1 -1
  107. data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
  108. data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +22 -0
  109. data/docs/DataPrivacyDeletionJobEnum.md +15 -0
  110. data/docs/EmailChannel.md +18 -0
  111. data/docs/EmailMarketing.md +32 -0
  112. data/docs/EmailMarketingListSuppression.md +22 -0
  113. data/docs/EmailMarketingSuppression.md +20 -0
  114. data/docs/ErrorSource.md +1 -1
  115. data/docs/EventCreateQuery.md +1 -1
  116. data/docs/EventCreateQueryResourceObject.md +20 -0
  117. data/docs/EventCreateQueryResourceObjectAttributes.md +28 -0
  118. data/docs/EventEnum.md +15 -0
  119. data/docs/EventsApi.md +114 -42
  120. data/docs/FlowActionEnum.md +15 -0
  121. data/docs/FlowEnum.md +15 -0
  122. data/docs/FlowMessageEnum.md +15 -0
  123. data/docs/FlowUpdateQuery.md +1 -1
  124. data/docs/FlowUpdateQueryResourceObject.md +22 -0
  125. data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
  126. data/docs/FlowsApi.md +254 -102
  127. data/docs/GetCampaigns4XXResponse.md +18 -0
  128. data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
  129. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
  130. data/docs/ListCreateQuery.md +1 -1
  131. data/docs/ListCreateQueryResourceObject.md +20 -0
  132. data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
  133. data/docs/ListEnum.md +15 -0
  134. data/docs/ListPartialUpdateQuery.md +1 -1
  135. data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
  136. data/docs/ListsApi.md +135 -65
  137. data/docs/MetricAggregateEnum.md +15 -0
  138. data/docs/MetricAggregateQuery.md +1 -1
  139. data/docs/MetricAggregateQueryResourceObject.md +20 -0
  140. data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
  141. data/docs/MetricEnum.md +15 -0
  142. data/docs/MetricsApi.md +10 -10
  143. data/docs/ObjectLinks.md +18 -0
  144. data/docs/OnsiteProfileCreateQuery.md +1 -1
  145. data/docs/OnsiteProfileCreateQueryResourceObject.md +22 -0
  146. data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +38 -0
  147. data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
  148. data/docs/OnsiteSubscriptionCreateQuery.md +1 -1
  149. data/docs/OnsiteSubscriptionCreateQueryResourceObject.md +20 -0
  150. data/docs/OnsiteSubscriptionCreateQueryResourceObjectAttributes.md +26 -0
  151. data/docs/PredictiveAnalytics.md +34 -0
  152. data/docs/ProfileAggregateEnum.md +15 -0
  153. data/docs/ProfileCreateQuery.md +1 -1
  154. data/docs/ProfileCreateQueryResourceObject.md +20 -0
  155. data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
  156. data/docs/ProfileEnum.md +15 -0
  157. data/docs/ProfileLocation.md +15 -15
  158. data/docs/ProfileLocationLongitude.md +49 -0
  159. data/docs/ProfilePartialUpdateQuery.md +1 -1
  160. data/docs/ProfilePartialUpdateQueryResourceObject.md +22 -0
  161. data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
  162. data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
  163. data/docs/ProfileUnsubscriptionBulkCreateJobEnum.md +15 -0
  164. data/docs/ProfileUnsuppressionBulkCreateJobEnum.md +15 -0
  165. data/docs/ProfilesApi.md +140 -56
  166. data/docs/SMSChannel.md +18 -0
  167. data/docs/SMSMarketing.md +24 -0
  168. data/docs/STOScheduleOptions.md +18 -0
  169. data/docs/SegmentEnum.md +15 -0
  170. data/docs/SegmentPartialUpdateQuery.md +1 -1
  171. data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
  172. data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
  173. data/docs/SegmentsApi.md +107 -33
  174. data/docs/SendOptionsSubObject.md +1 -3
  175. data/docs/SendStrategySubObject.md +4 -2
  176. data/docs/Subscription.md +8 -4
  177. data/docs/SubscriptionChannels.md +20 -0
  178. data/docs/SubscriptionCreateJobCreateQuery.md +1 -1
  179. data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +20 -0
  180. data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +22 -0
  181. data/docs/SubscriptionEnum.md +15 -0
  182. data/docs/Subscriptions.md +20 -0
  183. data/docs/Suppression.md +1 -1
  184. data/docs/SuppressionCreateJobCreateQuery.md +1 -1
  185. data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
  186. data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  187. data/docs/TagCampaignOp.md +18 -0
  188. data/docs/TagCampaignOpDataInner.md +20 -0
  189. data/docs/TagCreateQuery.md +1 -1
  190. data/docs/TagCreateQueryResourceObject.md +20 -0
  191. data/docs/TagCreateQueryResourceObjectAttributes.md +20 -0
  192. data/docs/TagEnum.md +15 -0
  193. data/docs/TagFlowOp.md +18 -0
  194. data/docs/TagFlowOpDataInner.md +20 -0
  195. data/docs/TagGroupCreateQuery.md +1 -1
  196. data/docs/TagGroupCreateQueryResourceObject.md +20 -0
  197. data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
  198. data/docs/TagGroupEnum.md +15 -0
  199. data/docs/TagGroupUpdateQuery.md +1 -1
  200. data/docs/TagGroupUpdateQueryResourceObject.md +22 -0
  201. data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +20 -0
  202. data/docs/TagListOp.md +18 -0
  203. data/docs/TagListOpDataInner.md +20 -0
  204. data/docs/TagUpdateQuery.md +1 -1
  205. data/docs/TagUpdateQueryResourceObject.md +22 -0
  206. data/docs/TagUpdateQueryResourceObjectAttributes.md +18 -0
  207. data/docs/TagsApi.md +894 -176
  208. data/docs/TemplateCloneQuery.md +1 -1
  209. data/docs/TemplateCloneQueryResourceObject.md +20 -0
  210. data/docs/TemplateCloneQueryResourceObjectAttributes.md +22 -0
  211. data/docs/TemplateCreateQuery.md +1 -1
  212. data/docs/TemplateCreateQueryResourceObject.md +20 -0
  213. data/docs/TemplateCreateQueryResourceObjectAttributes.md +32 -0
  214. data/docs/TemplateEnum.md +15 -0
  215. data/docs/TemplateRenderQuery.md +1 -1
  216. data/docs/TemplateRenderQueryResourceObject.md +20 -0
  217. data/docs/TemplateRenderQueryResourceObjectAttributes.md +22 -0
  218. data/docs/TemplateUpdateQuery.md +1 -1
  219. data/docs/TemplateUpdateQueryResourceObject.md +22 -0
  220. data/docs/TemplateUpdateQueryResourceObjectAttributes.md +30 -0
  221. data/docs/TemplatesApi.md +15 -15
  222. data/docs/TestApiAnalyticsSampleEnum.md +15 -0
  223. data/docs/TestListEnum.md +15 -0
  224. data/docs/ThrottledScheduleOptions.md +1 -1
  225. data/docs/UnsubscriptionCreateJobCreateQuery.md +1 -1
  226. data/docs/UnsubscriptionCreateJobCreateQueryResourceObject.md +20 -0
  227. data/docs/UnsubscriptionCreateJobCreateQueryResourceObjectAttributes.md +22 -0
  228. data/docs/UnsuppressionCreateJobCreateQuery.md +1 -1
  229. data/docs/UnsuppressionCreateJobCreateQueryResourceObject.md +20 -0
  230. data/docs/UnsuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  231. data/klaviyo-api-sdk.gemspec +2 -2
  232. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1269 -0
  233. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +385 -473
  234. data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
  235. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  236. data/lib/klaviyo-api-sdk/api/events_api.rb +118 -57
  237. data/lib/klaviyo-api-sdk/api/flows_api.rb +256 -137
  238. data/lib/klaviyo-api-sdk/api/lists_api.rb +138 -96
  239. data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
  240. data/lib/klaviyo-api-sdk/api/profiles_api.rb +153 -68
  241. data/lib/klaviyo-api-sdk/api/segments_api.rb +110 -46
  242. data/lib/klaviyo-api-sdk/api/tags_api.rb +831 -159
  243. data/lib/klaviyo-api-sdk/api/templates_api.rb +20 -20
  244. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  245. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  246. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +2 -2
  249. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +238 -0
  250. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +235 -0
  251. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +2 -2
  252. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +238 -0
  253. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +291 -0
  254. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +36 -0
  255. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +2 -2
  256. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +238 -0
  257. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +240 -0
  258. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +36 -0
  259. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +2 -2
  260. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +253 -0
  261. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +229 -0
  262. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +2 -2
  263. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +253 -0
  264. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +256 -0
  265. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_enum.rb +36 -0
  266. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
  267. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +238 -0
  268. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +225 -0
  269. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +36 -0
  270. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +2 -2
  271. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +238 -0
  272. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +225 -0
  273. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +36 -0
  274. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +2 -2
  275. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +253 -0
  276. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +225 -0
  277. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +36 -0
  278. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +36 -0
  279. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +36 -0
  280. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
  281. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +238 -0
  282. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +227 -0
  283. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
  284. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +247 -0
  285. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +296 -0
  286. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
  287. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +238 -0
  288. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +227 -0
  289. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +239 -0
  290. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +36 -0
  291. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  292. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
  293. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +238 -0
  294. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +227 -0
  295. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
  296. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +262 -0
  297. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +220 -0
  298. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +36 -0
  299. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +36 -0
  300. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +36 -0
  301. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  302. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
  303. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +238 -0
  304. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +227 -0
  305. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
  306. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +247 -0
  307. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +390 -0
  308. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +219 -0
  309. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +226 -0
  310. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +272 -0
  311. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
  312. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +238 -0
  313. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +227 -0
  314. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +239 -0
  315. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +36 -0
  316. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
  317. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +238 -0
  318. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +227 -0
  319. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
  320. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +262 -0
  321. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +302 -0
  322. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -1
  323. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +36 -0
  324. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +36 -0
  325. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +36 -0
  326. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
  327. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +238 -0
  328. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +227 -0
  329. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
  330. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +247 -0
  331. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +447 -0
  332. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
  333. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_items.rb +226 -0
  334. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_items_data_inner.rb +272 -0
  335. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
  336. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +238 -0
  337. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +227 -0
  338. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +239 -0
  339. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +36 -0
  340. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
  341. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +238 -0
  342. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +227 -0
  343. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
  344. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +253 -0
  345. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +366 -0
  346. data/lib/klaviyo-api-sdk/models/collection_links.rb +260 -0
  347. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
  348. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +2 -2
  349. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +238 -0
  350. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +240 -0
  351. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +36 -0
  352. data/lib/klaviyo-api-sdk/models/email_channel.rb +219 -0
  353. data/lib/klaviyo-api-sdk/models/email_marketing.rb +298 -0
  354. data/lib/klaviyo-api-sdk/models/email_marketing_list_suppression.rb +255 -0
  355. data/lib/klaviyo-api-sdk/models/email_marketing_suppression.rb +240 -0
  356. data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
  358. data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
  359. data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
  360. data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +238 -0
  361. data/lib/klaviyo-api-sdk/models/event_create_query_resource_object_attributes.rb +284 -0
  362. data/lib/klaviyo-api-sdk/models/event_enum.rb +36 -0
  363. data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +36 -0
  364. data/lib/klaviyo-api-sdk/models/flow_enum.rb +36 -0
  365. data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +36 -0
  366. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
  367. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +253 -0
  368. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +225 -0
  369. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
  370. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
  371. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
  372. data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
  373. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +238 -0
  374. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +225 -0
  375. data/lib/klaviyo-api-sdk/models/list_enum.rb +36 -0
  376. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  377. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  378. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  379. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
  380. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +253 -0
  381. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +36 -0
  382. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
  383. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +238 -0
  384. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +388 -0
  385. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
  386. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
  387. data/lib/klaviyo-api-sdk/models/metric_enum.rb +36 -0
  388. data/lib/klaviyo-api-sdk/models/object_links.rb +224 -0
  389. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +2 -2
  390. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +247 -0
  391. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +318 -0
  392. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  393. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
  394. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +2 -2
  395. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object.rb +238 -0
  396. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_resource_object_attributes.rb +265 -0
  397. data/lib/klaviyo-api-sdk/models/predictive_analytics.rb +300 -0
  398. data/lib/klaviyo-api-sdk/models/profile_aggregate_enum.rb +36 -0
  399. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
  400. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +238 -0
  401. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +309 -0
  402. data/lib/klaviyo-api-sdk/models/profile_enum.rb +36 -0
  403. data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
  404. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
  405. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
  406. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
  407. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +253 -0
  408. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +36 -0
  409. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +36 -0
  410. data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +36 -0
  411. data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +36 -0
  412. data/lib/klaviyo-api-sdk/models/segment_enum.rb +36 -0
  413. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
  414. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +252 -0
  415. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +224 -0
  416. data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
  417. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
  418. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
  419. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
  420. data/lib/klaviyo-api-sdk/models/sms_channel.rb +219 -0
  421. data/lib/klaviyo-api-sdk/models/sms_marketing.rb +270 -0
  422. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
  423. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
  424. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
  425. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  426. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
  427. data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
  428. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
  429. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
  430. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +238 -0
  431. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +252 -0
  432. data/lib/klaviyo-api-sdk/models/subscription_enum.rb +36 -0
  433. data/lib/klaviyo-api-sdk/models/subscriptions.rb +228 -0
  434. data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
  435. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
  436. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +238 -0
  437. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +227 -0
  438. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +226 -0
  439. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +272 -0
  440. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +2 -2
  441. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +238 -0
  442. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +235 -0
  443. data/lib/klaviyo-api-sdk/models/tag_enum.rb +36 -0
  444. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +226 -0
  445. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +272 -0
  446. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +2 -2
  447. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +238 -0
  448. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +234 -0
  449. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +36 -0
  450. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +2 -2
  451. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +253 -0
  452. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +236 -0
  453. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +226 -0
  454. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +272 -0
  455. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  456. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  457. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +2 -2
  458. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +253 -0
  459. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +225 -0
  460. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
  461. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +238 -0
  462. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +247 -0
  463. data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
  464. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +238 -0
  465. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +272 -0
  466. data/lib/klaviyo-api-sdk/models/template_enum.rb +36 -0
  467. data/lib/klaviyo-api-sdk/models/template_render_query.rb +2 -2
  468. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +238 -0
  469. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +252 -0
  470. data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
  471. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +253 -0
  472. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +252 -0
  473. data/lib/klaviyo-api-sdk/models/test_api_analytics_sample_enum.rb +36 -0
  474. data/lib/klaviyo-api-sdk/models/test_list_enum.rb +36 -0
  475. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  476. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
  477. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
  478. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +238 -0
  479. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object_attributes.rb +244 -0
  480. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
  481. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +238 -0
  482. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object_attributes.rb +227 -0
  483. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +1 -1
  484. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  485. data/lib/klaviyo-api-sdk/version.rb +1 -1
  486. data/lib/klaviyo-api-sdk.rb +162 -123
  487. data/spec/api/campaigns_api_spec.rb +255 -0
  488. data/spec/api/catalogs_api_spec.rb +162 -170
  489. data/spec/api/client_api_spec.rb +3 -3
  490. data/spec/api/data_privacy_api_spec.rb +1 -1
  491. data/spec/api/events_api_spec.rb +33 -21
  492. data/spec/api/flows_api_spec.rb +76 -49
  493. data/spec/api/lists_api_spec.rb +38 -27
  494. data/spec/api/metrics_api_spec.rb +8 -8
  495. data/spec/api/profiles_api_spec.rb +41 -25
  496. data/spec/api/segments_api_spec.rb +30 -17
  497. data/spec/api/tags_api_spec.rb +155 -33
  498. data/spec/api/templates_api_spec.rb +12 -14
  499. data/spec/api_client_spec.rb +1 -1
  500. data/spec/configuration_spec.rb +1 -1
  501. data/spec/models/audiences_sub_object_spec.rb +1 -1
  502. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +40 -0
  503. data/spec/models/campaign_clone_query_resource_object_spec.rb +40 -0
  504. data/spec/models/campaign_clone_query_spec.rb +1 -1
  505. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
  506. data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
  507. data/spec/models/campaign_create_query_spec.rb +1 -1
  508. data/spec/models/campaign_enum_spec.rb +28 -0
  509. data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +40 -0
  510. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +40 -0
  511. data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
  512. data/spec/models/campaign_message_enum_spec.rb +28 -0
  513. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +40 -0
  514. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +46 -0
  515. data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
  516. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +58 -0
  517. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +46 -0
  518. data/spec/models/campaign_partial_update_query_spec.rb +1 -1
  519. data/spec/models/campaign_recipient_estimation_enum_spec.rb +28 -0
  520. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +34 -0
  521. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
  522. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
  523. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
  524. data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +34 -0
  525. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
  526. data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
  527. data/spec/models/campaign_send_job_enum_spec.rb +28 -0
  528. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +34 -0
  529. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +46 -0
  530. data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
  531. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +28 -0
  532. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +28 -0
  533. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +28 -0
  534. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  535. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +40 -0
  536. data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
  537. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
  538. data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
  539. data/spec/models/catalog_category_create_query_spec.rb +1 -1
  540. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  541. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +40 -0
  542. data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
  543. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +40 -0
  544. data/spec/models/catalog_category_enum_spec.rb +28 -0
  545. data/spec/models/catalog_category_item_op_spec.rb +1 -1
  546. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  547. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +40 -0
  548. data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
  549. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +34 -0
  550. data/spec/models/catalog_category_update_query_resource_object_spec.rb +52 -0
  551. data/spec/models/catalog_category_update_query_spec.rb +1 -1
  552. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +28 -0
  553. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +28 -0
  554. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +28 -0
  555. data/spec/models/catalog_item_category_op_spec.rb +1 -1
  556. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  557. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +40 -0
  558. data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
  559. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +104 -0
  560. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +44 -0
  561. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +34 -0
  562. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +34 -0
  563. data/spec/models/catalog_item_create_query_resource_object_spec.rb +46 -0
  564. data/spec/models/catalog_item_create_query_spec.rb +1 -1
  565. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  566. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +40 -0
  567. data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
  568. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +40 -0
  569. data/spec/models/catalog_item_enum_spec.rb +28 -0
  570. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  571. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +40 -0
  572. data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
  573. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +82 -0
  574. data/spec/models/catalog_item_update_query_resource_object_spec.rb +52 -0
  575. data/spec/models/catalog_item_update_query_spec.rb +1 -1
  576. data/spec/models/catalog_job_error_payload_spec.rb +1 -1
  577. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +28 -0
  578. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +28 -0
  579. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +28 -0
  580. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  581. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +40 -0
  582. data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
  583. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
  584. data/spec/models/catalog_variant_create_query_resource_object_relationships_items_data_inner_spec.rb +44 -0
  585. data/spec/models/catalog_variant_create_query_resource_object_relationships_items_spec.rb +34 -0
  586. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +34 -0
  587. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +46 -0
  588. data/spec/models/catalog_variant_create_query_spec.rb +1 -1
  589. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  590. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +40 -0
  591. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
  592. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +40 -0
  593. data/spec/models/catalog_variant_enum_spec.rb +28 -0
  594. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  595. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +40 -0
  596. data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
  597. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +104 -0
  598. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +46 -0
  599. data/spec/models/catalog_variant_update_query_spec.rb +1 -1
  600. data/spec/models/collection_links_spec.rb +58 -0
  601. data/spec/models/content_sub_object_spec.rb +1 -1
  602. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +46 -0
  603. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +40 -0
  604. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
  605. data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
  606. data/spec/models/email_channel_spec.rb +34 -0
  607. data/spec/models/email_marketing_list_suppression_spec.rb +46 -0
  608. data/spec/models/email_marketing_spec.rb +76 -0
  609. data/spec/models/email_marketing_suppression_spec.rb +40 -0
  610. data/spec/models/email_message_content_spec.rb +1 -1
  611. data/spec/models/email_tracking_options_spec.rb +1 -1
  612. data/spec/models/error_source_spec.rb +1 -1
  613. data/spec/models/event_create_query_resource_object_attributes_spec.rb +64 -0
  614. data/spec/models/event_create_query_resource_object_spec.rb +40 -0
  615. data/spec/models/event_create_query_spec.rb +1 -1
  616. data/spec/models/event_enum_spec.rb +28 -0
  617. data/spec/models/flow_action_enum_spec.rb +28 -0
  618. data/spec/models/flow_enum_spec.rb +28 -0
  619. data/spec/models/flow_message_enum_spec.rb +28 -0
  620. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +34 -0
  621. data/spec/models/flow_update_query_resource_object_spec.rb +46 -0
  622. data/spec/models/flow_update_query_spec.rb +1 -1
  623. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
  624. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
  625. data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
  626. data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
  627. data/spec/models/list_create_query_resource_object_spec.rb +40 -0
  628. data/spec/models/list_create_query_spec.rb +1 -1
  629. data/spec/models/list_enum_spec.rb +28 -0
  630. data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
  631. data/spec/models/list_members_add_query_spec.rb +1 -1
  632. data/spec/models/list_members_delete_query_spec.rb +1 -1
  633. data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
  634. data/spec/models/list_partial_update_query_spec.rb +1 -1
  635. data/spec/models/metric_aggregate_enum_spec.rb +28 -0
  636. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +104 -0
  637. data/spec/models/metric_aggregate_query_resource_object_spec.rb +40 -0
  638. data/spec/models/metric_aggregate_query_spec.rb +1 -1
  639. data/spec/models/metric_aggregate_row_dto_spec.rb +1 -1
  640. data/spec/models/metric_create_query_spec.rb +1 -1
  641. data/spec/models/metric_enum_spec.rb +28 -0
  642. data/spec/models/object_links_spec.rb +34 -0
  643. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +94 -0
  644. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +46 -0
  645. data/spec/models/onsite_profile_create_query_spec.rb +1 -1
  646. data/spec/models/onsite_profile_meta_identifiers_spec.rb +4 -4
  647. data/spec/models/onsite_profile_meta_spec.rb +1 -1
  648. data/spec/models/onsite_subscription_create_query_resource_object_attributes_spec.rb +58 -0
  649. data/spec/models/onsite_subscription_create_query_resource_object_spec.rb +40 -0
  650. data/spec/models/onsite_subscription_create_query_spec.rb +1 -1
  651. data/spec/models/predictive_analytics_spec.rb +82 -0
  652. data/spec/models/profile_aggregate_enum_spec.rb +28 -0
  653. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +88 -0
  654. data/spec/models/profile_create_query_resource_object_spec.rb +40 -0
  655. data/spec/models/profile_create_query_spec.rb +1 -1
  656. data/spec/models/profile_enum_spec.rb +28 -0
  657. data/spec/models/profile_location_latitude_spec.rb +1 -1
  658. data/spec/models/profile_location_longitude_spec.rb +31 -0
  659. data/spec/models/profile_location_spec.rb +1 -1
  660. data/spec/models/profile_partial_update_query_resource_object_spec.rb +46 -0
  661. data/spec/models/profile_partial_update_query_spec.rb +1 -1
  662. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
  663. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
  664. data/spec/models/profile_unsubscription_bulk_create_job_enum_spec.rb +28 -0
  665. data/spec/models/profile_unsuppression_bulk_create_job_enum_spec.rb +28 -0
  666. data/spec/models/segment_enum_spec.rb +28 -0
  667. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +34 -0
  668. data/spec/models/segment_partial_update_query_resource_object_spec.rb +46 -0
  669. data/spec/models/segment_partial_update_query_spec.rb +1 -1
  670. data/spec/models/send_options_spec.rb +1 -1
  671. data/spec/models/send_options_sub_object_spec.rb +1 -7
  672. data/spec/models/send_strategy_sub_object_spec.rb +7 -1
  673. data/spec/models/send_time_sub_object_spec.rb +1 -1
  674. data/spec/models/sms_channel_spec.rb +34 -0
  675. data/spec/models/sms_marketing_spec.rb +52 -0
  676. data/spec/models/sms_message_content_spec.rb +1 -1
  677. data/spec/models/sms_render_options_spec.rb +1 -1
  678. data/spec/models/sms_tracking_options_spec.rb +1 -1
  679. data/spec/models/static_schedule_options_spec.rb +1 -1
  680. data/spec/models/sto_schedule_options_spec.rb +34 -0
  681. data/spec/models/subscription_channels_spec.rb +48 -0
  682. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +46 -0
  683. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +40 -0
  684. data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
  685. data/spec/models/subscription_enum_spec.rb +28 -0
  686. data/spec/models/subscription_spec.rb +13 -1
  687. data/spec/models/subscriptions_spec.rb +40 -0
  688. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  689. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +40 -0
  690. data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
  691. data/spec/models/suppression_spec.rb +1 -1
  692. data/spec/models/tag_campaign_op_data_inner_spec.rb +44 -0
  693. data/spec/models/tag_campaign_op_spec.rb +34 -0
  694. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +40 -0
  695. data/spec/models/tag_create_query_resource_object_spec.rb +40 -0
  696. data/spec/models/tag_create_query_spec.rb +1 -1
  697. data/spec/models/tag_enum_spec.rb +28 -0
  698. data/spec/models/tag_flow_op_data_inner_spec.rb +44 -0
  699. data/spec/models/tag_flow_op_spec.rb +34 -0
  700. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +40 -0
  701. data/spec/models/tag_group_create_query_resource_object_spec.rb +40 -0
  702. data/spec/models/tag_group_create_query_spec.rb +1 -1
  703. data/spec/models/tag_group_enum_spec.rb +28 -0
  704. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +40 -0
  705. data/spec/models/tag_group_update_query_resource_object_spec.rb +46 -0
  706. data/spec/models/tag_group_update_query_spec.rb +1 -1
  707. data/spec/models/tag_list_op_data_inner_spec.rb +44 -0
  708. data/spec/models/tag_list_op_spec.rb +34 -0
  709. data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
  710. data/spec/models/tag_segment_op_spec.rb +1 -1
  711. data/spec/models/tag_update_query_resource_object_attributes_spec.rb +34 -0
  712. data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
  713. data/spec/models/tag_update_query_spec.rb +1 -1
  714. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +46 -0
  715. data/spec/models/template_clone_query_resource_object_spec.rb +40 -0
  716. data/spec/models/template_clone_query_spec.rb +1 -1
  717. data/spec/models/template_create_query_resource_object_attributes_spec.rb +58 -0
  718. data/spec/models/template_create_query_resource_object_spec.rb +40 -0
  719. data/spec/models/template_create_query_spec.rb +1 -1
  720. data/spec/models/template_enum_spec.rb +28 -0
  721. data/spec/models/template_render_query_resource_object_attributes_spec.rb +46 -0
  722. data/spec/models/template_render_query_resource_object_spec.rb +40 -0
  723. data/spec/models/template_render_query_spec.rb +1 -1
  724. data/spec/models/template_update_query_resource_object_attributes_spec.rb +52 -0
  725. data/spec/models/template_update_query_resource_object_spec.rb +46 -0
  726. data/spec/models/template_update_query_spec.rb +1 -1
  727. data/spec/models/test_api_analytics_sample_enum_spec.rb +28 -0
  728. data/spec/models/test_list_enum_spec.rb +28 -0
  729. data/spec/models/throttled_schedule_options_spec.rb +1 -1
  730. data/spec/models/tracking_options_sub_object_spec.rb +1 -1
  731. data/spec/models/unsubscription_create_job_create_query_resource_object_attributes_spec.rb +46 -0
  732. data/spec/models/unsubscription_create_job_create_query_resource_object_spec.rb +40 -0
  733. data/spec/models/unsubscription_create_job_create_query_spec.rb +1 -1
  734. data/spec/models/unsuppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  735. data/spec/models/unsuppression_create_job_create_query_resource_object_spec.rb +40 -0
  736. data/spec/models/unsuppression_create_job_create_query_spec.rb +1 -1
  737. data/spec/models/utm_param_info_spec.rb +1 -1
  738. data/spec/models/utm_params_sub_object_spec.rb +1 -1
  739. data/spec/spec_helper.rb +1 -1
  740. metadata +487 -370
  741. data/CHANGELOG.md +0 -31
  742. data/docs/CampaignCloneQueryAsSubResource.md +0 -20
  743. data/docs/CampaignCloneQueryAsSubResourceAttributes.md +0 -20
  744. data/docs/CampaignCreateQueryAsSubResource.md +0 -20
  745. data/docs/CampaignCreateQueryAsSubResourceAttributes.md +0 -28
  746. data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +0 -20
  747. data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +0 -20
  748. data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +0 -22
  749. data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +0 -20
  750. data/docs/CampaignPartialUpdateQueryAsSubResource.md +0 -22
  751. data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +0 -26
  752. data/docs/CampaignSendJobCreateQueryAsSubResource.md +0 -20
  753. data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +0 -18
  754. data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +0 -22
  755. data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +0 -18
  756. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +0 -20
  757. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  758. data/docs/CatalogCategoryCreateQueryAsSubResource.md +0 -22
  759. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +0 -24
  760. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +0 -20
  761. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  762. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +0 -20
  763. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +0 -20
  764. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  765. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +0 -24
  766. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +0 -18
  767. data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +0 -20
  768. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  769. data/docs/CatalogItemCreateQueryAsSubResource.md +0 -22
  770. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +0 -38
  771. data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +0 -18
  772. data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +0 -18
  773. data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +0 -20
  774. data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +0 -20
  775. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  776. data/docs/CatalogItemDeleteQueryAsSubResource.md +0 -20
  777. data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +0 -20
  778. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  779. data/docs/CatalogItemUpdateQueryAsSubResource.md +0 -24
  780. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +0 -32
  781. data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +0 -20
  782. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  783. data/docs/CatalogVariantCreateQueryAsSubResource.md +0 -22
  784. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +0 -46
  785. data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +0 -18
  786. data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +0 -18
  787. data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +0 -20
  788. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +0 -20
  789. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  790. data/docs/CatalogVariantDeleteQueryAsSubResource.md +0 -20
  791. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +0 -20
  792. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  793. data/docs/CatalogVariantUpdateQueryAsSubResource.md +0 -22
  794. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +0 -38
  795. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +0 -20
  796. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +0 -22
  797. data/docs/EventCreateQueryAsSubResource.md +0 -20
  798. data/docs/EventCreateQueryAsSubResourceAttributes.md +0 -28
  799. data/docs/FlowUpdateQueryAsSubResource.md +0 -22
  800. data/docs/FlowUpdateQueryAsSubResourceAttributes.md +0 -18
  801. data/docs/GetCatalogItems4XXResponse.md +0 -18
  802. data/docs/GetCatalogItems4XXResponseErrorsInner.md +0 -26
  803. data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +0 -20
  804. data/docs/IncludedCategories.md +0 -24
  805. data/docs/IncludedCategoriesAttributes.md +0 -22
  806. data/docs/IncludedFlowAction.md +0 -24
  807. data/docs/IncludedFlowActions.md +0 -24
  808. data/docs/IncludedFlowActionsAttributes.md +0 -32
  809. data/docs/IncludedFlowActionsAttributesTrackingOptions.md +0 -49
  810. data/docs/IncludedFlowMessages.md +0 -24
  811. data/docs/IncludedFlowMessagesAttributes.md +0 -26
  812. data/docs/IncludedFlowMessagesAttributesContent.md +0 -49
  813. data/docs/IncludedFlows.md +0 -24
  814. data/docs/IncludedFlowsAttributes.md +0 -28
  815. data/docs/IncludedItems.md +0 -24
  816. data/docs/IncludedItemsAttributes.md +0 -38
  817. data/docs/IncludedLists.md +0 -24
  818. data/docs/IncludedListsAttributes.md +0 -22
  819. data/docs/IncludedMetrics.md +0 -24
  820. data/docs/IncludedMetricsAttributes.md +0 -24
  821. data/docs/IncludedProfiles.md +0 -24
  822. data/docs/IncludedProfilesAttributes.md +0 -44
  823. data/docs/IncludedSegments.md +0 -24
  824. data/docs/IncludedVariants.md +0 -24
  825. data/docs/IncludedVariantsAttributes.md +0 -46
  826. data/docs/IncludedVariantsLinks.md +0 -18
  827. data/docs/ListCreateQueryAsSubResource.md +0 -20
  828. data/docs/ListCreateQueryAsSubResourceAttributes.md +0 -18
  829. data/docs/ListPartialUpdateQueryAsSubResource.md +0 -22
  830. data/docs/MetricAggregateQueryAsSubResource.md +0 -20
  831. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +0 -36
  832. data/docs/OnsiteProfileCreateQueryAsSubResource.md +0 -22
  833. data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +0 -20
  834. data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +0 -26
  835. data/docs/ProfileCreateQueryAsSubResource.md +0 -20
  836. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +0 -38
  837. data/docs/ProfilePartialUpdateQueryAsSubResource.md +0 -22
  838. data/docs/SegmentPartialUpdateQueryAsSubResource.md +0 -22
  839. data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
  840. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
  841. data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +0 -20
  842. data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  843. data/docs/TagCreateQueryAsSubResource.md +0 -20
  844. data/docs/TagCreateQueryAsSubResourceAttributes.md +0 -20
  845. data/docs/TagGroupCreateQueryAsSubResource.md +0 -20
  846. data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +0 -20
  847. data/docs/TagGroupUpdateQueryAsSubResource.md +0 -22
  848. data/docs/TagGroupUpdateQueryAsSubResourceAttributes.md +0 -20
  849. data/docs/TagUpdateQueryAsSubResource.md +0 -22
  850. data/docs/TagUpdateQueryAsSubResourceAttributes.md +0 -18
  851. data/docs/TemplateCloneQueryAsSubResource.md +0 -22
  852. data/docs/TemplateCloneQueryAsSubResourceAttributes.md +0 -22
  853. data/docs/TemplateCreateQueryAsSubResource.md +0 -20
  854. data/docs/TemplateCreateQueryAsSubResourceAttributes.md +0 -32
  855. data/docs/TemplateRenderQueryAsSubResource.md +0 -20
  856. data/docs/TemplateRenderQueryAsSubResourceAttributes.md +0 -22
  857. data/docs/TemplateUpdateQueryAsSubResource.md +0 -22
  858. data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +0 -30
  859. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
  860. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
  861. data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +0 -20
  862. data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  863. data/docs/V2TemplateRenderQueryAsSubResource.md +0 -18
  864. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +0 -272
  865. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +0 -235
  866. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +0 -272
  867. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +0 -291
  868. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +0 -272
  869. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +0 -240
  870. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +0 -287
  871. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +0 -229
  872. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +0 -287
  873. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +0 -256
  874. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +0 -272
  875. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +0 -225
  876. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +0 -287
  877. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +0 -225
  878. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +0 -272
  879. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +0 -226
  880. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +0 -281
  881. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +0 -293
  882. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +0 -272
  883. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
  884. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +0 -273
  885. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +0 -272
  886. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +0 -226
  887. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +0 -296
  888. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +0 -219
  889. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +0 -272
  890. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +0 -226
  891. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +0 -281
  892. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +0 -370
  893. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +0 -219
  894. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +0 -226
  895. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +0 -272
  896. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +0 -272
  897. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
  898. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +0 -273
  899. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +0 -272
  900. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +0 -226
  901. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +0 -296
  902. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +0 -284
  903. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +0 -272
  904. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +0 -226
  905. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +0 -281
  906. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +0 -439
  907. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +0 -219
  908. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +0 -226
  909. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +0 -272
  910. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +0 -272
  911. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +0 -226
  912. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +0 -273
  913. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +0 -272
  914. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +0 -226
  915. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +0 -287
  916. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +0 -346
  917. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +0 -272
  918. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +0 -240
  919. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +0 -272
  920. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +0 -284
  921. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +0 -286
  922. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +0 -224
  923. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +0 -226
  924. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +0 -275
  925. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner_source.rb +0 -228
  926. data/lib/klaviyo-api-sdk/models/included_categories.rb +0 -301
  927. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +0 -237
  928. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +0 -300
  929. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +0 -300
  930. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +0 -282
  931. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +0 -105
  932. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +0 -300
  933. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +0 -270
  934. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +0 -105
  935. data/lib/klaviyo-api-sdk/models/included_flows.rb +0 -300
  936. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +0 -264
  937. data/lib/klaviyo-api-sdk/models/included_items.rb +0 -300
  938. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +0 -311
  939. data/lib/klaviyo-api-sdk/models/included_lists.rb +0 -300
  940. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +0 -237
  941. data/lib/klaviyo-api-sdk/models/included_metrics.rb +0 -301
  942. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +0 -250
  943. data/lib/klaviyo-api-sdk/models/included_profiles.rb +0 -300
  944. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +0 -336
  945. data/lib/klaviyo-api-sdk/models/included_segments.rb +0 -300
  946. data/lib/klaviyo-api-sdk/models/included_variants.rb +0 -300
  947. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +0 -382
  948. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +0 -224
  949. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +0 -272
  950. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +0 -224
  951. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +0 -286
  952. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +0 -272
  953. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +0 -386
  954. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +0 -281
  955. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +0 -272
  956. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +0 -265
  957. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +0 -272
  958. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +0 -309
  959. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +0 -286
  960. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +0 -286
  961. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +0 -272
  962. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +0 -252
  963. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +0 -272
  964. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +0 -227
  965. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +0 -272
  966. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +0 -235
  967. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +0 -272
  968. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +0 -234
  969. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +0 -287
  970. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +0 -236
  971. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +0 -287
  972. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +0 -225
  973. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +0 -283
  974. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +0 -247
  975. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +0 -272
  976. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +0 -272
  977. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +0 -272
  978. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +0 -252
  979. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +0 -287
  980. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +0 -252
  981. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +0 -272
  982. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +0 -244
  983. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +0 -272
  984. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +0 -227
  985. data/lib/klaviyo-api-sdk/models/v2_template_render_query_as_sub_resource.rb +0 -221
  986. data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +0 -40
  987. data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +0 -44
  988. data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +0 -64
  989. data/spec/models/campaign_create_query_as_sub_resource_spec.rb +0 -44
  990. data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +0 -40
  991. data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +0 -44
  992. data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +0 -40
  993. data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +0 -50
  994. data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +0 -58
  995. data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +0 -50
  996. data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  997. data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +0 -44
  998. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
  999. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +0 -50
  1000. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1001. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +0 -44
  1002. data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +0 -56
  1003. data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +0 -50
  1004. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1005. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  1006. data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +0 -44
  1007. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1008. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +0 -44
  1009. data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +0 -34
  1010. data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +0 -56
  1011. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1012. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +0 -44
  1013. data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +0 -98
  1014. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +0 -44
  1015. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +0 -34
  1016. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +0 -34
  1017. data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +0 -50
  1018. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1019. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  1020. data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +0 -44
  1021. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1022. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +0 -44
  1023. data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +0 -76
  1024. data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +0 -56
  1025. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1026. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +0 -44
  1027. data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +0 -126
  1028. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +0 -44
  1029. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +0 -34
  1030. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +0 -34
  1031. data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +0 -50
  1032. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1033. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  1034. data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +0 -44
  1035. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1036. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +0 -44
  1037. data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +0 -98
  1038. data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +0 -50
  1039. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +0 -46
  1040. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +0 -44
  1041. data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +0 -64
  1042. data/spec/models/event_create_query_as_sub_resource_spec.rb +0 -44
  1043. data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +0 -34
  1044. data/spec/models/flow_update_query_as_sub_resource_spec.rb +0 -50
  1045. data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +0 -40
  1046. data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +0 -58
  1047. data/spec/models/get_catalog_items4_xx_response_spec.rb +0 -34
  1048. data/spec/models/included_categories_attributes_spec.rb +0 -46
  1049. data/spec/models/included_categories_spec.rb +0 -56
  1050. data/spec/models/included_flow_action_spec.rb +0 -56
  1051. data/spec/models/included_flow_actions_attributes_spec.rb +0 -76
  1052. data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +0 -31
  1053. data/spec/models/included_flow_actions_spec.rb +0 -56
  1054. data/spec/models/included_flow_messages_attributes_content_spec.rb +0 -31
  1055. data/spec/models/included_flow_messages_attributes_spec.rb +0 -58
  1056. data/spec/models/included_flow_messages_spec.rb +0 -56
  1057. data/spec/models/included_flows_attributes_spec.rb +0 -64
  1058. data/spec/models/included_flows_spec.rb +0 -56
  1059. data/spec/models/included_items_attributes_spec.rb +0 -94
  1060. data/spec/models/included_items_spec.rb +0 -56
  1061. data/spec/models/included_lists_attributes_spec.rb +0 -46
  1062. data/spec/models/included_lists_spec.rb +0 -56
  1063. data/spec/models/included_metrics_attributes_spec.rb +0 -52
  1064. data/spec/models/included_metrics_spec.rb +0 -56
  1065. data/spec/models/included_profiles_attributes_spec.rb +0 -112
  1066. data/spec/models/included_profiles_spec.rb +0 -56
  1067. data/spec/models/included_segments_spec.rb +0 -56
  1068. data/spec/models/included_variants_attributes_spec.rb +0 -122
  1069. data/spec/models/included_variants_links_spec.rb +0 -34
  1070. data/spec/models/included_variants_spec.rb +0 -56
  1071. data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1072. data/spec/models/list_create_query_as_sub_resource_spec.rb +0 -44
  1073. data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +0 -50
  1074. data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +0 -104
  1075. data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +0 -44
  1076. data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +0 -50
  1077. data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +0 -58
  1078. data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +0 -44
  1079. data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +0 -94
  1080. data/spec/models/profile_create_query_as_sub_resource_spec.rb +0 -44
  1081. data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +0 -50
  1082. data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +0 -50
  1083. data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
  1084. data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
  1085. data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1086. data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
  1087. data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +0 -40
  1088. data/spec/models/tag_create_query_as_sub_resource_spec.rb +0 -44
  1089. data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +0 -40
  1090. data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +0 -44
  1091. data/spec/models/tag_group_update_query_as_sub_resource_attributes_spec.rb +0 -40
  1092. data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +0 -50
  1093. data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +0 -34
  1094. data/spec/models/tag_update_query_as_sub_resource_spec.rb +0 -50
  1095. data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +0 -46
  1096. data/spec/models/template_clone_query_as_sub_resource_spec.rb +0 -50
  1097. data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +0 -58
  1098. data/spec/models/template_create_query_as_sub_resource_spec.rb +0 -44
  1099. data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +0 -46
  1100. data/spec/models/template_render_query_as_sub_resource_spec.rb +0 -44
  1101. data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +0 -52
  1102. data/spec/models/template_update_query_as_sub_resource_spec.rb +0 -50
  1103. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
  1104. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
  1105. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  1106. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
  1107. data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +0 -34
data/docs/CatalogsApi.md CHANGED
@@ -5,22 +5,22 @@ All URIs are relative to *https://a.klaviyo.com*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_catalog_category**](CatalogsApi.md#create_catalog_category) | **POST** /api/catalog-categories/ | Create Catalog Category |
8
- | [**create_catalog_category_relationships**](CatalogsApi.md#create_catalog_category_relationships) | **POST** /api/catalog-categories/{id}/relationships/{related_resource}/ | Create Catalog Category Relationships |
8
+ | [**create_catalog_category_relationships_items**](CatalogsApi.md#create_catalog_category_relationships_items) | **POST** /api/catalog-categories/{id}/relationships/items/ | Create Catalog Category Relationships Items |
9
9
  | [**create_catalog_item**](CatalogsApi.md#create_catalog_item) | **POST** /api/catalog-items/ | Create Catalog Item |
10
- | [**create_catalog_item_relationships**](CatalogsApi.md#create_catalog_item_relationships) | **POST** /api/catalog-items/{id}/relationships/{related_resource}/ | Create Catalog Item Relationships |
10
+ | [**create_catalog_item_relationships_categories**](CatalogsApi.md#create_catalog_item_relationships_categories) | **POST** /api/catalog-items/{id}/relationships/categories/ | Create Catalog Item Relationships Categories |
11
11
  | [**create_catalog_variant**](CatalogsApi.md#create_catalog_variant) | **POST** /api/catalog-variants/ | Create Catalog Variant |
12
12
  | [**delete_catalog_category**](CatalogsApi.md#delete_catalog_category) | **DELETE** /api/catalog-categories/{id}/ | Delete Catalog Category |
13
- | [**delete_catalog_category_relationships**](CatalogsApi.md#delete_catalog_category_relationships) | **DELETE** /api/catalog-categories/{id}/relationships/{related_resource}/ | Delete Catalog Category Relationships |
13
+ | [**delete_catalog_category_relationships_items**](CatalogsApi.md#delete_catalog_category_relationships_items) | **DELETE** /api/catalog-categories/{id}/relationships/items/ | Delete Catalog Category Relationships Items |
14
14
  | [**delete_catalog_item**](CatalogsApi.md#delete_catalog_item) | **DELETE** /api/catalog-items/{id}/ | Delete Catalog Item |
15
- | [**delete_catalog_item_relationships**](CatalogsApi.md#delete_catalog_item_relationships) | **DELETE** /api/catalog-items/{id}/relationships/{related_resource}/ | Delete Catalog Item Relationships |
15
+ | [**delete_catalog_item_relationships_categories**](CatalogsApi.md#delete_catalog_item_relationships_categories) | **DELETE** /api/catalog-items/{id}/relationships/categories/ | Delete Catalog Item Relationships Categories |
16
16
  | [**delete_catalog_variant**](CatalogsApi.md#delete_catalog_variant) | **DELETE** /api/catalog-variants/{id}/ | Delete Catalog Variant |
17
17
  | [**get_catalog_categories**](CatalogsApi.md#get_catalog_categories) | **GET** /api/catalog-categories/ | Get Catalog Categories |
18
18
  | [**get_catalog_category**](CatalogsApi.md#get_catalog_category) | **GET** /api/catalog-categories/{id}/ | Get Catalog Category |
19
19
  | [**get_catalog_category_items**](CatalogsApi.md#get_catalog_category_items) | **GET** /api/catalog-categories/{category_id}/items/ | Get Catalog Category Items |
20
- | [**get_catalog_category_relationships**](CatalogsApi.md#get_catalog_category_relationships) | **GET** /api/catalog-categories/{id}/relationships/{related_resource}/ | Get Catalog Category Relationships |
20
+ | [**get_catalog_category_relationships_items**](CatalogsApi.md#get_catalog_category_relationships_items) | **GET** /api/catalog-categories/{id}/relationships/items/ | Get Catalog Category Relationships Items |
21
21
  | [**get_catalog_item**](CatalogsApi.md#get_catalog_item) | **GET** /api/catalog-items/{id}/ | Get Catalog Item |
22
22
  | [**get_catalog_item_categories**](CatalogsApi.md#get_catalog_item_categories) | **GET** /api/catalog-items/{item_id}/categories/ | Get Catalog Item Categories |
23
- | [**get_catalog_item_relationships**](CatalogsApi.md#get_catalog_item_relationships) | **GET** /api/catalog-items/{id}/relationships/{related_resource}/ | Get Catalog Item Relationships |
23
+ | [**get_catalog_item_relationships_categories**](CatalogsApi.md#get_catalog_item_relationships_categories) | **GET** /api/catalog-items/{id}/relationships/categories/ | Get Catalog Item Relationships Categories |
24
24
  | [**get_catalog_item_variants**](CatalogsApi.md#get_catalog_item_variants) | **GET** /api/catalog-items/{item_id}/variants/ | Get Catalog Item Variants |
25
25
  | [**get_catalog_items**](CatalogsApi.md#get_catalog_items) | **GET** /api/catalog-items/ | Get Catalog Items |
26
26
  | [**get_catalog_variant**](CatalogsApi.md#get_catalog_variant) | **GET** /api/catalog-variants/{id}/ | Get Catalog Variant |
@@ -53,9 +53,9 @@ All URIs are relative to *https://a.klaviyo.com*
53
53
  | [**spawn_update_items_job**](CatalogsApi.md#spawn_update_items_job) | **POST** /api/catalog-item-bulk-update-jobs/ | Spawn Update Items Job |
54
54
  | [**spawn_update_variants_job**](CatalogsApi.md#spawn_update_variants_job) | **POST** /api/catalog-variant-bulk-update-jobs/ | Spawn Update Variants Job |
55
55
  | [**update_catalog_category**](CatalogsApi.md#update_catalog_category) | **PATCH** /api/catalog-categories/{id}/ | Update Catalog Category |
56
- | [**update_catalog_category_relationships**](CatalogsApi.md#update_catalog_category_relationships) | **PATCH** /api/catalog-categories/{id}/relationships/{related_resource}/ | Update Catalog Category Relationships |
56
+ | [**update_catalog_category_relationships_items**](CatalogsApi.md#update_catalog_category_relationships_items) | **PATCH** /api/catalog-categories/{id}/relationships/items/ | Update Catalog Category Relationships Items |
57
57
  | [**update_catalog_item**](CatalogsApi.md#update_catalog_item) | **PATCH** /api/catalog-items/{id}/ | Update Catalog Item |
58
- | [**update_catalog_item_relationships**](CatalogsApi.md#update_catalog_item_relationships) | **PATCH** /api/catalog-items/{id}/relationships/{related_resource}/ | Update Catalog Item Relationships |
58
+ | [**update_catalog_item_relationships_categories**](CatalogsApi.md#update_catalog_item_relationships_categories) | **PATCH** /api/catalog-items/{id}/relationships/categories/ | Update Catalog Item Relationships Categories |
59
59
  | [**update_catalog_variant**](CatalogsApi.md#update_catalog_variant) | **PATCH** /api/catalog-variants/{id}/ | Update Catalog Variant |
60
60
 
61
61
 
@@ -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::CatalogCategoryCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, attributes: KlaviyoAPI::CatalogCategoryCreateQueryResourceObjectAttributes.new({external_id: 'SAMPLE-DATA-CATEGORY-APPAREL', name: 'Sample Data Category Apparel'})})}) # CatalogCategoryCreateQuery |
85
85
 
86
86
  begin
87
87
  # Create Catalog Category
@@ -130,11 +130,11 @@ end
130
130
  - **Accept**: application/json
131
131
 
132
132
 
133
- ## create_catalog_category_relationships
133
+ ## create_catalog_category_relationships_items
134
134
 
135
- > create_catalog_category_relationships(id, related_resource, catalog_category_item_op)
135
+ > create_catalog_category_relationships_items(id, catalog_category_item_op)
136
136
 
137
- Create Catalog Category Relationships
137
+ Create Catalog Category Relationships Items
138
138
 
139
139
  Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
140
140
 
@@ -153,32 +153,31 @@ end
153
153
 
154
154
  api_instance = KlaviyoAPI::CatalogsApi.new
155
155
  id = 'id_example' # String |
156
- related_resource = 'items' # String |
157
- catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
156
+ catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
158
157
 
159
158
  begin
160
- # Create Catalog Category Relationships
161
- api_instance.create_catalog_category_relationships(id, related_resource, catalog_category_item_op)
159
+ # Create Catalog Category Relationships Items
160
+ api_instance.create_catalog_category_relationships_items(id, catalog_category_item_op)
162
161
  rescue KlaviyoAPI::ApiError => e
163
- puts "Error when calling CatalogsApi->create_catalog_category_relationships: #{e}"
162
+ puts "Error when calling CatalogsApi->create_catalog_category_relationships_items: #{e}"
164
163
  end
165
164
  ```
166
165
 
167
- #### Using the create_catalog_category_relationships_with_http_info variant
166
+ #### Using the create_catalog_category_relationships_items_with_http_info variant
168
167
 
169
168
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
170
169
 
171
- > <Array(nil, Integer, Hash)> create_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
170
+ > <Array(nil, Integer, Hash)> create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
172
171
 
173
172
  ```ruby
174
173
  begin
175
- # Create Catalog Category Relationships
176
- data, status_code, headers = api_instance.create_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
174
+ # Create Catalog Category Relationships Items
175
+ data, status_code, headers = api_instance.create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
177
176
  p status_code # => 2xx
178
177
  p headers # => { ... }
179
178
  p data # => nil
180
179
  rescue KlaviyoAPI::ApiError => e
181
- puts "Error when calling CatalogsApi->create_catalog_category_relationships_with_http_info: #{e}"
180
+ puts "Error when calling CatalogsApi->create_catalog_category_relationships_items_with_http_info: #{e}"
182
181
  end
183
182
  ```
184
183
 
@@ -187,7 +186,6 @@ end
187
186
  | Name | Type | Description | Notes |
188
187
  | ---- | ---- | ----------- | ----- |
189
188
  | **id** | **String** | | |
190
- | **related_resource** | **String** | | |
191
189
  | **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
192
190
 
193
191
  ### Return type
@@ -226,7 +224,7 @@ KlaviyoAPI.configure do |config|
226
224
  end
227
225
 
228
226
  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 |
227
+ catalog_item_create_query = KlaviyoAPI::CatalogItemCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, attributes: KlaviyoAPI::CatalogItemCreateQueryResourceObjectAttributes.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
228
 
231
229
  begin
232
230
  # Create Catalog Item
@@ -275,11 +273,11 @@ end
275
273
  - **Accept**: application/json
276
274
 
277
275
 
278
- ## create_catalog_item_relationships
276
+ ## create_catalog_item_relationships_categories
279
277
 
280
- > create_catalog_item_relationships(id, related_resource, catalog_item_category_op)
278
+ > create_catalog_item_relationships_categories(id, catalog_item_category_op)
281
279
 
282
- Create Catalog Item Relationships
280
+ Create Catalog Item Relationships Categories
283
281
 
284
282
  Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
285
283
 
@@ -298,32 +296,31 @@ end
298
296
 
299
297
  api_instance = KlaviyoAPI::CatalogsApi.new
300
298
  id = 'id_example' # String |
301
- related_resource = 'categories' # String |
302
- catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
299
+ catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
303
300
 
304
301
  begin
305
- # Create Catalog Item Relationships
306
- api_instance.create_catalog_item_relationships(id, related_resource, catalog_item_category_op)
302
+ # Create Catalog Item Relationships Categories
303
+ api_instance.create_catalog_item_relationships_categories(id, catalog_item_category_op)
307
304
  rescue KlaviyoAPI::ApiError => e
308
- puts "Error when calling CatalogsApi->create_catalog_item_relationships: #{e}"
305
+ puts "Error when calling CatalogsApi->create_catalog_item_relationships_categories: #{e}"
309
306
  end
310
307
  ```
311
308
 
312
- #### Using the create_catalog_item_relationships_with_http_info variant
309
+ #### Using the create_catalog_item_relationships_categories_with_http_info variant
313
310
 
314
311
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
315
312
 
316
- > <Array(nil, Integer, Hash)> create_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
313
+ > <Array(nil, Integer, Hash)> create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
317
314
 
318
315
  ```ruby
319
316
  begin
320
- # Create Catalog Item Relationships
321
- data, status_code, headers = api_instance.create_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
317
+ # Create Catalog Item Relationships Categories
318
+ data, status_code, headers = api_instance.create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
322
319
  p status_code # => 2xx
323
320
  p headers # => { ... }
324
321
  p data # => nil
325
322
  rescue KlaviyoAPI::ApiError => e
326
- puts "Error when calling CatalogsApi->create_catalog_item_relationships_with_http_info: #{e}"
323
+ puts "Error when calling CatalogsApi->create_catalog_item_relationships_categories_with_http_info: #{e}"
327
324
  end
328
325
  ```
329
326
 
@@ -332,7 +329,6 @@ end
332
329
  | Name | Type | Description | Notes |
333
330
  | ---- | ---- | ----------- | ----- |
334
331
  | **id** | **String** | | |
335
- | **related_resource** | **String** | | |
336
332
  | **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
337
333
 
338
334
  ### Return type
@@ -371,7 +367,7 @@ KlaviyoAPI.configure do |config|
371
367
  end
372
368
 
373
369
  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 |
370
+ catalog_variant_create_query = KlaviyoAPI::CatalogVariantCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, attributes: KlaviyoAPI::CatalogVariantCreateQueryResourceObjectAttributes.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
371
 
376
372
  begin
377
373
  # Create Catalog Variant
@@ -442,7 +438,7 @@ KlaviyoAPI.configure do |config|
442
438
  end
443
439
 
444
440
  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.
441
+ 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
442
 
447
443
  begin
448
444
  # Delete Catalog Category
@@ -474,7 +470,7 @@ end
474
470
 
475
471
  | Name | Type | Description | Notes |
476
472
  | ---- | ---- | ----------- | ----- |
477
- | **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. | |
473
+ | **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;. | |
478
474
 
479
475
  ### Return type
480
476
 
@@ -490,11 +486,11 @@ nil (empty response body)
490
486
  - **Accept**: application/json
491
487
 
492
488
 
493
- ## delete_catalog_category_relationships
489
+ ## delete_catalog_category_relationships_items
494
490
 
495
- > delete_catalog_category_relationships(id, related_resource, catalog_category_item_op)
491
+ > delete_catalog_category_relationships_items(id, catalog_category_item_op)
496
492
 
497
- Delete Catalog Category Relationships
493
+ Delete Catalog Category Relationships Items
498
494
 
499
495
  Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
500
496
 
@@ -513,32 +509,31 @@ end
513
509
 
514
510
  api_instance = KlaviyoAPI::CatalogsApi.new
515
511
  id = 'id_example' # String |
516
- related_resource = 'items' # String |
517
- catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
512
+ catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
518
513
 
519
514
  begin
520
- # Delete Catalog Category Relationships
521
- api_instance.delete_catalog_category_relationships(id, related_resource, catalog_category_item_op)
515
+ # Delete Catalog Category Relationships Items
516
+ api_instance.delete_catalog_category_relationships_items(id, catalog_category_item_op)
522
517
  rescue KlaviyoAPI::ApiError => e
523
- puts "Error when calling CatalogsApi->delete_catalog_category_relationships: #{e}"
518
+ puts "Error when calling CatalogsApi->delete_catalog_category_relationships_items: #{e}"
524
519
  end
525
520
  ```
526
521
 
527
- #### Using the delete_catalog_category_relationships_with_http_info variant
522
+ #### Using the delete_catalog_category_relationships_items_with_http_info variant
528
523
 
529
524
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
530
525
 
531
- > <Array(nil, Integer, Hash)> delete_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
526
+ > <Array(nil, Integer, Hash)> delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
532
527
 
533
528
  ```ruby
534
529
  begin
535
- # Delete Catalog Category Relationships
536
- data, status_code, headers = api_instance.delete_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
530
+ # Delete Catalog Category Relationships Items
531
+ data, status_code, headers = api_instance.delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
537
532
  p status_code # => 2xx
538
533
  p headers # => { ... }
539
534
  p data # => nil
540
535
  rescue KlaviyoAPI::ApiError => e
541
- puts "Error when calling CatalogsApi->delete_catalog_category_relationships_with_http_info: #{e}"
536
+ puts "Error when calling CatalogsApi->delete_catalog_category_relationships_items_with_http_info: #{e}"
542
537
  end
543
538
  ```
544
539
 
@@ -547,7 +542,6 @@ end
547
542
  | Name | Type | Description | Notes |
548
543
  | ---- | ---- | ----------- | ----- |
549
544
  | **id** | **String** | | |
550
- | **related_resource** | **String** | | |
551
545
  | **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
552
546
 
553
547
  ### Return type
@@ -586,7 +580,7 @@ KlaviyoAPI.configure do |config|
586
580
  end
587
581
 
588
582
  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.
583
+ 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
584
 
591
585
  begin
592
586
  # Delete Catalog Item
@@ -618,7 +612,7 @@ end
618
612
 
619
613
  | Name | Type | Description | Notes |
620
614
  | ---- | ---- | ----------- | ----- |
621
- | **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. | |
615
+ | **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;. | |
622
616
 
623
617
  ### Return type
624
618
 
@@ -634,11 +628,11 @@ nil (empty response body)
634
628
  - **Accept**: application/json
635
629
 
636
630
 
637
- ## delete_catalog_item_relationships
631
+ ## delete_catalog_item_relationships_categories
638
632
 
639
- > delete_catalog_item_relationships(id, related_resource, catalog_item_category_op)
633
+ > delete_catalog_item_relationships_categories(id, catalog_item_category_op)
640
634
 
641
- Delete Catalog Item Relationships
635
+ Delete Catalog Item Relationships Categories
642
636
 
643
637
  Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
644
638
 
@@ -657,32 +651,31 @@ end
657
651
 
658
652
  api_instance = KlaviyoAPI::CatalogsApi.new
659
653
  id = 'id_example' # String |
660
- related_resource = 'categories' # String |
661
- catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
654
+ catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
662
655
 
663
656
  begin
664
- # Delete Catalog Item Relationships
665
- api_instance.delete_catalog_item_relationships(id, related_resource, catalog_item_category_op)
657
+ # Delete Catalog Item Relationships Categories
658
+ api_instance.delete_catalog_item_relationships_categories(id, catalog_item_category_op)
666
659
  rescue KlaviyoAPI::ApiError => e
667
- puts "Error when calling CatalogsApi->delete_catalog_item_relationships: #{e}"
660
+ puts "Error when calling CatalogsApi->delete_catalog_item_relationships_categories: #{e}"
668
661
  end
669
662
  ```
670
663
 
671
- #### Using the delete_catalog_item_relationships_with_http_info variant
664
+ #### Using the delete_catalog_item_relationships_categories_with_http_info variant
672
665
 
673
666
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
674
667
 
675
- > <Array(nil, Integer, Hash)> delete_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
668
+ > <Array(nil, Integer, Hash)> delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
676
669
 
677
670
  ```ruby
678
671
  begin
679
- # Delete Catalog Item Relationships
680
- data, status_code, headers = api_instance.delete_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
672
+ # Delete Catalog Item Relationships Categories
673
+ data, status_code, headers = api_instance.delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
681
674
  p status_code # => 2xx
682
675
  p headers # => { ... }
683
676
  p data # => nil
684
677
  rescue KlaviyoAPI::ApiError => e
685
- puts "Error when calling CatalogsApi->delete_catalog_item_relationships_with_http_info: #{e}"
678
+ puts "Error when calling CatalogsApi->delete_catalog_item_relationships_categories_with_http_info: #{e}"
686
679
  end
687
680
  ```
688
681
 
@@ -691,7 +684,6 @@ end
691
684
  | Name | Type | Description | Notes |
692
685
  | ---- | ---- | ----------- | ----- |
693
686
  | **id** | **String** | | |
694
- | **related_resource** | **String** | | |
695
687
  | **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
696
688
 
697
689
  ### Return type
@@ -730,7 +722,7 @@ KlaviyoAPI.configure do |config|
730
722
  end
731
723
 
732
724
  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.
725
+ 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
726
 
735
727
  begin
736
728
  # Delete Catalog Variant
@@ -762,7 +754,7 @@ end
762
754
 
763
755
  | Name | Type | Description | Notes |
764
756
  | ---- | ---- | ----------- | ----- |
765
- | **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. | |
757
+ | **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;. | |
766
758
 
767
759
  ### Return type
768
760
 
@@ -801,10 +793,10 @@ end
801
793
 
802
794
  api_instance = KlaviyoAPI::CatalogsApi.new
803
795
  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
796
+ 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
797
+ 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`
798
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
799
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
808
800
  }
809
801
 
810
802
  begin
@@ -838,10 +830,10 @@ end
838
830
 
839
831
  | Name | Type | Description | Notes |
840
832
  | ---- | ---- | ----------- | ----- |
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] |
833
+ | **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] |
834
+ | **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] |
835
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
836
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
845
837
 
846
838
  ### Return type
847
839
 
@@ -879,9 +871,9 @@ KlaviyoAPI.configure do |config|
879
871
  end
880
872
 
881
873
  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.
874
+ 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
875
  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
876
+ 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
877
  }
886
878
 
887
879
  begin
@@ -915,8 +907,8 @@ end
915
907
 
916
908
  | Name | Type | Description | Notes |
917
909
  | ---- | ---- | ----------- | ----- |
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] |
910
+ | **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;. | |
911
+ | **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
912
 
921
913
  ### Return type
922
914
 
@@ -954,14 +946,14 @@ KlaviyoAPI.configure do |config|
954
946
  end
955
947
 
956
948
  api_instance = KlaviyoAPI::CatalogsApi.new
957
- category_id = 'category_id_example' # String |
949
+ 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
950
  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
951
+ 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
952
+ 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
953
+ 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`
954
+ include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
955
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
956
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
965
957
  }
966
958
 
967
959
  begin
@@ -995,13 +987,13 @@ end
995
987
 
996
988
  | Name | Type | Description | Notes |
997
989
  | ---- | ---- | ----------- | ----- |
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] |
990
+ | **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;. | |
991
+ | **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] |
992
+ | **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] |
993
+ | **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] |
994
+ | **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] |
995
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
996
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1005
997
 
1006
998
  ### Return type
1007
999
 
@@ -1017,11 +1009,11 @@ end
1017
1009
  - **Accept**: application/json
1018
1010
 
1019
1011
 
1020
- ## get_catalog_category_relationships
1012
+ ## get_catalog_category_relationships_items
1021
1013
 
1022
- > Hash&lt;String, Object&gt; get_catalog_category_relationships(id, related_resource, opts)
1014
+ > Hash&lt;String, Object&gt; get_catalog_category_relationships_items(id, opts)
1023
1015
 
1024
- Get Catalog Category Relationships
1016
+ Get Catalog Category Relationships Items
1025
1017
 
1026
1018
  Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1027
1019
 
@@ -1040,35 +1032,34 @@ end
1040
1032
 
1041
1033
  api_instance = KlaviyoAPI::CatalogsApi.new
1042
1034
  id = 'id_example' # String |
1043
- related_resource = 'items' # String |
1044
1035
  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
1036
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1046
1037
  }
1047
1038
 
1048
1039
  begin
1049
- # Get Catalog Category Relationships
1050
- result = api_instance.get_catalog_category_relationships(id, related_resource, opts)
1040
+ # Get Catalog Category Relationships Items
1041
+ result = api_instance.get_catalog_category_relationships_items(id, opts)
1051
1042
  p result
1052
1043
  rescue KlaviyoAPI::ApiError => e
1053
- puts "Error when calling CatalogsApi->get_catalog_category_relationships: #{e}"
1044
+ puts "Error when calling CatalogsApi->get_catalog_category_relationships_items: #{e}"
1054
1045
  end
1055
1046
  ```
1056
1047
 
1057
- #### Using the get_catalog_category_relationships_with_http_info variant
1048
+ #### Using the get_catalog_category_relationships_items_with_http_info variant
1058
1049
 
1059
1050
  This returns an Array which contains the response data, status code and headers.
1060
1051
 
1061
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_category_relationships_with_http_info(id, related_resource, opts)
1052
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_category_relationships_items_with_http_info(id, opts)
1062
1053
 
1063
1054
  ```ruby
1064
1055
  begin
1065
- # Get Catalog Category Relationships
1066
- data, status_code, headers = api_instance.get_catalog_category_relationships_with_http_info(id, related_resource, opts)
1056
+ # Get Catalog Category Relationships Items
1057
+ data, status_code, headers = api_instance.get_catalog_category_relationships_items_with_http_info(id, opts)
1067
1058
  p status_code # => 2xx
1068
1059
  p headers # => { ... }
1069
1060
  p data # => Hash&lt;String, Object&gt;
1070
1061
  rescue KlaviyoAPI::ApiError => e
1071
- puts "Error when calling CatalogsApi->get_catalog_category_relationships_with_http_info: #{e}"
1062
+ puts "Error when calling CatalogsApi->get_catalog_category_relationships_items_with_http_info: #{e}"
1072
1063
  end
1073
1064
  ```
1074
1065
 
@@ -1077,8 +1068,7 @@ end
1077
1068
  | Name | Type | Description | Notes |
1078
1069
  | ---- | ---- | ----------- | ----- |
1079
1070
  | **id** | **String** | | |
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] |
1071
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1082
1072
 
1083
1073
  ### Return type
1084
1074
 
@@ -1116,11 +1106,11 @@ KlaviyoAPI.configure do |config|
1116
1106
  end
1117
1107
 
1118
1108
  api_instance = KlaviyoAPI::CatalogsApi.new
1119
- id = 'id_example' # String |
1109
+ 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
1110
  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
1111
+ 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
1112
+ 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
1113
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1124
1114
  }
1125
1115
 
1126
1116
  begin
@@ -1154,10 +1144,10 @@ end
1154
1144
 
1155
1145
  | Name | Type | Description | Notes |
1156
1146
  | ---- | ---- | ----------- | ----- |
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] |
1147
+ | **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;. | |
1148
+ | **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] |
1149
+ | **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] |
1150
+ | **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
1151
 
1162
1152
  ### Return type
1163
1153
 
@@ -1195,12 +1185,12 @@ KlaviyoAPI.configure do |config|
1195
1185
  end
1196
1186
 
1197
1187
  api_instance = KlaviyoAPI::CatalogsApi.new
1198
- item_id = 'item_id_example' # String |
1188
+ 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
1189
  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
1190
+ 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
1191
+ 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`
1192
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1193
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1204
1194
  }
1205
1195
 
1206
1196
  begin
@@ -1234,11 +1224,11 @@ end
1234
1224
 
1235
1225
  | Name | Type | Description | Notes |
1236
1226
  | ---- | ---- | ----------- | ----- |
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] |
1227
+ | **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;. | |
1228
+ | **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] |
1229
+ | **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] |
1230
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1231
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1242
1232
 
1243
1233
  ### Return type
1244
1234
 
@@ -1254,11 +1244,11 @@ end
1254
1244
  - **Accept**: application/json
1255
1245
 
1256
1246
 
1257
- ## get_catalog_item_relationships
1247
+ ## get_catalog_item_relationships_categories
1258
1248
 
1259
- > Hash&lt;String, Object&gt; get_catalog_item_relationships(id, related_resource, opts)
1249
+ > Hash&lt;String, Object&gt; get_catalog_item_relationships_categories(id, opts)
1260
1250
 
1261
- Get Catalog Item Relationships
1251
+ Get Catalog Item Relationships Categories
1262
1252
 
1263
1253
  Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `Catalogs Read`
1264
1254
 
@@ -1277,35 +1267,34 @@ end
1277
1267
 
1278
1268
  api_instance = KlaviyoAPI::CatalogsApi.new
1279
1269
  id = 'id_example' # String |
1280
- related_resource = 'categories' # String |
1281
1270
  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
1271
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1283
1272
  }
1284
1273
 
1285
1274
  begin
1286
- # Get Catalog Item Relationships
1287
- result = api_instance.get_catalog_item_relationships(id, related_resource, opts)
1275
+ # Get Catalog Item Relationships Categories
1276
+ result = api_instance.get_catalog_item_relationships_categories(id, opts)
1288
1277
  p result
1289
1278
  rescue KlaviyoAPI::ApiError => e
1290
- puts "Error when calling CatalogsApi->get_catalog_item_relationships: #{e}"
1279
+ puts "Error when calling CatalogsApi->get_catalog_item_relationships_categories: #{e}"
1291
1280
  end
1292
1281
  ```
1293
1282
 
1294
- #### Using the get_catalog_item_relationships_with_http_info variant
1283
+ #### Using the get_catalog_item_relationships_categories_with_http_info variant
1295
1284
 
1296
1285
  This returns an Array which contains the response data, status code and headers.
1297
1286
 
1298
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_item_relationships_with_http_info(id, related_resource, opts)
1287
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_item_relationships_categories_with_http_info(id, opts)
1299
1288
 
1300
1289
  ```ruby
1301
1290
  begin
1302
- # Get Catalog Item Relationships
1303
- data, status_code, headers = api_instance.get_catalog_item_relationships_with_http_info(id, related_resource, opts)
1291
+ # Get Catalog Item Relationships Categories
1292
+ data, status_code, headers = api_instance.get_catalog_item_relationships_categories_with_http_info(id, opts)
1304
1293
  p status_code # => 2xx
1305
1294
  p headers # => { ... }
1306
1295
  p data # => Hash&lt;String, Object&gt;
1307
1296
  rescue KlaviyoAPI::ApiError => e
1308
- puts "Error when calling CatalogsApi->get_catalog_item_relationships_with_http_info: #{e}"
1297
+ puts "Error when calling CatalogsApi->get_catalog_item_relationships_categories_with_http_info: #{e}"
1309
1298
  end
1310
1299
  ```
1311
1300
 
@@ -1314,8 +1303,7 @@ end
1314
1303
  | Name | Type | Description | Notes |
1315
1304
  | ---- | ---- | ----------- | ----- |
1316
1305
  | **id** | **String** | | |
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] |
1306
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1319
1307
 
1320
1308
  ### Return type
1321
1309
 
@@ -1353,12 +1341,12 @@ KlaviyoAPI.configure do |config|
1353
1341
  end
1354
1342
 
1355
1343
  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.
1344
+ 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
1345
  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
1346
+ 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
1347
+ 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`
1348
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1349
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1362
1350
  }
1363
1351
 
1364
1352
  begin
@@ -1392,11 +1380,11 @@ end
1392
1380
 
1393
1381
  | Name | Type | Description | Notes |
1394
1382
  | ---- | ---- | ----------- | ----- |
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] |
1383
+ | **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;. | |
1384
+ | **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] |
1385
+ | **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] |
1386
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1387
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1400
1388
 
1401
1389
  ### Return type
1402
1390
 
@@ -1435,12 +1423,12 @@ end
1435
1423
 
1436
1424
  api_instance = KlaviyoAPI::CatalogsApi.new
1437
1425
  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
1426
+ 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
1427
+ 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
1428
+ 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`
1429
+ include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1430
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1431
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1444
1432
  }
1445
1433
 
1446
1434
  begin
@@ -1474,12 +1462,12 @@ end
1474
1462
 
1475
1463
  | Name | Type | Description | Notes |
1476
1464
  | ---- | ---- | ----------- | ----- |
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] |
1465
+ | **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] |
1466
+ | **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] |
1467
+ | **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] |
1468
+ | **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] |
1469
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1470
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1483
1471
 
1484
1472
  ### Return type
1485
1473
 
@@ -1517,9 +1505,9 @@ KlaviyoAPI.configure do |config|
1517
1505
  end
1518
1506
 
1519
1507
  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.
1508
+ 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
1509
  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
1510
+ 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
1511
  }
1524
1512
 
1525
1513
  begin
@@ -1553,8 +1541,8 @@ end
1553
1541
 
1554
1542
  | Name | Type | Description | Notes |
1555
1543
  | ---- | ---- | ----------- | ----- |
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] |
1544
+ | **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;. | |
1545
+ | **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
1546
 
1559
1547
  ### Return type
1560
1548
 
@@ -1593,10 +1581,10 @@ end
1593
1581
 
1594
1582
  api_instance = KlaviyoAPI::CatalogsApi.new
1595
1583
  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
1584
+ 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
1585
+ 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`
1586
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1587
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1600
1588
  }
1601
1589
 
1602
1590
  begin
@@ -1630,10 +1618,10 @@ end
1630
1618
 
1631
1619
  | Name | Type | Description | Notes |
1632
1620
  | ---- | ---- | ----------- | ----- |
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] |
1621
+ | **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] |
1622
+ | **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] |
1623
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1624
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1637
1625
 
1638
1626
  ### Return type
1639
1627
 
@@ -1655,7 +1643,7 @@ end
1655
1643
 
1656
1644
  Get Create Categories Job
1657
1645
 
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`
1646
+ 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
1647
 
1660
1648
  ### Examples
1661
1649
 
@@ -1671,11 +1659,11 @@ KlaviyoAPI.configure do |config|
1671
1659
  end
1672
1660
 
1673
1661
  api_instance = KlaviyoAPI::CatalogsApi.new
1674
- job_id = 'job_id_example' # String |
1662
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
1675
1663
  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
1664
+ 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
1665
+ 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
1666
+ include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1679
1667
  }
1680
1668
 
1681
1669
  begin
@@ -1709,10 +1697,10 @@ end
1709
1697
 
1710
1698
  | Name | Type | Description | Notes |
1711
1699
  | ---- | ---- | ----------- | ----- |
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] |
1700
+ | **job_id** | **String** | ID of the job to retrieve. | |
1701
+ | **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] |
1702
+ | **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] |
1703
+ | **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
1704
 
1717
1705
  ### Return type
1718
1706
 
@@ -1751,9 +1739,9 @@ end
1751
1739
 
1752
1740
  api_instance = KlaviyoAPI::CatalogsApi.new
1753
1741
  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
1742
+ 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
1743
+ 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`
1744
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1757
1745
  }
1758
1746
 
1759
1747
  begin
@@ -1787,9 +1775,9 @@ end
1787
1775
 
1788
1776
  | Name | Type | Description | Notes |
1789
1777
  | ---- | ---- | ----------- | ----- |
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] |
1778
+ | **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] |
1779
+ | **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] |
1780
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1793
1781
 
1794
1782
  ### Return type
1795
1783
 
@@ -1811,7 +1799,7 @@ end
1811
1799
 
1812
1800
  Get Create Items Job
1813
1801
 
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`
1802
+ 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
1803
 
1816
1804
  ### Examples
1817
1805
 
@@ -1827,11 +1815,11 @@ KlaviyoAPI.configure do |config|
1827
1815
  end
1828
1816
 
1829
1817
  api_instance = KlaviyoAPI::CatalogsApi.new
1830
- job_id = 'job_id_example' # String |
1818
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
1831
1819
  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
1820
+ 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
1821
+ 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
1822
+ include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1835
1823
  }
1836
1824
 
1837
1825
  begin
@@ -1865,10 +1853,10 @@ end
1865
1853
 
1866
1854
  | Name | Type | Description | Notes |
1867
1855
  | ---- | ---- | ----------- | ----- |
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] |
1856
+ | **job_id** | **String** | ID of the job to retrieve. | |
1857
+ | **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] |
1858
+ | **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] |
1859
+ | **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
1860
 
1873
1861
  ### Return type
1874
1862
 
@@ -1907,9 +1895,9 @@ end
1907
1895
 
1908
1896
  api_instance = KlaviyoAPI::CatalogsApi.new
1909
1897
  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
1898
+ 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
1899
+ 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`
1900
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1913
1901
  }
1914
1902
 
1915
1903
  begin
@@ -1943,9 +1931,9 @@ end
1943
1931
 
1944
1932
  | Name | Type | Description | Notes |
1945
1933
  | ---- | ---- | ----------- | ----- |
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] |
1934
+ | **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] |
1935
+ | **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] |
1936
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1949
1937
 
1950
1938
  ### Return type
1951
1939
 
@@ -1967,7 +1955,7 @@ end
1967
1955
 
1968
1956
  Get Create Variants Job
1969
1957
 
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`
1958
+ 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
1959
 
1972
1960
  ### Examples
1973
1961
 
@@ -1983,11 +1971,11 @@ KlaviyoAPI.configure do |config|
1983
1971
  end
1984
1972
 
1985
1973
  api_instance = KlaviyoAPI::CatalogsApi.new
1986
- job_id = 'job_id_example' # String |
1974
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
1987
1975
  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
1976
+ 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
1977
+ 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
1978
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1991
1979
  }
1992
1980
 
1993
1981
  begin
@@ -2021,10 +2009,10 @@ end
2021
2009
 
2022
2010
  | Name | Type | Description | Notes |
2023
2011
  | ---- | ---- | ----------- | ----- |
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] |
2012
+ | **job_id** | **String** | ID of the job to retrieve. | |
2013
+ | **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] |
2014
+ | **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] |
2015
+ | **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
2016
 
2029
2017
  ### Return type
2030
2018
 
@@ -2063,9 +2051,9 @@ end
2063
2051
 
2064
2052
  api_instance = KlaviyoAPI::CatalogsApi.new
2065
2053
  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
2054
+ 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
2055
+ 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`
2056
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2069
2057
  }
2070
2058
 
2071
2059
  begin
@@ -2099,9 +2087,9 @@ end
2099
2087
 
2100
2088
  | Name | Type | Description | Notes |
2101
2089
  | ---- | ---- | ----------- | ----- |
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] |
2090
+ | **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] |
2091
+ | **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] |
2092
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2105
2093
 
2106
2094
  ### Return type
2107
2095
 
@@ -2139,9 +2127,9 @@ KlaviyoAPI.configure do |config|
2139
2127
  end
2140
2128
 
2141
2129
  api_instance = KlaviyoAPI::CatalogsApi.new
2142
- job_id = 'job_id_example' # String |
2130
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2143
2131
  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
2132
+ 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
2133
  }
2146
2134
 
2147
2135
  begin
@@ -2175,8 +2163,8 @@ end
2175
2163
 
2176
2164
  | Name | Type | Description | Notes |
2177
2165
  | ---- | ---- | ----------- | ----- |
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] |
2166
+ | **job_id** | **String** | ID of the job to retrieve. | |
2167
+ | **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
2168
 
2181
2169
  ### Return type
2182
2170
 
@@ -2215,9 +2203,9 @@ end
2215
2203
 
2216
2204
  api_instance = KlaviyoAPI::CatalogsApi.new
2217
2205
  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
2206
+ 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
2207
+ 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`
2208
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2221
2209
  }
2222
2210
 
2223
2211
  begin
@@ -2251,9 +2239,9 @@ end
2251
2239
 
2252
2240
  | Name | Type | Description | Notes |
2253
2241
  | ---- | ---- | ----------- | ----- |
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] |
2242
+ | **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] |
2243
+ | **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] |
2244
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2257
2245
 
2258
2246
  ### Return type
2259
2247
 
@@ -2291,9 +2279,9 @@ KlaviyoAPI.configure do |config|
2291
2279
  end
2292
2280
 
2293
2281
  api_instance = KlaviyoAPI::CatalogsApi.new
2294
- job_id = 'job_id_example' # String |
2282
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2295
2283
  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
2284
+ 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
2285
  }
2298
2286
 
2299
2287
  begin
@@ -2327,8 +2315,8 @@ end
2327
2315
 
2328
2316
  | Name | Type | Description | Notes |
2329
2317
  | ---- | ---- | ----------- | ----- |
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] |
2318
+ | **job_id** | **String** | ID of the job to retrieve. | |
2319
+ | **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
2320
 
2333
2321
  ### Return type
2334
2322
 
@@ -2367,9 +2355,9 @@ end
2367
2355
 
2368
2356
  api_instance = KlaviyoAPI::CatalogsApi.new
2369
2357
  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
2358
+ 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
2359
+ 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`
2360
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2373
2361
  }
2374
2362
 
2375
2363
  begin
@@ -2403,9 +2391,9 @@ end
2403
2391
 
2404
2392
  | Name | Type | Description | Notes |
2405
2393
  | ---- | ---- | ----------- | ----- |
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] |
2394
+ | **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] |
2395
+ | **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] |
2396
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2409
2397
 
2410
2398
  ### Return type
2411
2399
 
@@ -2443,9 +2431,9 @@ KlaviyoAPI.configure do |config|
2443
2431
  end
2444
2432
 
2445
2433
  api_instance = KlaviyoAPI::CatalogsApi.new
2446
- job_id = 'job_id_example' # String |
2434
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2447
2435
  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
2436
+ 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
2437
  }
2450
2438
 
2451
2439
  begin
@@ -2479,8 +2467,8 @@ end
2479
2467
 
2480
2468
  | Name | Type | Description | Notes |
2481
2469
  | ---- | ---- | ----------- | ----- |
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] |
2470
+ | **job_id** | **String** | ID of the job to retrieve. | |
2471
+ | **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
2472
 
2485
2473
  ### Return type
2486
2474
 
@@ -2519,9 +2507,9 @@ end
2519
2507
 
2520
2508
  api_instance = KlaviyoAPI::CatalogsApi.new
2521
2509
  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
2510
+ 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
2511
+ 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`
2512
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2525
2513
  }
2526
2514
 
2527
2515
  begin
@@ -2555,9 +2543,9 @@ end
2555
2543
 
2556
2544
  | Name | Type | Description | Notes |
2557
2545
  | ---- | ---- | ----------- | ----- |
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] |
2546
+ | **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] |
2547
+ | **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] |
2548
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2561
2549
 
2562
2550
  ### Return type
2563
2551
 
@@ -2579,7 +2567,7 @@ end
2579
2567
 
2580
2568
  Get Update Categories Job
2581
2569
 
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`
2570
+ 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
2571
 
2584
2572
  ### Examples
2585
2573
 
@@ -2595,11 +2583,11 @@ KlaviyoAPI.configure do |config|
2595
2583
  end
2596
2584
 
2597
2585
  api_instance = KlaviyoAPI::CatalogsApi.new
2598
- job_id = 'job_id_example' # String |
2586
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2599
2587
  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
2588
+ 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
2589
+ 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
2590
+ include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2603
2591
  }
2604
2592
 
2605
2593
  begin
@@ -2633,10 +2621,10 @@ end
2633
2621
 
2634
2622
  | Name | Type | Description | Notes |
2635
2623
  | ---- | ---- | ----------- | ----- |
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] |
2624
+ | **job_id** | **String** | ID of the job to retrieve. | |
2625
+ | **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] |
2626
+ | **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] |
2627
+ | **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
2628
 
2641
2629
  ### Return type
2642
2630
 
@@ -2675,9 +2663,9 @@ end
2675
2663
 
2676
2664
  api_instance = KlaviyoAPI::CatalogsApi.new
2677
2665
  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
2666
+ 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
2667
+ 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`
2668
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2681
2669
  }
2682
2670
 
2683
2671
  begin
@@ -2711,9 +2699,9 @@ end
2711
2699
 
2712
2700
  | Name | Type | Description | Notes |
2713
2701
  | ---- | ---- | ----------- | ----- |
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] |
2702
+ | **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] |
2703
+ | **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] |
2704
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2717
2705
 
2718
2706
  ### Return type
2719
2707
 
@@ -2735,7 +2723,7 @@ end
2735
2723
 
2736
2724
  Get Update Items Job
2737
2725
 
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`
2726
+ 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
2727
 
2740
2728
  ### Examples
2741
2729
 
@@ -2751,11 +2739,11 @@ KlaviyoAPI.configure do |config|
2751
2739
  end
2752
2740
 
2753
2741
  api_instance = KlaviyoAPI::CatalogsApi.new
2754
- job_id = 'job_id_example' # String |
2742
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2755
2743
  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
2744
+ 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
2745
+ 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
2746
+ include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2759
2747
  }
2760
2748
 
2761
2749
  begin
@@ -2789,10 +2777,10 @@ end
2789
2777
 
2790
2778
  | Name | Type | Description | Notes |
2791
2779
  | ---- | ---- | ----------- | ----- |
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] |
2780
+ | **job_id** | **String** | ID of the job to retrieve. | |
2781
+ | **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] |
2782
+ | **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] |
2783
+ | **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
2784
 
2797
2785
  ### Return type
2798
2786
 
@@ -2831,9 +2819,9 @@ end
2831
2819
 
2832
2820
  api_instance = KlaviyoAPI::CatalogsApi.new
2833
2821
  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
2822
+ 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
2823
+ 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`
2824
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2837
2825
  }
2838
2826
 
2839
2827
  begin
@@ -2867,9 +2855,9 @@ end
2867
2855
 
2868
2856
  | Name | Type | Description | Notes |
2869
2857
  | ---- | ---- | ----------- | ----- |
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] |
2858
+ | **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] |
2859
+ | **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] |
2860
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
2873
2861
 
2874
2862
  ### Return type
2875
2863
 
@@ -2891,7 +2879,7 @@ end
2891
2879
 
2892
2880
  Get Update Variants Job
2893
2881
 
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`
2882
+ 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
2883
 
2896
2884
  ### Examples
2897
2885
 
@@ -2907,11 +2895,11 @@ KlaviyoAPI.configure do |config|
2907
2895
  end
2908
2896
 
2909
2897
  api_instance = KlaviyoAPI::CatalogsApi.new
2910
- job_id = 'job_id_example' # String |
2898
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2911
2899
  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
2900
+ 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
2901
+ 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
2902
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
2915
2903
  }
2916
2904
 
2917
2905
  begin
@@ -2945,10 +2933,10 @@ end
2945
2933
 
2946
2934
  | Name | Type | Description | Notes |
2947
2935
  | ---- | ---- | ----------- | ----- |
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] |
2936
+ | **job_id** | **String** | ID of the job to retrieve. | |
2937
+ | **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] |
2938
+ | **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] |
2939
+ | **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
2940
 
2953
2941
  ### Return type
2954
2942
 
@@ -2987,9 +2975,9 @@ end
2987
2975
 
2988
2976
  api_instance = KlaviyoAPI::CatalogsApi.new
2989
2977
  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
2978
+ 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
2979
+ 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`
2980
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
2993
2981
  }
2994
2982
 
2995
2983
  begin
@@ -3023,9 +3011,9 @@ end
3023
3011
 
3024
3012
  | Name | Type | Description | Notes |
3025
3013
  | ---- | ---- | ----------- | ----- |
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] |
3014
+ | **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] |
3015
+ | **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] |
3016
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
3029
3017
 
3030
3018
  ### Return type
3031
3019
 
@@ -3047,7 +3035,7 @@ end
3047
3035
 
3048
3036
  Spawn Create Categories Job
3049
3037
 
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`
3038
+ 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
3039
 
3052
3040
  ### Examples
3053
3041
 
@@ -3063,7 +3051,7 @@ KlaviyoAPI.configure do |config|
3063
3051
  end
3064
3052
 
3065
3053
  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 |
3054
+ catalog_category_create_job_create_query = KlaviyoAPI::CatalogCategoryCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryBulkCreateJobEnum::CATALOG_CATEGORY_BULK_CREATE_JOB, attributes: KlaviyoAPI::CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.new({categories: [KlaviyoAPI::CatalogCategoryCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, attributes: KlaviyoAPI::CatalogCategoryCreateQueryResourceObjectAttributes.new({external_id: 'SAMPLE-DATA-CATEGORY-APPAREL', name: 'Sample Data Category Apparel'})})]})})}) # CatalogCategoryCreateJobCreateQuery |
3067
3055
 
3068
3056
  begin
3069
3057
  # Spawn Create Categories Job
@@ -3118,7 +3106,7 @@ end
3118
3106
 
3119
3107
  Spawn Create Items Job
3120
3108
 
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`
3109
+ 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
3110
 
3123
3111
  ### Examples
3124
3112
 
@@ -3134,7 +3122,7 @@ KlaviyoAPI.configure do |config|
3134
3122
  end
3135
3123
 
3136
3124
  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 |
3125
+ catalog_item_create_job_create_query = KlaviyoAPI::CatalogItemCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemBulkCreateJobEnum::CATALOG_ITEM_BULK_CREATE_JOB, attributes: KlaviyoAPI::CatalogItemCreateJobCreateQueryResourceObjectAttributes.new({items: [KlaviyoAPI::CatalogItemCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, attributes: KlaviyoAPI::CatalogItemCreateQueryResourceObjectAttributes.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
3126
 
3139
3127
  begin
3140
3128
  # Spawn Create Items Job
@@ -3189,7 +3177,7 @@ end
3189
3177
 
3190
3178
  Spawn Create Variants Job
3191
3179
 
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`
3180
+ 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
3181
 
3194
3182
  ### Examples
3195
3183
 
@@ -3205,7 +3193,7 @@ KlaviyoAPI.configure do |config|
3205
3193
  end
3206
3194
 
3207
3195
  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 |
3196
+ catalog_variant_create_job_create_query = KlaviyoAPI::CatalogVariantCreateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantCreateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantBulkCreateJobEnum::CATALOG_VARIANT_BULK_CREATE_JOB, attributes: KlaviyoAPI::CatalogVariantCreateJobCreateQueryResourceObjectAttributes.new({variants: [KlaviyoAPI::CatalogVariantCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, attributes: KlaviyoAPI::CatalogVariantCreateQueryResourceObjectAttributes.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
3197
 
3210
3198
  begin
3211
3199
  # Spawn Create Variants Job
@@ -3260,7 +3248,7 @@ end
3260
3248
 
3261
3249
  Spawn Delete Categories Job
3262
3250
 
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`
3251
+ 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
3252
 
3265
3253
  ### Examples
3266
3254
 
@@ -3276,7 +3264,7 @@ KlaviyoAPI.configure do |config|
3276
3264
  end
3277
3265
 
3278
3266
  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 |
3267
+ catalog_category_delete_job_create_query = KlaviyoAPI::CatalogCategoryDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryBulkDeleteJobEnum::CATALOG_CATEGORY_BULK_DELETE_JOB, attributes: KlaviyoAPI::CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.new({categories: [KlaviyoAPI::CatalogCategoryDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'})]})})}) # CatalogCategoryDeleteJobCreateQuery |
3280
3268
 
3281
3269
  begin
3282
3270
  # Spawn Delete Categories Job
@@ -3331,7 +3319,7 @@ end
3331
3319
 
3332
3320
  Spawn Delete Items Job
3333
3321
 
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`
3322
+ 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
3323
 
3336
3324
  ### Examples
3337
3325
 
@@ -3347,7 +3335,7 @@ KlaviyoAPI.configure do |config|
3347
3335
  end
3348
3336
 
3349
3337
  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 |
3338
+ catalog_item_delete_job_create_query = KlaviyoAPI::CatalogItemDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogItemDeleteJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemBulkDeleteJobEnum::CATALOG_ITEM_BULK_DELETE_JOB, attributes: KlaviyoAPI::CatalogItemDeleteJobCreateQueryResourceObjectAttributes.new({items: [KlaviyoAPI::CatalogItemDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1'})]})})}) # CatalogItemDeleteJobCreateQuery |
3351
3339
 
3352
3340
  begin
3353
3341
  # Spawn Delete Items Job
@@ -3402,7 +3390,7 @@ end
3402
3390
 
3403
3391
  Spawn Delete Variants Job
3404
3392
 
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`
3393
+ 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
3394
 
3407
3395
  ### Examples
3408
3396
 
@@ -3418,7 +3406,7 @@ KlaviyoAPI.configure do |config|
3418
3406
  end
3419
3407
 
3420
3408
  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 |
3409
+ catalog_variant_delete_job_create_query = KlaviyoAPI::CatalogVariantDeleteJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantBulkDeleteJobEnum::CATALOG_VARIANT_BULK_DELETE_JOB, attributes: KlaviyoAPI::CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.new({variants: [KlaviyoAPI::CatalogVariantDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'})]})})}) # CatalogVariantDeleteJobCreateQuery |
3422
3410
 
3423
3411
  begin
3424
3412
  # Spawn Delete Variants Job
@@ -3473,7 +3461,7 @@ end
3473
3461
 
3474
3462
  Spawn Update Categories Job
3475
3463
 
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`
3464
+ 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
3465
 
3478
3466
  ### Examples
3479
3467
 
@@ -3489,7 +3477,7 @@ KlaviyoAPI.configure do |config|
3489
3477
  end
3490
3478
 
3491
3479
  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 |
3480
+ catalog_category_update_job_create_query = KlaviyoAPI::CatalogCategoryUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryBulkUpdateJobEnum::CATALOG_CATEGORY_BULK_UPDATE_JOB, attributes: KlaviyoAPI::CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.new({categories: [KlaviyoAPI::CatalogCategoryUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryResourceObjectAttributes.new})]})})}) # CatalogCategoryUpdateJobCreateQuery |
3493
3481
 
3494
3482
  begin
3495
3483
  # Spawn Update Categories Job
@@ -3544,7 +3532,7 @@ end
3544
3532
 
3545
3533
  Spawn Update Items Job
3546
3534
 
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`
3535
+ 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
3536
 
3549
3537
  ### Examples
3550
3538
 
@@ -3560,7 +3548,7 @@ KlaviyoAPI.configure do |config|
3560
3548
  end
3561
3549
 
3562
3550
  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 |
3551
+ catalog_item_update_job_create_query = KlaviyoAPI::CatalogItemUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogItemUpdateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemBulkUpdateJobEnum::CATALOG_ITEM_BULK_UPDATE_JOB, attributes: KlaviyoAPI::CatalogItemUpdateJobCreateQueryResourceObjectAttributes.new({items: [KlaviyoAPI::CatalogItemUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1', attributes: KlaviyoAPI::CatalogItemUpdateQueryResourceObjectAttributes.new})]})})}) # CatalogItemUpdateJobCreateQuery |
3564
3552
 
3565
3553
  begin
3566
3554
  # Spawn Update Items Job
@@ -3615,7 +3603,7 @@ end
3615
3603
 
3616
3604
  Spawn Update Variants Job
3617
3605
 
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`
3606
+ 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
3607
 
3620
3608
  ### Examples
3621
3609
 
@@ -3631,7 +3619,7 @@ KlaviyoAPI.configure do |config|
3631
3619
  end
3632
3620
 
3633
3621
  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 |
3622
+ catalog_variant_update_job_create_query = KlaviyoAPI::CatalogVariantUpdateJobCreateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantBulkUpdateJobEnum::CATALOG_VARIANT_BULK_UPDATE_JOB, attributes: KlaviyoAPI::CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.new({variants: [KlaviyoAPI::CatalogVariantUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', attributes: KlaviyoAPI::CatalogVariantUpdateQueryResourceObjectAttributes.new})]})})}) # CatalogVariantUpdateJobCreateQuery |
3635
3623
 
3636
3624
  begin
3637
3625
  # Spawn Update Variants Job
@@ -3702,8 +3690,8 @@ KlaviyoAPI.configure do |config|
3702
3690
  end
3703
3691
 
3704
3692
  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 |
3693
+ 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`.
3694
+ catalog_category_update_query = KlaviyoAPI::CatalogCategoryUpdateQuery.new({data: KlaviyoAPI::CatalogCategoryUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryResourceObjectAttributes.new})}) # CatalogCategoryUpdateQuery |
3707
3695
 
3708
3696
  begin
3709
3697
  # Update Catalog Category
@@ -3736,7 +3724,7 @@ end
3736
3724
 
3737
3725
  | Name | Type | Description | Notes |
3738
3726
  | ---- | ---- | ----------- | ----- |
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. | |
3727
+ | **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
3728
  | **catalog_category_update_query** | [**CatalogCategoryUpdateQuery**](CatalogCategoryUpdateQuery.md) | | |
3741
3729
 
3742
3730
  ### Return type
@@ -3753,11 +3741,11 @@ end
3753
3741
  - **Accept**: application/json
3754
3742
 
3755
3743
 
3756
- ## update_catalog_category_relationships
3744
+ ## update_catalog_category_relationships_items
3757
3745
 
3758
- > update_catalog_category_relationships(id, related_resource, catalog_category_item_op)
3746
+ > update_catalog_category_relationships_items(id, catalog_category_item_op)
3759
3747
 
3760
- Update Catalog Category Relationships
3748
+ Update Catalog Category Relationships Items
3761
3749
 
3762
3750
  Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3763
3751
 
@@ -3776,32 +3764,31 @@ end
3776
3764
 
3777
3765
  api_instance = KlaviyoAPI::CatalogsApi.new
3778
3766
  id = 'id_example' # String |
3779
- related_resource = 'items' # String |
3780
- catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
3767
+ catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemsDataInner.new({type: 'catalog-item', id: 'id_example'})]}) # CatalogCategoryItemOp |
3781
3768
 
3782
3769
  begin
3783
- # Update Catalog Category Relationships
3784
- api_instance.update_catalog_category_relationships(id, related_resource, catalog_category_item_op)
3770
+ # Update Catalog Category Relationships Items
3771
+ api_instance.update_catalog_category_relationships_items(id, catalog_category_item_op)
3785
3772
  rescue KlaviyoAPI::ApiError => e
3786
- puts "Error when calling CatalogsApi->update_catalog_category_relationships: #{e}"
3773
+ puts "Error when calling CatalogsApi->update_catalog_category_relationships_items: #{e}"
3787
3774
  end
3788
3775
  ```
3789
3776
 
3790
- #### Using the update_catalog_category_relationships_with_http_info variant
3777
+ #### Using the update_catalog_category_relationships_items_with_http_info variant
3791
3778
 
3792
3779
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
3793
3780
 
3794
- > <Array(nil, Integer, Hash)> update_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
3781
+ > <Array(nil, Integer, Hash)> update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
3795
3782
 
3796
3783
  ```ruby
3797
3784
  begin
3798
- # Update Catalog Category Relationships
3799
- data, status_code, headers = api_instance.update_catalog_category_relationships_with_http_info(id, related_resource, catalog_category_item_op)
3785
+ # Update Catalog Category Relationships Items
3786
+ data, status_code, headers = api_instance.update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
3800
3787
  p status_code # => 2xx
3801
3788
  p headers # => { ... }
3802
3789
  p data # => nil
3803
3790
  rescue KlaviyoAPI::ApiError => e
3804
- puts "Error when calling CatalogsApi->update_catalog_category_relationships_with_http_info: #{e}"
3791
+ puts "Error when calling CatalogsApi->update_catalog_category_relationships_items_with_http_info: #{e}"
3805
3792
  end
3806
3793
  ```
3807
3794
 
@@ -3810,7 +3797,6 @@ end
3810
3797
  | Name | Type | Description | Notes |
3811
3798
  | ---- | ---- | ----------- | ----- |
3812
3799
  | **id** | **String** | | |
3813
- | **related_resource** | **String** | | |
3814
3800
  | **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
3815
3801
 
3816
3802
  ### Return type
@@ -3849,8 +3835,8 @@ KlaviyoAPI.configure do |config|
3849
3835
  end
3850
3836
 
3851
3837
  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 |
3838
+ 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`.
3839
+ catalog_item_update_query = KlaviyoAPI::CatalogItemUpdateQuery.new({data: KlaviyoAPI::CatalogItemUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1', attributes: KlaviyoAPI::CatalogItemUpdateQueryResourceObjectAttributes.new})}) # CatalogItemUpdateQuery |
3854
3840
 
3855
3841
  begin
3856
3842
  # Update Catalog Item
@@ -3883,7 +3869,7 @@ end
3883
3869
 
3884
3870
  | Name | Type | Description | Notes |
3885
3871
  | ---- | ---- | ----------- | ----- |
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. | |
3872
+ | **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
3873
  | **catalog_item_update_query** | [**CatalogItemUpdateQuery**](CatalogItemUpdateQuery.md) | | |
3888
3874
 
3889
3875
  ### Return type
@@ -3900,11 +3886,11 @@ end
3900
3886
  - **Accept**: application/json
3901
3887
 
3902
3888
 
3903
- ## update_catalog_item_relationships
3889
+ ## update_catalog_item_relationships_categories
3904
3890
 
3905
- > update_catalog_item_relationships(id, related_resource, catalog_item_category_op)
3891
+ > update_catalog_item_relationships_categories(id, catalog_item_category_op)
3906
3892
 
3907
- Update Catalog Item Relationships
3893
+ Update Catalog Item Relationships Categories
3908
3894
 
3909
3895
  Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `Catalogs Write`
3910
3896
 
@@ -3923,32 +3909,31 @@ end
3923
3909
 
3924
3910
  api_instance = KlaviyoAPI::CatalogsApi.new
3925
3911
  id = 'id_example' # String |
3926
- related_resource = 'categories' # String |
3927
- catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
3912
+ catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: 'catalog-category', id: 'id_example'})]}) # CatalogItemCategoryOp |
3928
3913
 
3929
3914
  begin
3930
- # Update Catalog Item Relationships
3931
- api_instance.update_catalog_item_relationships(id, related_resource, catalog_item_category_op)
3915
+ # Update Catalog Item Relationships Categories
3916
+ api_instance.update_catalog_item_relationships_categories(id, catalog_item_category_op)
3932
3917
  rescue KlaviyoAPI::ApiError => e
3933
- puts "Error when calling CatalogsApi->update_catalog_item_relationships: #{e}"
3918
+ puts "Error when calling CatalogsApi->update_catalog_item_relationships_categories: #{e}"
3934
3919
  end
3935
3920
  ```
3936
3921
 
3937
- #### Using the update_catalog_item_relationships_with_http_info variant
3922
+ #### Using the update_catalog_item_relationships_categories_with_http_info variant
3938
3923
 
3939
3924
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
3940
3925
 
3941
- > <Array(nil, Integer, Hash)> update_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
3926
+ > <Array(nil, Integer, Hash)> update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
3942
3927
 
3943
3928
  ```ruby
3944
3929
  begin
3945
- # Update Catalog Item Relationships
3946
- data, status_code, headers = api_instance.update_catalog_item_relationships_with_http_info(id, related_resource, catalog_item_category_op)
3930
+ # Update Catalog Item Relationships Categories
3931
+ data, status_code, headers = api_instance.update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
3947
3932
  p status_code # => 2xx
3948
3933
  p headers # => { ... }
3949
3934
  p data # => nil
3950
3935
  rescue KlaviyoAPI::ApiError => e
3951
- puts "Error when calling CatalogsApi->update_catalog_item_relationships_with_http_info: #{e}"
3936
+ puts "Error when calling CatalogsApi->update_catalog_item_relationships_categories_with_http_info: #{e}"
3952
3937
  end
3953
3938
  ```
3954
3939
 
@@ -3957,7 +3942,6 @@ end
3957
3942
  | Name | Type | Description | Notes |
3958
3943
  | ---- | ---- | ----------- | ----- |
3959
3944
  | **id** | **String** | | |
3960
- | **related_resource** | **String** | | |
3961
3945
  | **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
3962
3946
 
3963
3947
  ### Return type
@@ -3996,8 +3980,8 @@ KlaviyoAPI.configure do |config|
3996
3980
  end
3997
3981
 
3998
3982
  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 |
3983
+ 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`.
3984
+ catalog_variant_update_query = KlaviyoAPI::CatalogVariantUpdateQuery.new({data: KlaviyoAPI::CatalogVariantUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', attributes: KlaviyoAPI::CatalogVariantUpdateQueryResourceObjectAttributes.new})}) # CatalogVariantUpdateQuery |
4001
3985
 
4002
3986
  begin
4003
3987
  # Update Catalog Variant
@@ -4030,7 +4014,7 @@ end
4030
4014
 
4031
4015
  | Name | Type | Description | Notes |
4032
4016
  | ---- | ---- | ----------- | ----- |
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. | |
4017
+ | **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
4018
  | **catalog_variant_update_query** | [**CatalogVariantUpdateQuery**](CatalogVariantUpdateQuery.md) | | |
4035
4019
 
4036
4020
  ### Return type