klaviyo-api-sdk 4.0.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (866) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -0
  3. data/README.md +205 -175
  4. data/Rakefile +10 -0
  5. data/docs/AccountsApi.md +157 -0
  6. data/docs/AudiencesSubObject.md +20 -0
  7. data/docs/BackInStockSubscriptionEnum.md +15 -0
  8. data/docs/CampaignCloneQuery.md +18 -0
  9. data/docs/CampaignCloneQueryResourceObject.md +20 -0
  10. data/docs/CampaignCloneQueryResourceObjectAttributes.md +20 -0
  11. data/docs/CampaignCreateQuery.md +18 -0
  12. data/docs/CampaignCreateQueryResourceObject.md +20 -0
  13. data/docs/CampaignCreateQueryResourceObjectAttributes.md +28 -0
  14. data/docs/CampaignCreateQueryResourceObjectAttributesCampaignMessages.md +18 -0
  15. data/docs/CampaignCreateQueryResourceObjectAttributesSendOptions.md +49 -0
  16. data/docs/CampaignCreateQueryResourceObjectAttributesTrackingOptions.md +49 -0
  17. data/docs/CampaignEnum.md +15 -0
  18. data/docs/CampaignMessageAssignTemplateQuery.md +18 -0
  19. data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +22 -0
  20. data/docs/CampaignMessageAssignTemplateQueryResourceObjectAttributes.md +18 -0
  21. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +18 -0
  22. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md +18 -0
  23. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplateData.md +20 -0
  24. data/docs/CampaignMessageCreateQueryResourceObject.md +20 -0
  25. data/docs/CampaignMessageCreateQueryResourceObjectAttributes.md +24 -0
  26. data/docs/CampaignMessageCreateQueryResourceObjectAttributesContent.md +49 -0
  27. data/docs/CampaignMessageEnum.md +15 -0
  28. data/docs/CampaignMessagePartialUpdateQuery.md +18 -0
  29. data/docs/CampaignMessagePartialUpdateQueryResourceObject.md +22 -0
  30. data/docs/CampaignMessagePartialUpdateQueryResourceObjectAttributes.md +22 -0
  31. data/docs/CampaignPartialUpdateQuery.md +18 -0
  32. data/docs/CampaignPartialUpdateQueryResourceObject.md +22 -0
  33. data/docs/CampaignPartialUpdateQueryResourceObjectAttributes.md +26 -0
  34. data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
  35. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObject.md +20 -0
  36. data/docs/CampaignRecipientEstimationJobCreateQueryResourceObjectAttributes.md +18 -0
  37. data/docs/CampaignRecipientEstimationJobEnum.md +15 -0
  38. data/docs/CampaignSendJobCreateQuery.md +18 -0
  39. data/docs/CampaignSendJobCreateQueryResourceObject.md +20 -0
  40. data/docs/CampaignSendJobCreateQueryResourceObjectAttributes.md +18 -0
  41. data/docs/CampaignSendJobEnum.md +15 -0
  42. data/docs/CampaignSendJobPartialUpdateQuery.md +18 -0
  43. data/docs/CampaignSendJobPartialUpdateQueryResourceObject.md +22 -0
  44. data/docs/CampaignSendJobPartialUpdateQueryResourceObjectAttributes.md +18 -0
  45. data/docs/CampaignsApi.md +1735 -0
  46. data/docs/CatalogCategoryBulkCreateJobEnum.md +15 -0
  47. data/docs/CatalogCategoryBulkDeleteJobEnum.md +15 -0
  48. data/docs/CatalogCategoryBulkUpdateJobEnum.md +15 -0
  49. data/docs/CatalogCategoryCreateJobCreateQuery.md +18 -0
  50. data/docs/CatalogCategoryCreateJobCreateQueryResourceObject.md +20 -0
  51. data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  52. data/docs/CatalogCategoryCreateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
  53. data/docs/CatalogCategoryCreateQuery.md +18 -0
  54. data/docs/CatalogCategoryCreateQueryResourceObject.md +22 -0
  55. data/docs/CatalogCategoryCreateQueryResourceObjectAttributes.md +24 -0
  56. data/docs/CatalogCategoryCreateQueryResourceObjectRelationships.md +18 -0
  57. data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +18 -0
  58. data/docs/CatalogCategoryDeleteJobCreateQuery.md +18 -0
  59. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObject.md +20 -0
  60. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  61. data/docs/CatalogCategoryDeleteJobCreateQueryResourceObjectAttributesCategories.md +18 -0
  62. data/docs/CatalogCategoryDeleteQueryResourceObject.md +20 -0
  63. data/docs/CatalogCategoryEnum.md +15 -0
  64. data/docs/CatalogCategoryItemOp.md +18 -0
  65. data/docs/CatalogCategoryUpdateJobCreateQuery.md +18 -0
  66. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObject.md +20 -0
  67. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  68. data/docs/CatalogCategoryUpdateJobCreateQueryResourceObjectAttributesCategories.md +18 -0
  69. data/docs/CatalogCategoryUpdateQuery.md +18 -0
  70. data/docs/CatalogCategoryUpdateQueryResourceObject.md +24 -0
  71. data/docs/CatalogCategoryUpdateQueryResourceObjectAttributes.md +18 -0
  72. data/docs/CatalogItemBulkCreateJobEnum.md +15 -0
  73. data/docs/CatalogItemBulkDeleteJobEnum.md +15 -0
  74. data/docs/CatalogItemBulkUpdateJobEnum.md +15 -0
  75. data/docs/CatalogItemCategoryOp.md +18 -0
  76. data/docs/CatalogItemCreateJobCreateQuery.md +18 -0
  77. data/docs/CatalogItemCreateJobCreateQueryResourceObject.md +20 -0
  78. data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  79. data/docs/CatalogItemCreateJobCreateQueryResourceObjectAttributesItems.md +18 -0
  80. data/docs/CatalogItemCreateQuery.md +18 -0
  81. data/docs/CatalogItemCreateQueryResourceObject.md +22 -0
  82. data/docs/CatalogItemCreateQueryResourceObjectAttributes.md +40 -0
  83. data/docs/CatalogItemCreateQueryResourceObjectRelationships.md +18 -0
  84. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +18 -0
  85. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.md +20 -0
  86. data/docs/CatalogItemDeleteJobCreateQuery.md +18 -0
  87. data/docs/CatalogItemDeleteJobCreateQueryResourceObject.md +20 -0
  88. data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  89. data/docs/CatalogItemDeleteJobCreateQueryResourceObjectAttributesItems.md +18 -0
  90. data/docs/CatalogItemDeleteQueryResourceObject.md +20 -0
  91. data/docs/CatalogItemEnum.md +15 -0
  92. data/docs/CatalogItemUpdateJobCreateQuery.md +18 -0
  93. data/docs/CatalogItemUpdateJobCreateQueryResourceObject.md +20 -0
  94. data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  95. data/docs/CatalogItemUpdateJobCreateQueryResourceObjectAttributesItems.md +18 -0
  96. data/docs/CatalogItemUpdateQuery.md +18 -0
  97. data/docs/CatalogItemUpdateQueryResourceObject.md +24 -0
  98. data/docs/CatalogItemUpdateQueryResourceObjectAttributes.md +34 -0
  99. data/docs/CatalogVariantBulkCreateJobEnum.md +15 -0
  100. data/docs/CatalogVariantBulkDeleteJobEnum.md +15 -0
  101. data/docs/CatalogVariantBulkUpdateJobEnum.md +15 -0
  102. data/docs/CatalogVariantCreateJobCreateQuery.md +18 -0
  103. data/docs/CatalogVariantCreateJobCreateQueryResourceObject.md +20 -0
  104. data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  105. data/docs/CatalogVariantCreateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
  106. data/docs/CatalogVariantCreateQuery.md +18 -0
  107. data/docs/CatalogVariantCreateQueryResourceObject.md +22 -0
  108. data/docs/CatalogVariantCreateQueryResourceObjectAttributes.md +46 -0
  109. data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +18 -0
  110. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md +18 -0
  111. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItemData.md +20 -0
  112. data/docs/CatalogVariantDeleteJobCreateQuery.md +18 -0
  113. data/docs/CatalogVariantDeleteJobCreateQueryResourceObject.md +20 -0
  114. data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  115. data/docs/CatalogVariantDeleteJobCreateQueryResourceObjectAttributesVariants.md +18 -0
  116. data/docs/CatalogVariantDeleteQueryResourceObject.md +20 -0
  117. data/docs/CatalogVariantEnum.md +15 -0
  118. data/docs/CatalogVariantUpdateJobCreateQuery.md +18 -0
  119. data/docs/CatalogVariantUpdateJobCreateQueryResourceObject.md +20 -0
  120. data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributes.md +18 -0
  121. data/docs/CatalogVariantUpdateJobCreateQueryResourceObjectAttributesVariants.md +18 -0
  122. data/docs/CatalogVariantUpdateQuery.md +18 -0
  123. data/docs/CatalogVariantUpdateQueryResourceObject.md +22 -0
  124. data/docs/CatalogVariantUpdateQueryResourceObjectAttributes.md +40 -0
  125. data/docs/CatalogsApi.md +4103 -0
  126. data/docs/DataPrivacyApi.md +78 -0
  127. data/docs/DataPrivacyCreateDeletionJobQuery.md +18 -0
  128. data/docs/DataPrivacyCreateDeletionJobQueryResourceObject.md +20 -0
  129. data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributes.md +18 -0
  130. data/docs/DataPrivacyCreateDeletionJobQueryResourceObjectAttributesProfile.md +18 -0
  131. data/docs/DataPrivacyDeletionJobEnum.md +15 -0
  132. data/docs/DataPrivacyProfileQueryResourceObject.md +22 -0
  133. data/docs/DataPrivacyProfileQueryResourceObjectAttributes.md +20 -0
  134. data/docs/DeviceMetadata.md +40 -0
  135. data/docs/EmailContentSubObject.md +30 -0
  136. data/docs/EmailSendOptionsSubObject.md +18 -0
  137. data/docs/EmailTrackingOptionsSubObject.md +24 -0
  138. data/docs/EventCreateQueryV2.md +18 -0
  139. data/docs/EventCreateQueryV2ResourceObject.md +20 -0
  140. data/docs/EventCreateQueryV2ResourceObjectAttributes.md +28 -0
  141. data/docs/EventCreateQueryV2ResourceObjectAttributesMetric.md +18 -0
  142. data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md +18 -0
  143. data/docs/EventEnum.md +15 -0
  144. data/docs/EventsApi.md +544 -0
  145. data/docs/FlowEnum.md +15 -0
  146. data/docs/FlowUpdateQuery.md +18 -0
  147. data/docs/FlowUpdateQueryResourceObject.md +22 -0
  148. data/docs/FlowUpdateQueryResourceObjectAttributes.md +18 -0
  149. data/docs/FlowsApi.md +1335 -0
  150. data/docs/GetAccounts4XXResponse.md +18 -0
  151. data/docs/GetAccounts4XXResponseErrorsInner.md +26 -0
  152. data/docs/GetAccounts4XXResponseErrorsInnerSource.md +20 -0
  153. data/docs/ListCreateQuery.md +18 -0
  154. data/docs/ListCreateQueryResourceObject.md +20 -0
  155. data/docs/ListCreateQueryResourceObjectAttributes.md +18 -0
  156. data/docs/ListEnum.md +15 -0
  157. data/docs/ListMembersAddQuery.md +18 -0
  158. data/docs/ListMembersAddQueryDataInner.md +20 -0
  159. data/docs/ListMembersDeleteQuery.md +18 -0
  160. data/docs/ListPartialUpdateQuery.md +18 -0
  161. data/docs/ListPartialUpdateQueryResourceObject.md +22 -0
  162. data/docs/ListsApi.md +842 -0
  163. data/docs/MetricAggregateEnum.md +15 -0
  164. data/docs/MetricAggregateQuery.md +18 -0
  165. data/docs/MetricAggregateQueryResourceObject.md +20 -0
  166. data/docs/MetricAggregateQueryResourceObjectAttributes.md +36 -0
  167. data/docs/MetricCreateQueryResourceObject.md +20 -0
  168. data/docs/MetricCreateQueryResourceObjectAttributes.md +20 -0
  169. data/docs/MetricEnum.md +15 -0
  170. data/docs/MetricsApi.md +233 -0
  171. data/docs/OnsiteProfileCreateQueryResourceObject.md +24 -0
  172. data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +38 -0
  173. data/docs/OnsiteProfileMeta.md +18 -0
  174. data/docs/ProfileCreateQuery.md +18 -0
  175. data/docs/ProfileCreateQueryResourceObject.md +20 -0
  176. data/docs/ProfileCreateQueryResourceObjectAttributes.md +36 -0
  177. data/docs/ProfileEnum.md +15 -0
  178. data/docs/ProfileIdentifierDTOResourceObject.md +22 -0
  179. data/docs/ProfileIdentifierDTOResourceObjectAttributes.md +24 -0
  180. data/docs/ProfileLocation.md +34 -0
  181. data/docs/ProfileLocationLatitude.md +49 -0
  182. data/docs/ProfileLocationLongitude.md +49 -0
  183. data/docs/ProfileMeta.md +18 -0
  184. data/docs/ProfileMetaPatchProperties.md +22 -0
  185. data/docs/ProfileMetaPatchPropertiesUnset.md +49 -0
  186. data/docs/ProfilePartialUpdateQuery.md +18 -0
  187. data/docs/ProfilePartialUpdateQueryResourceObject.md +24 -0
  188. data/docs/ProfileSubscriptionBulkCreateJobEnum.md +15 -0
  189. data/docs/ProfileSubscriptionBulkDeleteJobEnum.md +15 -0
  190. data/docs/ProfileSubscriptionCreateQueryResourceObject.md +22 -0
  191. data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +22 -0
  192. data/docs/ProfileSubscriptionDeleteQueryResourceObject.md +20 -0
  193. data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +20 -0
  194. data/docs/ProfileSuppressionBulkCreateJobEnum.md +15 -0
  195. data/docs/ProfileSuppressionBulkDeleteJobEnum.md +15 -0
  196. data/docs/ProfileSuppressionCreateQueryResourceObject.md +20 -0
  197. data/docs/ProfileSuppressionCreateQueryResourceObjectAttributes.md +18 -0
  198. data/docs/ProfileSuppressionDeleteQueryResourceObject.md +20 -0
  199. data/docs/ProfileSuppressionDeleteQueryResourceObjectAttributes.md +18 -0
  200. data/docs/ProfileUpsertQueryResourceObject.md +22 -0
  201. data/docs/ProfileUpsertQueryResourceObjectAttributes.md +40 -0
  202. data/docs/ProfilesApi.md +972 -0
  203. data/docs/PushTokenCreateQuery.md +18 -0
  204. data/docs/PushTokenCreateQueryResourceObject.md +20 -0
  205. data/docs/PushTokenCreateQueryResourceObjectAttributes.md +30 -0
  206. data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md +18 -0
  207. data/docs/PushTokenEnum.md +15 -0
  208. data/docs/RenderOptionsSubObject.md +24 -0
  209. data/docs/SMSContentSubObjectCreate.md +18 -0
  210. data/docs/SMSSendOptionsSubObject.md +18 -0
  211. data/docs/SMSTrackingOptionsSubObject.md +20 -0
  212. data/docs/STOScheduleOptions.md +18 -0
  213. data/docs/SegmentEnum.md +15 -0
  214. data/docs/SegmentPartialUpdateQuery.md +18 -0
  215. data/docs/SegmentPartialUpdateQueryResourceObject.md +22 -0
  216. data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +18 -0
  217. data/docs/SegmentsApi.md +553 -0
  218. data/docs/SendStrategySubObject.md +24 -0
  219. data/docs/ServerBISSubscriptionCreateQuery.md +18 -0
  220. data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +22 -0
  221. data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributes.md +20 -0
  222. data/docs/ServerBISSubscriptionCreateQueryResourceObjectAttributesProfile.md +18 -0
  223. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +18 -0
  224. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md +18 -0
  225. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariantData.md +20 -0
  226. data/docs/StaticScheduleOptions.md +22 -0
  227. data/docs/SubscriptionChannels.md +20 -0
  228. data/docs/SubscriptionCreateJobCreateQuery.md +18 -0
  229. data/docs/SubscriptionCreateJobCreateQueryResourceObject.md +22 -0
  230. data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributes.md +20 -0
  231. data/docs/SubscriptionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  232. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationships.md +18 -0
  233. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md +18 -0
  234. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
  235. data/docs/SubscriptionDeleteJobCreateQuery.md +18 -0
  236. data/docs/SubscriptionDeleteJobCreateQueryResourceObject.md +22 -0
  237. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  238. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  239. data/docs/SuppressionCreateJobCreateQuery.md +18 -0
  240. data/docs/SuppressionCreateJobCreateQueryResourceObject.md +20 -0
  241. data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +18 -0
  242. data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  243. data/docs/SuppressionDeleteJobCreateQuery.md +18 -0
  244. data/docs/SuppressionDeleteJobCreateQueryResourceObject.md +20 -0
  245. data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributes.md +18 -0
  246. data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributesProfiles.md +18 -0
  247. data/docs/TagCampaignOp.md +18 -0
  248. data/docs/TagCampaignOpDataInner.md +20 -0
  249. data/docs/TagCreateQuery.md +18 -0
  250. data/docs/TagCreateQueryResourceObject.md +22 -0
  251. data/docs/TagCreateQueryResourceObjectAttributes.md +18 -0
  252. data/docs/TagCreateQueryResourceObjectRelationships.md +18 -0
  253. data/docs/TagCreateQueryResourceObjectRelationshipsTagGroup.md +18 -0
  254. data/docs/TagCreateQueryResourceObjectRelationshipsTagGroupData.md +20 -0
  255. data/docs/TagEnum.md +15 -0
  256. data/docs/TagFlowOp.md +18 -0
  257. data/docs/TagFlowOpDataInner.md +20 -0
  258. data/docs/TagGroupCreateQuery.md +18 -0
  259. data/docs/TagGroupCreateQueryResourceObject.md +20 -0
  260. data/docs/TagGroupCreateQueryResourceObjectAttributes.md +20 -0
  261. data/docs/TagGroupEnum.md +15 -0
  262. data/docs/TagGroupUpdateQuery.md +18 -0
  263. data/docs/TagGroupUpdateQueryResourceObject.md +22 -0
  264. data/docs/TagGroupUpdateQueryResourceObjectAttributes.md +20 -0
  265. data/docs/TagListOp.md +18 -0
  266. data/docs/TagListOpDataInner.md +20 -0
  267. data/docs/TagSegmentOp.md +18 -0
  268. data/docs/TagSegmentOpDataInner.md +20 -0
  269. data/docs/TagUpdateQuery.md +18 -0
  270. data/docs/TagUpdateQueryResourceObject.md +22 -0
  271. data/docs/TagsApi.md +1929 -0
  272. data/docs/TemplateCloneQuery.md +18 -0
  273. data/docs/TemplateCloneQueryResourceObject.md +20 -0
  274. data/docs/TemplateCloneQueryResourceObjectAttributes.md +20 -0
  275. data/docs/TemplateCreateQuery.md +18 -0
  276. data/docs/TemplateCreateQueryResourceObject.md +20 -0
  277. data/docs/TemplateCreateQueryResourceObjectAttributes.md +30 -0
  278. data/docs/TemplateEnum.md +15 -0
  279. data/docs/TemplateRenderQuery.md +18 -0
  280. data/docs/TemplateRenderQueryResourceObject.md +20 -0
  281. data/docs/TemplateRenderQueryResourceObjectAttributes.md +20 -0
  282. data/docs/TemplateUpdateQuery.md +18 -0
  283. data/docs/TemplateUpdateQueryResourceObject.md +22 -0
  284. data/docs/TemplateUpdateQueryResourceObjectAttributes.md +28 -0
  285. data/docs/TemplatesApi.md +524 -0
  286. data/docs/ThrottledScheduleOptions.md +20 -0
  287. data/docs/UTMParamsSubObject.md +20 -0
  288. data/git_push.sh +57 -0
  289. data/klaviyo-api-sdk.gemspec +2 -2
  290. data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
  291. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +85 -85
  292. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +309 -309
  293. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
  294. data/lib/klaviyo-api-sdk/api/events_api.rb +40 -40
  295. data/lib/klaviyo-api-sdk/api/flows_api.rb +235 -91
  296. data/lib/klaviyo-api-sdk/api/lists_api.rb +48 -48
  297. data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
  298. data/lib/klaviyo-api-sdk/api/profiles_api.rb +119 -49
  299. data/lib/klaviyo-api-sdk/api/segments_api.rb +40 -40
  300. data/lib/klaviyo-api-sdk/api/tags_api.rb +89 -89
  301. data/lib/klaviyo-api-sdk/api/templates_api.rb +24 -24
  302. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  303. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  304. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  305. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  306. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  307. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  308. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +19 -19
  309. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +15 -15
  310. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  311. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +19 -19
  312. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +28 -28
  313. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  314. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
  315. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
  316. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  317. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  318. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +19 -19
  319. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +1 -1
  320. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
  321. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
  322. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +2 -36
  323. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +19 -19
  324. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +23 -23
  325. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
  326. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  327. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  328. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +19 -19
  329. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +15 -15
  330. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  331. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +19 -19
  332. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +27 -27
  333. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  334. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +19 -19
  335. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
  336. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  337. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  338. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +19 -19
  339. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
  340. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  341. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  342. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +19 -19
  343. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  344. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  345. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  348. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +19 -19
  349. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  350. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  351. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +19 -19
  353. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +17 -17
  354. data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships.rb → catalog_category_create_query_resource_object_relationships.rb} +5 -5
  355. data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_resource_object_relationships_items.rb → catalog_category_create_query_resource_object_relationships_items.rb} +5 -5
  356. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +19 -19
  358. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  360. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  363. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  364. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +19 -19
  365. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  366. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  367. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +28 -28
  369. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  370. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  371. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  372. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  373. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  374. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  375. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +19 -19
  376. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  377. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  378. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  379. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +19 -19
  380. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +72 -72
  381. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  382. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +2 -2
  383. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +238 -0
  384. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  385. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +19 -19
  386. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  387. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  388. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  389. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  390. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  391. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +19 -19
  392. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  393. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  394. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  395. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +28 -28
  396. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +43 -43
  397. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  398. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  399. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  400. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  401. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +19 -19
  402. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  403. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  404. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  405. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +19 -19
  406. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +116 -116
  407. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
  408. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +2 -2
  409. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +238 -0
  410. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  411. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +19 -19
  412. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  413. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  414. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  415. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  416. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  417. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +19 -19
  418. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  419. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  420. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  421. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +19 -19
  422. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +58 -58
  423. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  424. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +19 -19
  425. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  426. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  427. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  428. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +19 -19
  429. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +15 -15
  430. data/lib/klaviyo-api-sdk/models/{catalog_item_category_op_data_inner.rb → device_metadata.rb} +151 -35
  431. data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +39 -9
  432. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
  433. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +22 -22
  434. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  435. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +19 -19
  436. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +41 -41
  437. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  438. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
  439. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  440. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  441. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  442. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +19 -19
  443. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  444. data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response.rb → get_accounts4_xx_response.rb} +5 -5
  445. data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner.rb → get_accounts4_xx_response_errors_inner.rb} +40 -40
  446. data/lib/klaviyo-api-sdk/models/{get_create_variants_jobs5_xx_response_errors_inner_source.rb → get_accounts4_xx_response_errors_inner_source.rb} +17 -17
  447. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  448. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +19 -19
  449. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  450. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  451. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  452. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +2 -36
  453. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  454. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  455. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +19 -19
  456. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  457. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  458. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +19 -19
  459. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +63 -63
  460. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +19 -19
  461. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
  462. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  463. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +28 -28
  464. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +45 -55
  465. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  466. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  467. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +19 -19
  468. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +39 -39
  469. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  470. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +19 -19
  471. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +12 -12
  472. data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
  473. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  474. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  475. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  476. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +15 -15
  477. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  478. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  479. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +28 -28
  480. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  481. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  482. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +19 -19
  483. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +12 -12
  484. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +19 -19
  485. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +15 -15
  486. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  487. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  488. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +19 -19
  489. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
  490. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +19 -19
  491. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
  492. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +248 -0
  493. data/lib/klaviyo-api-sdk/models/{profile_partial_update_query_resource_object_attributes.rb → profile_upsert_query_resource_object_attributes.rb} +55 -45
  494. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +224 -0
  495. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +238 -0
  496. data/lib/klaviyo-api-sdk/models/{subscription_delete_job_create_query_resource_object_relationships_list_data.rb → push_token_create_query_resource_object_attributes.rb} +131 -31
  497. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +225 -0
  498. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +36 -0
  499. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +16 -25
  500. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  501. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  502. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +19 -19
  503. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  504. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
  505. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  506. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +19 -19
  507. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
  508. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  509. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
  510. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
  511. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +2 -36
  512. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
  513. data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
  514. data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +15 -15
  515. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
  516. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  517. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
  518. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  519. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +19 -19
  520. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -14
  521. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  522. data/lib/klaviyo-api-sdk/models/{subscription_delete_job_create_query_resource_object_relationships.rb → subscription_create_job_create_query_resource_object_relationships.rb} +5 -5
  523. data/lib/klaviyo-api-sdk/models/{subscription_delete_job_create_query_resource_object_relationships_list.rb → subscription_create_job_create_query_resource_object_relationships_list.rb} +5 -5
  524. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +238 -0
  525. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  526. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +19 -19
  527. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  528. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  529. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  530. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +19 -19
  531. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  532. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  533. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  534. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +19 -19
  535. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
  536. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  537. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  538. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +2 -36
  539. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  540. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +20 -20
  541. data/lib/klaviyo-api-sdk/models/{tag_update_query_resource_object_attributes.rb → tag_create_query_resource_object_attributes.rb} +4 -4
  542. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  543. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
  544. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +2 -36
  545. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  546. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  547. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +2 -36
  548. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  549. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +19 -19
  550. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +14 -14
  551. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  552. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  553. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +19 -19
  554. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +14 -14
  555. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  556. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +2 -36
  557. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  558. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +2 -36
  559. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  560. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +19 -19
  561. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  562. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +19 -19
  563. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
  564. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  565. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +19 -19
  566. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +25 -25
  567. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  568. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  569. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +19 -19
  570. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +2 -2
  571. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  572. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +19 -19
  573. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +16 -16
  574. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
  575. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  576. data/lib/klaviyo-api-sdk/version.rb +1 -1
  577. data/lib/klaviyo-api-sdk.rb +20 -13
  578. data/spec/api/accounts_api_spec.rb +60 -0
  579. data/spec/api/campaigns_api_spec.rb +338 -0
  580. data/spec/api/catalogs_api_spec.rb +763 -0
  581. data/spec/api/data_privacy_api_spec.rb +47 -0
  582. data/spec/api/events_api_spec.rb +132 -0
  583. data/spec/api/flows_api_spec.rb +279 -0
  584. data/spec/api/lists_api_spec.rb +185 -0
  585. data/spec/api/metrics_api_spec.rb +74 -0
  586. data/spec/api/profiles_api_spec.rb +204 -0
  587. data/spec/api/segments_api_spec.rb +135 -0
  588. data/spec/api/tags_api_spec.rb +371 -0
  589. data/spec/api/templates_api_spec.rb +124 -0
  590. data/spec/api_client_spec.rb +226 -0
  591. data/spec/configuration_spec.rb +42 -0
  592. data/spec/models/audiences_sub_object_spec.rb +40 -0
  593. data/spec/models/back_in_stock_subscription_enum_spec.rb +28 -0
  594. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +40 -0
  595. data/spec/models/campaign_clone_query_resource_object_spec.rb +40 -0
  596. data/spec/models/campaign_clone_query_spec.rb +34 -0
  597. data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +34 -0
  598. data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +31 -0
  599. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +64 -0
  600. data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +31 -0
  601. data/spec/models/campaign_create_query_resource_object_spec.rb +40 -0
  602. data/spec/models/campaign_create_query_spec.rb +34 -0
  603. data/spec/models/campaign_enum_spec.rb +28 -0
  604. data/spec/models/campaign_message_assign_template_query_resource_object_attributes_spec.rb +34 -0
  605. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +34 -0
  606. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +40 -0
  607. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +34 -0
  608. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +46 -0
  609. data/spec/models/campaign_message_assign_template_query_spec.rb +34 -0
  610. data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +31 -0
  611. data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +52 -0
  612. data/spec/models/campaign_message_create_query_resource_object_spec.rb +40 -0
  613. data/spec/models/campaign_message_enum_spec.rb +28 -0
  614. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +46 -0
  615. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +46 -0
  616. data/spec/models/campaign_message_partial_update_query_spec.rb +34 -0
  617. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +58 -0
  618. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +46 -0
  619. data/spec/models/campaign_partial_update_query_spec.rb +34 -0
  620. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_attributes_spec.rb +34 -0
  621. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +40 -0
  622. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
  623. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +28 -0
  624. data/spec/models/campaign_send_job_create_query_resource_object_attributes_spec.rb +34 -0
  625. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +40 -0
  626. data/spec/models/campaign_send_job_create_query_spec.rb +34 -0
  627. data/spec/models/campaign_send_job_enum_spec.rb +28 -0
  628. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +34 -0
  629. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +46 -0
  630. data/spec/models/campaign_send_job_partial_update_query_spec.rb +34 -0
  631. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +28 -0
  632. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +28 -0
  633. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +28 -0
  634. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
  635. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  636. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +40 -0
  637. data/spec/models/catalog_category_create_job_create_query_spec.rb +34 -0
  638. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +56 -0
  639. data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +34 -0
  640. data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +34 -0
  641. data/spec/models/catalog_category_create_query_resource_object_spec.rb +46 -0
  642. data/spec/models/catalog_category_create_query_spec.rb +34 -0
  643. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
  644. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  645. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +40 -0
  646. data/spec/models/catalog_category_delete_job_create_query_spec.rb +34 -0
  647. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +40 -0
  648. data/spec/models/catalog_category_enum_spec.rb +28 -0
  649. data/spec/models/catalog_category_item_op_spec.rb +34 -0
  650. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +34 -0
  651. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  652. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +40 -0
  653. data/spec/models/catalog_category_update_job_create_query_spec.rb +34 -0
  654. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +34 -0
  655. data/spec/models/catalog_category_update_query_resource_object_spec.rb +52 -0
  656. data/spec/models/catalog_category_update_query_spec.rb +34 -0
  657. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +28 -0
  658. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +28 -0
  659. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +28 -0
  660. data/spec/models/catalog_item_category_op_spec.rb +34 -0
  661. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +34 -0
  662. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  663. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +40 -0
  664. data/spec/models/catalog_item_create_job_create_query_spec.rb +34 -0
  665. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +104 -0
  666. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +40 -0
  667. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +34 -0
  668. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +34 -0
  669. data/spec/models/catalog_item_create_query_resource_object_spec.rb +46 -0
  670. data/spec/models/catalog_item_create_query_spec.rb +34 -0
  671. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +34 -0
  672. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  673. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +40 -0
  674. data/spec/models/catalog_item_delete_job_create_query_spec.rb +34 -0
  675. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +40 -0
  676. data/spec/models/catalog_item_enum_spec.rb +28 -0
  677. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +34 -0
  678. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  679. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +40 -0
  680. data/spec/models/catalog_item_update_job_create_query_spec.rb +34 -0
  681. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +82 -0
  682. data/spec/models/catalog_item_update_query_resource_object_spec.rb +52 -0
  683. data/spec/models/catalog_item_update_query_spec.rb +34 -0
  684. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +28 -0
  685. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +28 -0
  686. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +28 -0
  687. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  688. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
  689. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +40 -0
  690. data/spec/models/catalog_variant_create_job_create_query_spec.rb +34 -0
  691. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +126 -0
  692. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +40 -0
  693. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +34 -0
  694. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +34 -0
  695. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +46 -0
  696. data/spec/models/catalog_variant_create_query_spec.rb +34 -0
  697. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  698. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
  699. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +40 -0
  700. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +34 -0
  701. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +40 -0
  702. data/spec/models/catalog_variant_enum_spec.rb +28 -0
  703. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +34 -0
  704. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +34 -0
  705. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +40 -0
  706. data/spec/models/catalog_variant_update_job_create_query_spec.rb +34 -0
  707. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +104 -0
  708. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +46 -0
  709. data/spec/models/catalog_variant_update_query_spec.rb +34 -0
  710. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +34 -0
  711. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +34 -0
  712. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +40 -0
  713. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +34 -0
  714. data/spec/models/data_privacy_deletion_job_enum_spec.rb +28 -0
  715. data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +40 -0
  716. data/spec/models/data_privacy_profile_query_resource_object_spec.rb +46 -0
  717. data/spec/models/device_metadata_spec.rb +112 -0
  718. data/spec/models/email_content_sub_object_spec.rb +70 -0
  719. data/spec/models/email_send_options_sub_object_spec.rb +34 -0
  720. data/spec/models/email_tracking_options_sub_object_spec.rb +52 -0
  721. data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +34 -0
  722. data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +34 -0
  723. data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +64 -0
  724. data/spec/models/event_create_query_v2_resource_object_spec.rb +40 -0
  725. data/spec/models/event_create_query_v2_spec.rb +34 -0
  726. data/spec/models/event_enum_spec.rb +28 -0
  727. data/spec/models/flow_enum_spec.rb +28 -0
  728. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +34 -0
  729. data/spec/models/flow_update_query_resource_object_spec.rb +46 -0
  730. data/spec/models/flow_update_query_spec.rb +34 -0
  731. data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +40 -0
  732. data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +58 -0
  733. data/spec/models/get_accounts4_xx_response_spec.rb +34 -0
  734. data/spec/models/list_create_query_resource_object_attributes_spec.rb +34 -0
  735. data/spec/models/list_create_query_resource_object_spec.rb +40 -0
  736. data/spec/models/list_create_query_spec.rb +34 -0
  737. data/spec/models/list_enum_spec.rb +28 -0
  738. data/spec/models/list_members_add_query_data_inner_spec.rb +40 -0
  739. data/spec/models/list_members_add_query_spec.rb +34 -0
  740. data/spec/models/list_members_delete_query_spec.rb +34 -0
  741. data/spec/models/list_partial_update_query_resource_object_spec.rb +46 -0
  742. data/spec/models/list_partial_update_query_spec.rb +34 -0
  743. data/spec/models/metric_aggregate_enum_spec.rb +28 -0
  744. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +104 -0
  745. data/spec/models/metric_aggregate_query_resource_object_spec.rb +40 -0
  746. data/spec/models/metric_aggregate_query_spec.rb +34 -0
  747. data/spec/models/metric_create_query_resource_object_attributes_spec.rb +40 -0
  748. data/spec/models/metric_create_query_resource_object_spec.rb +40 -0
  749. data/spec/models/metric_enum_spec.rb +28 -0
  750. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +94 -0
  751. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +52 -0
  752. data/spec/models/onsite_profile_meta_spec.rb +34 -0
  753. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +88 -0
  754. data/spec/models/profile_create_query_resource_object_spec.rb +40 -0
  755. data/spec/models/profile_create_query_spec.rb +34 -0
  756. data/spec/models/profile_enum_spec.rb +28 -0
  757. data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +52 -0
  758. data/spec/models/profile_identifier_dto_resource_object_spec.rb +46 -0
  759. data/spec/models/profile_location_latitude_spec.rb +31 -0
  760. data/spec/models/profile_location_longitude_spec.rb +31 -0
  761. data/spec/models/profile_location_spec.rb +82 -0
  762. data/spec/models/profile_meta_patch_properties_spec.rb +46 -0
  763. data/spec/models/profile_meta_patch_properties_unset_spec.rb +31 -0
  764. data/spec/models/profile_meta_spec.rb +34 -0
  765. data/spec/models/profile_partial_update_query_resource_object_spec.rb +52 -0
  766. data/spec/models/profile_partial_update_query_spec.rb +34 -0
  767. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +28 -0
  768. data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +28 -0
  769. data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +46 -0
  770. data/spec/models/profile_subscription_create_query_resource_object_spec.rb +46 -0
  771. data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +40 -0
  772. data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +40 -0
  773. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +28 -0
  774. data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +28 -0
  775. data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +34 -0
  776. data/spec/models/profile_suppression_create_query_resource_object_spec.rb +40 -0
  777. data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +34 -0
  778. data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +40 -0
  779. data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +100 -0
  780. data/spec/models/profile_upsert_query_resource_object_spec.rb +46 -0
  781. data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +34 -0
  782. data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +86 -0
  783. data/spec/models/push_token_create_query_resource_object_spec.rb +40 -0
  784. data/spec/models/push_token_create_query_spec.rb +34 -0
  785. data/spec/models/push_token_enum_spec.rb +28 -0
  786. data/spec/models/render_options_sub_object_spec.rb +52 -0
  787. data/spec/models/segment_enum_spec.rb +28 -0
  788. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +34 -0
  789. data/spec/models/segment_partial_update_query_resource_object_spec.rb +46 -0
  790. data/spec/models/segment_partial_update_query_spec.rb +34 -0
  791. data/spec/models/send_strategy_sub_object_spec.rb +52 -0
  792. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +34 -0
  793. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +44 -0
  794. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +34 -0
  795. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +40 -0
  796. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +34 -0
  797. data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +46 -0
  798. data/spec/models/server_bis_subscription_create_query_spec.rb +34 -0
  799. data/spec/models/sms_content_sub_object_create_spec.rb +34 -0
  800. data/spec/models/sms_send_options_sub_object_spec.rb +34 -0
  801. data/spec/models/sms_tracking_options_sub_object_spec.rb +40 -0
  802. data/spec/models/static_schedule_options_spec.rb +46 -0
  803. data/spec/models/sto_schedule_options_spec.rb +34 -0
  804. data/spec/models/subscription_channels_spec.rb +48 -0
  805. data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  806. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +40 -0
  807. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
  808. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +34 -0
  809. data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +34 -0
  810. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +46 -0
  811. data/spec/models/subscription_create_job_create_query_spec.rb +34 -0
  812. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  813. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  814. data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +46 -0
  815. data/spec/models/subscription_delete_job_create_query_spec.rb +34 -0
  816. data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  817. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +34 -0
  818. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +40 -0
  819. data/spec/models/suppression_create_job_create_query_spec.rb +34 -0
  820. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +34 -0
  821. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +34 -0
  822. data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +40 -0
  823. data/spec/models/suppression_delete_job_create_query_spec.rb +34 -0
  824. data/spec/models/tag_campaign_op_data_inner_spec.rb +40 -0
  825. data/spec/models/tag_campaign_op_spec.rb +34 -0
  826. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +34 -0
  827. data/spec/models/tag_create_query_resource_object_relationships_spec.rb +34 -0
  828. data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +40 -0
  829. data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +34 -0
  830. data/spec/models/tag_create_query_resource_object_spec.rb +46 -0
  831. data/spec/models/tag_create_query_spec.rb +34 -0
  832. data/spec/models/tag_enum_spec.rb +28 -0
  833. data/spec/models/tag_flow_op_data_inner_spec.rb +40 -0
  834. data/spec/models/tag_flow_op_spec.rb +34 -0
  835. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +40 -0
  836. data/spec/models/tag_group_create_query_resource_object_spec.rb +40 -0
  837. data/spec/models/tag_group_create_query_spec.rb +34 -0
  838. data/spec/models/tag_group_enum_spec.rb +28 -0
  839. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +40 -0
  840. data/spec/models/tag_group_update_query_resource_object_spec.rb +46 -0
  841. data/spec/models/tag_group_update_query_spec.rb +34 -0
  842. data/spec/models/tag_list_op_data_inner_spec.rb +40 -0
  843. data/spec/models/tag_list_op_spec.rb +34 -0
  844. data/spec/models/tag_segment_op_data_inner_spec.rb +40 -0
  845. data/spec/models/tag_segment_op_spec.rb +34 -0
  846. data/spec/models/tag_update_query_resource_object_spec.rb +46 -0
  847. data/spec/models/tag_update_query_spec.rb +34 -0
  848. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +40 -0
  849. data/spec/models/template_clone_query_resource_object_spec.rb +40 -0
  850. data/spec/models/template_clone_query_spec.rb +34 -0
  851. data/spec/models/template_create_query_resource_object_attributes_spec.rb +52 -0
  852. data/spec/models/template_create_query_resource_object_spec.rb +40 -0
  853. data/spec/models/template_create_query_spec.rb +34 -0
  854. data/spec/models/template_enum_spec.rb +28 -0
  855. data/spec/models/template_render_query_resource_object_attributes_spec.rb +40 -0
  856. data/spec/models/template_render_query_resource_object_spec.rb +40 -0
  857. data/spec/models/template_render_query_spec.rb +34 -0
  858. data/spec/models/template_update_query_resource_object_attributes_spec.rb +46 -0
  859. data/spec/models/template_update_query_resource_object_spec.rb +46 -0
  860. data/spec/models/template_update_query_spec.rb +34 -0
  861. data/spec/models/throttled_schedule_options_spec.rb +40 -0
  862. data/spec/models/utm_params_sub_object_spec.rb +40 -0
  863. data/spec/spec_helper.rb +111 -0
  864. metadata +598 -19
  865. data/CHANGELOG.md +0 -91
  866. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items_data_inner.rb +0 -272
@@ -0,0 +1,4103 @@
1
+ # KlaviyoAPI::CatalogsApi
2
+
3
+ All URIs are relative to *https://a.klaviyo.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_back_in_stock_subscription**](CatalogsApi.md#create_back_in_stock_subscription) | **POST** /api/back-in-stock-subscriptions/ | Create Back In Stock Subscription |
8
+ | [**create_catalog_category**](CatalogsApi.md#create_catalog_category) | **POST** /api/catalog-categories/ | Create Catalog Category |
9
+ | [**create_catalog_category_relationships_items**](CatalogsApi.md#create_catalog_category_relationships_items) | **POST** /api/catalog-categories/{id}/relationships/items/ | Create Catalog Category Relationships Items |
10
+ | [**create_catalog_item**](CatalogsApi.md#create_catalog_item) | **POST** /api/catalog-items/ | Create Catalog Item |
11
+ | [**create_catalog_item_relationships_categories**](CatalogsApi.md#create_catalog_item_relationships_categories) | **POST** /api/catalog-items/{id}/relationships/categories/ | Create Catalog Item Relationships Categories |
12
+ | [**create_catalog_variant**](CatalogsApi.md#create_catalog_variant) | **POST** /api/catalog-variants/ | Create Catalog Variant |
13
+ | [**delete_catalog_category**](CatalogsApi.md#delete_catalog_category) | **DELETE** /api/catalog-categories/{id}/ | Delete Catalog Category |
14
+ | [**delete_catalog_category_relationships_items**](CatalogsApi.md#delete_catalog_category_relationships_items) | **DELETE** /api/catalog-categories/{id}/relationships/items/ | Delete Catalog Category Relationships Items |
15
+ | [**delete_catalog_item**](CatalogsApi.md#delete_catalog_item) | **DELETE** /api/catalog-items/{id}/ | Delete Catalog Item |
16
+ | [**delete_catalog_item_relationships_categories**](CatalogsApi.md#delete_catalog_item_relationships_categories) | **DELETE** /api/catalog-items/{id}/relationships/categories/ | Delete Catalog Item Relationships Categories |
17
+ | [**delete_catalog_variant**](CatalogsApi.md#delete_catalog_variant) | **DELETE** /api/catalog-variants/{id}/ | Delete Catalog Variant |
18
+ | [**get_catalog_categories**](CatalogsApi.md#get_catalog_categories) | **GET** /api/catalog-categories/ | Get Catalog Categories |
19
+ | [**get_catalog_category**](CatalogsApi.md#get_catalog_category) | **GET** /api/catalog-categories/{id}/ | Get Catalog Category |
20
+ | [**get_catalog_category_items**](CatalogsApi.md#get_catalog_category_items) | **GET** /api/catalog-categories/{id}/items/ | Get Catalog Category Items |
21
+ | [**get_catalog_category_relationships_items**](CatalogsApi.md#get_catalog_category_relationships_items) | **GET** /api/catalog-categories/{id}/relationships/items/ | Get Catalog Category Relationships Items |
22
+ | [**get_catalog_item**](CatalogsApi.md#get_catalog_item) | **GET** /api/catalog-items/{id}/ | Get Catalog Item |
23
+ | [**get_catalog_item_categories**](CatalogsApi.md#get_catalog_item_categories) | **GET** /api/catalog-items/{id}/categories/ | Get Catalog Item Categories |
24
+ | [**get_catalog_item_relationships_categories**](CatalogsApi.md#get_catalog_item_relationships_categories) | **GET** /api/catalog-items/{id}/relationships/categories/ | Get Catalog Item Relationships Categories |
25
+ | [**get_catalog_item_variants**](CatalogsApi.md#get_catalog_item_variants) | **GET** /api/catalog-items/{id}/variants/ | Get Catalog Item Variants |
26
+ | [**get_catalog_items**](CatalogsApi.md#get_catalog_items) | **GET** /api/catalog-items/ | Get Catalog Items |
27
+ | [**get_catalog_variant**](CatalogsApi.md#get_catalog_variant) | **GET** /api/catalog-variants/{id}/ | Get Catalog Variant |
28
+ | [**get_catalog_variants**](CatalogsApi.md#get_catalog_variants) | **GET** /api/catalog-variants/ | Get Catalog Variants |
29
+ | [**get_create_categories_job**](CatalogsApi.md#get_create_categories_job) | **GET** /api/catalog-category-bulk-create-jobs/{job_id}/ | Get Create Categories Job |
30
+ | [**get_create_categories_jobs**](CatalogsApi.md#get_create_categories_jobs) | **GET** /api/catalog-category-bulk-create-jobs/ | Get Create Categories Jobs |
31
+ | [**get_create_items_job**](CatalogsApi.md#get_create_items_job) | **GET** /api/catalog-item-bulk-create-jobs/{job_id}/ | Get Create Items Job |
32
+ | [**get_create_items_jobs**](CatalogsApi.md#get_create_items_jobs) | **GET** /api/catalog-item-bulk-create-jobs/ | Get Create Items Jobs |
33
+ | [**get_create_variants_job**](CatalogsApi.md#get_create_variants_job) | **GET** /api/catalog-variant-bulk-create-jobs/{job_id}/ | Get Create Variants Job |
34
+ | [**get_create_variants_jobs**](CatalogsApi.md#get_create_variants_jobs) | **GET** /api/catalog-variant-bulk-create-jobs/ | Get Create Variants Jobs |
35
+ | [**get_delete_categories_job**](CatalogsApi.md#get_delete_categories_job) | **GET** /api/catalog-category-bulk-delete-jobs/{job_id}/ | Get Delete Categories Job |
36
+ | [**get_delete_categories_jobs**](CatalogsApi.md#get_delete_categories_jobs) | **GET** /api/catalog-category-bulk-delete-jobs/ | Get Delete Categories Jobs |
37
+ | [**get_delete_items_job**](CatalogsApi.md#get_delete_items_job) | **GET** /api/catalog-item-bulk-delete-jobs/{job_id}/ | Get Delete Items Job |
38
+ | [**get_delete_items_jobs**](CatalogsApi.md#get_delete_items_jobs) | **GET** /api/catalog-item-bulk-delete-jobs/ | Get Delete Items Jobs |
39
+ | [**get_delete_variants_job**](CatalogsApi.md#get_delete_variants_job) | **GET** /api/catalog-variant-bulk-delete-jobs/{job_id}/ | Get Delete Variants Job |
40
+ | [**get_delete_variants_jobs**](CatalogsApi.md#get_delete_variants_jobs) | **GET** /api/catalog-variant-bulk-delete-jobs/ | Get Delete Variants Jobs |
41
+ | [**get_update_categories_job**](CatalogsApi.md#get_update_categories_job) | **GET** /api/catalog-category-bulk-update-jobs/{job_id}/ | Get Update Categories Job |
42
+ | [**get_update_categories_jobs**](CatalogsApi.md#get_update_categories_jobs) | **GET** /api/catalog-category-bulk-update-jobs/ | Get Update Categories Jobs |
43
+ | [**get_update_items_job**](CatalogsApi.md#get_update_items_job) | **GET** /api/catalog-item-bulk-update-jobs/{job_id}/ | Get Update Items Job |
44
+ | [**get_update_items_jobs**](CatalogsApi.md#get_update_items_jobs) | **GET** /api/catalog-item-bulk-update-jobs/ | Get Update Items Jobs |
45
+ | [**get_update_variants_job**](CatalogsApi.md#get_update_variants_job) | **GET** /api/catalog-variant-bulk-update-jobs/{job_id}/ | Get Update Variants Job |
46
+ | [**get_update_variants_jobs**](CatalogsApi.md#get_update_variants_jobs) | **GET** /api/catalog-variant-bulk-update-jobs/ | Get Update Variants Jobs |
47
+ | [**spawn_create_categories_job**](CatalogsApi.md#spawn_create_categories_job) | **POST** /api/catalog-category-bulk-create-jobs/ | Spawn Create Categories Job |
48
+ | [**spawn_create_items_job**](CatalogsApi.md#spawn_create_items_job) | **POST** /api/catalog-item-bulk-create-jobs/ | Spawn Create Items Job |
49
+ | [**spawn_create_variants_job**](CatalogsApi.md#spawn_create_variants_job) | **POST** /api/catalog-variant-bulk-create-jobs/ | Spawn Create Variants Job |
50
+ | [**spawn_delete_categories_job**](CatalogsApi.md#spawn_delete_categories_job) | **POST** /api/catalog-category-bulk-delete-jobs/ | Spawn Delete Categories Job |
51
+ | [**spawn_delete_items_job**](CatalogsApi.md#spawn_delete_items_job) | **POST** /api/catalog-item-bulk-delete-jobs/ | Spawn Delete Items Job |
52
+ | [**spawn_delete_variants_job**](CatalogsApi.md#spawn_delete_variants_job) | **POST** /api/catalog-variant-bulk-delete-jobs/ | Spawn Delete Variants Job |
53
+ | [**spawn_update_categories_job**](CatalogsApi.md#spawn_update_categories_job) | **POST** /api/catalog-category-bulk-update-jobs/ | Spawn Update Categories Job |
54
+ | [**spawn_update_items_job**](CatalogsApi.md#spawn_update_items_job) | **POST** /api/catalog-item-bulk-update-jobs/ | Spawn Update Items Job |
55
+ | [**spawn_update_variants_job**](CatalogsApi.md#spawn_update_variants_job) | **POST** /api/catalog-variant-bulk-update-jobs/ | Spawn Update Variants Job |
56
+ | [**update_catalog_category**](CatalogsApi.md#update_catalog_category) | **PATCH** /api/catalog-categories/{id}/ | Update Catalog Category |
57
+ | [**update_catalog_category_relationships_items**](CatalogsApi.md#update_catalog_category_relationships_items) | **PATCH** /api/catalog-categories/{id}/relationships/items/ | Update Catalog Category Relationships Items |
58
+ | [**update_catalog_item**](CatalogsApi.md#update_catalog_item) | **PATCH** /api/catalog-items/{id}/ | Update Catalog Item |
59
+ | [**update_catalog_item_relationships_categories**](CatalogsApi.md#update_catalog_item_relationships_categories) | **PATCH** /api/catalog-items/{id}/relationships/categories/ | Update Catalog Item Relationships Categories |
60
+ | [**update_catalog_variant**](CatalogsApi.md#update_catalog_variant) | **PATCH** /api/catalog-variants/{id}/ | Update Catalog Variant |
61
+
62
+
63
+ ## create_back_in_stock_subscription
64
+
65
+ > create_back_in_stock_subscription(server_bis_subscription_create_query)
66
+
67
+ Create Back In Stock Subscription
68
+
69
+ Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:write` `profiles:write`
70
+
71
+ ### Examples
72
+
73
+ ```ruby
74
+ require 'time'
75
+ require 'klaviyo-api-sdk'
76
+ # setup authorization
77
+ KlaviyoAPI.configure do |config|
78
+ # Configure API key authorization: Klaviyo-API-Key
79
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
80
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
81
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
82
+ end
83
+
84
+ api_instance = KlaviyoAPI::CatalogsApi.new
85
+ server_bis_subscription_create_query = KlaviyoAPI::ServerBISSubscriptionCreateQuery.new({data: KlaviyoAPI::ServerBISSubscriptionCreateQueryResourceObject.new({type: KlaviyoAPI::BackInStockSubscriptionEnum::BACK_IN_STOCK_SUBSCRIPTION, attributes: KlaviyoAPI::ServerBISSubscriptionCreateQueryResourceObjectAttributes.new({channels: ["EMAIL", "SMS"]})})}) # ServerBISSubscriptionCreateQuery |
86
+
87
+ begin
88
+ # Create Back In Stock Subscription
89
+ api_instance.create_back_in_stock_subscription(server_bis_subscription_create_query)
90
+ rescue KlaviyoAPI::ApiError => e
91
+ puts "Error when calling CatalogsApi->create_back_in_stock_subscription: #{e}"
92
+ end
93
+ ```
94
+
95
+ #### Using the create_back_in_stock_subscription_with_http_info variant
96
+
97
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
98
+
99
+ > <Array(nil, Integer, Hash)> create_back_in_stock_subscription_with_http_info(server_bis_subscription_create_query)
100
+
101
+ ```ruby
102
+ begin
103
+ # Create Back In Stock Subscription
104
+ data, status_code, headers = api_instance.create_back_in_stock_subscription_with_http_info(server_bis_subscription_create_query)
105
+ p status_code # => 2xx
106
+ p headers # => { ... }
107
+ p data # => nil
108
+ rescue KlaviyoAPI::ApiError => e
109
+ puts "Error when calling CatalogsApi->create_back_in_stock_subscription_with_http_info: #{e}"
110
+ end
111
+ ```
112
+
113
+ ### Parameters
114
+
115
+ | Name | Type | Description | Notes |
116
+ | ---- | ---- | ----------- | ----- |
117
+ | **server_bis_subscription_create_query** | [**ServerBISSubscriptionCreateQuery**](ServerBISSubscriptionCreateQuery.md) | | |
118
+
119
+ ### Return type
120
+
121
+ nil (empty response body)
122
+
123
+ ### Authorization
124
+
125
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
126
+
127
+ ### HTTP request headers
128
+
129
+ - **Content-Type**: application/json
130
+ - **Accept**: application/json
131
+
132
+
133
+ ## create_catalog_category
134
+
135
+ > Hash&lt;String, Object&gt; create_catalog_category(catalog_category_create_query)
136
+
137
+ Create Catalog Category
138
+
139
+ Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
140
+
141
+ ### Examples
142
+
143
+ ```ruby
144
+ require 'time'
145
+ require 'klaviyo-api-sdk'
146
+ # setup authorization
147
+ KlaviyoAPI.configure do |config|
148
+ # Configure API key authorization: Klaviyo-API-Key
149
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
150
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
151
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
152
+ end
153
+
154
+ api_instance = KlaviyoAPI::CatalogsApi.new
155
+ 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 |
156
+
157
+ begin
158
+ # Create Catalog Category
159
+ result = api_instance.create_catalog_category(catalog_category_create_query)
160
+ p result
161
+ rescue KlaviyoAPI::ApiError => e
162
+ puts "Error when calling CatalogsApi->create_catalog_category: #{e}"
163
+ end
164
+ ```
165
+
166
+ #### Using the create_catalog_category_with_http_info variant
167
+
168
+ This returns an Array which contains the response data, status code and headers.
169
+
170
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_catalog_category_with_http_info(catalog_category_create_query)
171
+
172
+ ```ruby
173
+ begin
174
+ # Create Catalog Category
175
+ data, status_code, headers = api_instance.create_catalog_category_with_http_info(catalog_category_create_query)
176
+ p status_code # => 2xx
177
+ p headers # => { ... }
178
+ p data # => Hash&lt;String, Object&gt;
179
+ rescue KlaviyoAPI::ApiError => e
180
+ puts "Error when calling CatalogsApi->create_catalog_category_with_http_info: #{e}"
181
+ end
182
+ ```
183
+
184
+ ### Parameters
185
+
186
+ | Name | Type | Description | Notes |
187
+ | ---- | ---- | ----------- | ----- |
188
+ | **catalog_category_create_query** | [**CatalogCategoryCreateQuery**](CatalogCategoryCreateQuery.md) | | |
189
+
190
+ ### Return type
191
+
192
+ **Hash&lt;String, Object&gt;**
193
+
194
+ ### Authorization
195
+
196
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
197
+
198
+ ### HTTP request headers
199
+
200
+ - **Content-Type**: application/json
201
+ - **Accept**: application/json
202
+
203
+
204
+ ## create_catalog_category_relationships_items
205
+
206
+ > create_catalog_category_relationships_items(id, catalog_category_item_op)
207
+
208
+ Create Catalog Category Relationships Items
209
+
210
+ 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`
211
+
212
+ ### Examples
213
+
214
+ ```ruby
215
+ require 'time'
216
+ require 'klaviyo-api-sdk'
217
+ # setup authorization
218
+ KlaviyoAPI.configure do |config|
219
+ # Configure API key authorization: Klaviyo-API-Key
220
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
221
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
222
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
223
+ end
224
+
225
+ api_instance = KlaviyoAPI::CatalogsApi.new
226
+ id = 'id_example' # String |
227
+ catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemData.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1'})]}) # CatalogCategoryItemOp |
228
+
229
+ begin
230
+ # Create Catalog Category Relationships Items
231
+ api_instance.create_catalog_category_relationships_items(id, catalog_category_item_op)
232
+ rescue KlaviyoAPI::ApiError => e
233
+ puts "Error when calling CatalogsApi->create_catalog_category_relationships_items: #{e}"
234
+ end
235
+ ```
236
+
237
+ #### Using the create_catalog_category_relationships_items_with_http_info variant
238
+
239
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
240
+
241
+ > <Array(nil, Integer, Hash)> create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
242
+
243
+ ```ruby
244
+ begin
245
+ # Create Catalog Category Relationships Items
246
+ data, status_code, headers = api_instance.create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
247
+ p status_code # => 2xx
248
+ p headers # => { ... }
249
+ p data # => nil
250
+ rescue KlaviyoAPI::ApiError => e
251
+ puts "Error when calling CatalogsApi->create_catalog_category_relationships_items_with_http_info: #{e}"
252
+ end
253
+ ```
254
+
255
+ ### Parameters
256
+
257
+ | Name | Type | Description | Notes |
258
+ | ---- | ---- | ----------- | ----- |
259
+ | **id** | **String** | | |
260
+ | **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
261
+
262
+ ### Return type
263
+
264
+ nil (empty response body)
265
+
266
+ ### Authorization
267
+
268
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
269
+
270
+ ### HTTP request headers
271
+
272
+ - **Content-Type**: application/json
273
+ - **Accept**: application/json
274
+
275
+
276
+ ## create_catalog_item
277
+
278
+ > Hash&lt;String, Object&gt; create_catalog_item(catalog_item_create_query)
279
+
280
+ Create Catalog Item
281
+
282
+ Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
283
+
284
+ ### Examples
285
+
286
+ ```ruby
287
+ require 'time'
288
+ require 'klaviyo-api-sdk'
289
+ # setup authorization
290
+ KlaviyoAPI.configure do |config|
291
+ # Configure API key authorization: Klaviyo-API-Key
292
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
293
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
294
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
295
+ end
296
+
297
+ api_instance = KlaviyoAPI::CatalogsApi.new
298
+ 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 |
299
+
300
+ begin
301
+ # Create Catalog Item
302
+ result = api_instance.create_catalog_item(catalog_item_create_query)
303
+ p result
304
+ rescue KlaviyoAPI::ApiError => e
305
+ puts "Error when calling CatalogsApi->create_catalog_item: #{e}"
306
+ end
307
+ ```
308
+
309
+ #### Using the create_catalog_item_with_http_info variant
310
+
311
+ This returns an Array which contains the response data, status code and headers.
312
+
313
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_catalog_item_with_http_info(catalog_item_create_query)
314
+
315
+ ```ruby
316
+ begin
317
+ # Create Catalog Item
318
+ data, status_code, headers = api_instance.create_catalog_item_with_http_info(catalog_item_create_query)
319
+ p status_code # => 2xx
320
+ p headers # => { ... }
321
+ p data # => Hash&lt;String, Object&gt;
322
+ rescue KlaviyoAPI::ApiError => e
323
+ puts "Error when calling CatalogsApi->create_catalog_item_with_http_info: #{e}"
324
+ end
325
+ ```
326
+
327
+ ### Parameters
328
+
329
+ | Name | Type | Description | Notes |
330
+ | ---- | ---- | ----------- | ----- |
331
+ | **catalog_item_create_query** | [**CatalogItemCreateQuery**](CatalogItemCreateQuery.md) | | |
332
+
333
+ ### Return type
334
+
335
+ **Hash&lt;String, Object&gt;**
336
+
337
+ ### Authorization
338
+
339
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
340
+
341
+ ### HTTP request headers
342
+
343
+ - **Content-Type**: application/json
344
+ - **Accept**: application/json
345
+
346
+
347
+ ## create_catalog_item_relationships_categories
348
+
349
+ > create_catalog_item_relationships_categories(id, catalog_item_category_op)
350
+
351
+ Create Catalog Item Relationships Categories
352
+
353
+ 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`
354
+
355
+ ### Examples
356
+
357
+ ```ruby
358
+ require 'time'
359
+ require 'klaviyo-api-sdk'
360
+ # setup authorization
361
+ KlaviyoAPI.configure do |config|
362
+ # Configure API key authorization: Klaviyo-API-Key
363
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
364
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
365
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
366
+ end
367
+
368
+ api_instance = KlaviyoAPI::CatalogsApi.new
369
+ id = 'id_example' # String |
370
+ catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'})]}) # CatalogItemCategoryOp |
371
+
372
+ begin
373
+ # Create Catalog Item Relationships Categories
374
+ api_instance.create_catalog_item_relationships_categories(id, catalog_item_category_op)
375
+ rescue KlaviyoAPI::ApiError => e
376
+ puts "Error when calling CatalogsApi->create_catalog_item_relationships_categories: #{e}"
377
+ end
378
+ ```
379
+
380
+ #### Using the create_catalog_item_relationships_categories_with_http_info variant
381
+
382
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
383
+
384
+ > <Array(nil, Integer, Hash)> create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
385
+
386
+ ```ruby
387
+ begin
388
+ # Create Catalog Item Relationships Categories
389
+ data, status_code, headers = api_instance.create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
390
+ p status_code # => 2xx
391
+ p headers # => { ... }
392
+ p data # => nil
393
+ rescue KlaviyoAPI::ApiError => e
394
+ puts "Error when calling CatalogsApi->create_catalog_item_relationships_categories_with_http_info: #{e}"
395
+ end
396
+ ```
397
+
398
+ ### Parameters
399
+
400
+ | Name | Type | Description | Notes |
401
+ | ---- | ---- | ----------- | ----- |
402
+ | **id** | **String** | | |
403
+ | **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
404
+
405
+ ### Return type
406
+
407
+ nil (empty response body)
408
+
409
+ ### Authorization
410
+
411
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
412
+
413
+ ### HTTP request headers
414
+
415
+ - **Content-Type**: application/json
416
+ - **Accept**: application/json
417
+
418
+
419
+ ## create_catalog_variant
420
+
421
+ > Hash&lt;String, Object&gt; create_catalog_variant(catalog_variant_create_query)
422
+
423
+ Create Catalog Variant
424
+
425
+ Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
426
+
427
+ ### Examples
428
+
429
+ ```ruby
430
+ require 'time'
431
+ require 'klaviyo-api-sdk'
432
+ # setup authorization
433
+ KlaviyoAPI.configure do |config|
434
+ # Configure API key authorization: Klaviyo-API-Key
435
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
436
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
437
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
438
+ end
439
+
440
+ api_instance = KlaviyoAPI::CatalogsApi.new
441
+ 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 |
442
+
443
+ begin
444
+ # Create Catalog Variant
445
+ result = api_instance.create_catalog_variant(catalog_variant_create_query)
446
+ p result
447
+ rescue KlaviyoAPI::ApiError => e
448
+ puts "Error when calling CatalogsApi->create_catalog_variant: #{e}"
449
+ end
450
+ ```
451
+
452
+ #### Using the create_catalog_variant_with_http_info variant
453
+
454
+ This returns an Array which contains the response data, status code and headers.
455
+
456
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_catalog_variant_with_http_info(catalog_variant_create_query)
457
+
458
+ ```ruby
459
+ begin
460
+ # Create Catalog Variant
461
+ data, status_code, headers = api_instance.create_catalog_variant_with_http_info(catalog_variant_create_query)
462
+ p status_code # => 2xx
463
+ p headers # => { ... }
464
+ p data # => Hash&lt;String, Object&gt;
465
+ rescue KlaviyoAPI::ApiError => e
466
+ puts "Error when calling CatalogsApi->create_catalog_variant_with_http_info: #{e}"
467
+ end
468
+ ```
469
+
470
+ ### Parameters
471
+
472
+ | Name | Type | Description | Notes |
473
+ | ---- | ---- | ----------- | ----- |
474
+ | **catalog_variant_create_query** | [**CatalogVariantCreateQuery**](CatalogVariantCreateQuery.md) | | |
475
+
476
+ ### Return type
477
+
478
+ **Hash&lt;String, Object&gt;**
479
+
480
+ ### Authorization
481
+
482
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
483
+
484
+ ### HTTP request headers
485
+
486
+ - **Content-Type**: application/json
487
+ - **Accept**: application/json
488
+
489
+
490
+ ## delete_catalog_category
491
+
492
+ > delete_catalog_category(id)
493
+
494
+ Delete Catalog Category
495
+
496
+ Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
497
+
498
+ ### Examples
499
+
500
+ ```ruby
501
+ require 'time'
502
+ require 'klaviyo-api-sdk'
503
+ # setup authorization
504
+ KlaviyoAPI.configure do |config|
505
+ # Configure API key authorization: Klaviyo-API-Key
506
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
507
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
508
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
509
+ end
510
+
511
+ api_instance = KlaviyoAPI::CatalogsApi.new
512
+ 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`.
513
+
514
+ begin
515
+ # Delete Catalog Category
516
+ api_instance.delete_catalog_category(id)
517
+ rescue KlaviyoAPI::ApiError => e
518
+ puts "Error when calling CatalogsApi->delete_catalog_category: #{e}"
519
+ end
520
+ ```
521
+
522
+ #### Using the delete_catalog_category_with_http_info variant
523
+
524
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
525
+
526
+ > <Array(nil, Integer, Hash)> delete_catalog_category_with_http_info(id)
527
+
528
+ ```ruby
529
+ begin
530
+ # Delete Catalog Category
531
+ data, status_code, headers = api_instance.delete_catalog_category_with_http_info(id)
532
+ p status_code # => 2xx
533
+ p headers # => { ... }
534
+ p data # => nil
535
+ rescue KlaviyoAPI::ApiError => e
536
+ puts "Error when calling CatalogsApi->delete_catalog_category_with_http_info: #{e}"
537
+ end
538
+ ```
539
+
540
+ ### Parameters
541
+
542
+ | Name | Type | Description | Notes |
543
+ | ---- | ---- | ----------- | ----- |
544
+ | **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;. | |
545
+
546
+ ### Return type
547
+
548
+ nil (empty response body)
549
+
550
+ ### Authorization
551
+
552
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
553
+
554
+ ### HTTP request headers
555
+
556
+ - **Content-Type**: Not defined
557
+ - **Accept**: application/json
558
+
559
+
560
+ ## delete_catalog_category_relationships_items
561
+
562
+ > delete_catalog_category_relationships_items(id, catalog_category_item_op)
563
+
564
+ Delete Catalog Category Relationships Items
565
+
566
+ Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
567
+
568
+ ### Examples
569
+
570
+ ```ruby
571
+ require 'time'
572
+ require 'klaviyo-api-sdk'
573
+ # setup authorization
574
+ KlaviyoAPI.configure do |config|
575
+ # Configure API key authorization: Klaviyo-API-Key
576
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
577
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
578
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
579
+ end
580
+
581
+ api_instance = KlaviyoAPI::CatalogsApi.new
582
+ id = 'id_example' # String |
583
+ catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemData.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1'})]}) # CatalogCategoryItemOp |
584
+
585
+ begin
586
+ # Delete Catalog Category Relationships Items
587
+ api_instance.delete_catalog_category_relationships_items(id, catalog_category_item_op)
588
+ rescue KlaviyoAPI::ApiError => e
589
+ puts "Error when calling CatalogsApi->delete_catalog_category_relationships_items: #{e}"
590
+ end
591
+ ```
592
+
593
+ #### Using the delete_catalog_category_relationships_items_with_http_info variant
594
+
595
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
596
+
597
+ > <Array(nil, Integer, Hash)> delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
598
+
599
+ ```ruby
600
+ begin
601
+ # Delete Catalog Category Relationships Items
602
+ data, status_code, headers = api_instance.delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
603
+ p status_code # => 2xx
604
+ p headers # => { ... }
605
+ p data # => nil
606
+ rescue KlaviyoAPI::ApiError => e
607
+ puts "Error when calling CatalogsApi->delete_catalog_category_relationships_items_with_http_info: #{e}"
608
+ end
609
+ ```
610
+
611
+ ### Parameters
612
+
613
+ | Name | Type | Description | Notes |
614
+ | ---- | ---- | ----------- | ----- |
615
+ | **id** | **String** | | |
616
+ | **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
617
+
618
+ ### Return type
619
+
620
+ nil (empty response body)
621
+
622
+ ### Authorization
623
+
624
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
625
+
626
+ ### HTTP request headers
627
+
628
+ - **Content-Type**: application/json
629
+ - **Accept**: application/json
630
+
631
+
632
+ ## delete_catalog_item
633
+
634
+ > delete_catalog_item(id)
635
+
636
+ Delete Catalog Item
637
+
638
+ Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
639
+
640
+ ### Examples
641
+
642
+ ```ruby
643
+ require 'time'
644
+ require 'klaviyo-api-sdk'
645
+ # setup authorization
646
+ KlaviyoAPI.configure do |config|
647
+ # Configure API key authorization: Klaviyo-API-Key
648
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
649
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
650
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
651
+ end
652
+
653
+ api_instance = KlaviyoAPI::CatalogsApi.new
654
+ 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`.
655
+
656
+ begin
657
+ # Delete Catalog Item
658
+ api_instance.delete_catalog_item(id)
659
+ rescue KlaviyoAPI::ApiError => e
660
+ puts "Error when calling CatalogsApi->delete_catalog_item: #{e}"
661
+ end
662
+ ```
663
+
664
+ #### Using the delete_catalog_item_with_http_info variant
665
+
666
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
667
+
668
+ > <Array(nil, Integer, Hash)> delete_catalog_item_with_http_info(id)
669
+
670
+ ```ruby
671
+ begin
672
+ # Delete Catalog Item
673
+ data, status_code, headers = api_instance.delete_catalog_item_with_http_info(id)
674
+ p status_code # => 2xx
675
+ p headers # => { ... }
676
+ p data # => nil
677
+ rescue KlaviyoAPI::ApiError => e
678
+ puts "Error when calling CatalogsApi->delete_catalog_item_with_http_info: #{e}"
679
+ end
680
+ ```
681
+
682
+ ### Parameters
683
+
684
+ | Name | Type | Description | Notes |
685
+ | ---- | ---- | ----------- | ----- |
686
+ | **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;. | |
687
+
688
+ ### Return type
689
+
690
+ nil (empty response body)
691
+
692
+ ### Authorization
693
+
694
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
695
+
696
+ ### HTTP request headers
697
+
698
+ - **Content-Type**: Not defined
699
+ - **Accept**: application/json
700
+
701
+
702
+ ## delete_catalog_item_relationships_categories
703
+
704
+ > delete_catalog_item_relationships_categories(id, catalog_item_category_op)
705
+
706
+ Delete Catalog Item Relationships Categories
707
+
708
+ Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
709
+
710
+ ### Examples
711
+
712
+ ```ruby
713
+ require 'time'
714
+ require 'klaviyo-api-sdk'
715
+ # setup authorization
716
+ KlaviyoAPI.configure do |config|
717
+ # Configure API key authorization: Klaviyo-API-Key
718
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
719
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
720
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
721
+ end
722
+
723
+ api_instance = KlaviyoAPI::CatalogsApi.new
724
+ id = 'id_example' # String |
725
+ catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'})]}) # CatalogItemCategoryOp |
726
+
727
+ begin
728
+ # Delete Catalog Item Relationships Categories
729
+ api_instance.delete_catalog_item_relationships_categories(id, catalog_item_category_op)
730
+ rescue KlaviyoAPI::ApiError => e
731
+ puts "Error when calling CatalogsApi->delete_catalog_item_relationships_categories: #{e}"
732
+ end
733
+ ```
734
+
735
+ #### Using the delete_catalog_item_relationships_categories_with_http_info variant
736
+
737
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
738
+
739
+ > <Array(nil, Integer, Hash)> delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
740
+
741
+ ```ruby
742
+ begin
743
+ # Delete Catalog Item Relationships Categories
744
+ data, status_code, headers = api_instance.delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
745
+ p status_code # => 2xx
746
+ p headers # => { ... }
747
+ p data # => nil
748
+ rescue KlaviyoAPI::ApiError => e
749
+ puts "Error when calling CatalogsApi->delete_catalog_item_relationships_categories_with_http_info: #{e}"
750
+ end
751
+ ```
752
+
753
+ ### Parameters
754
+
755
+ | Name | Type | Description | Notes |
756
+ | ---- | ---- | ----------- | ----- |
757
+ | **id** | **String** | | |
758
+ | **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
759
+
760
+ ### Return type
761
+
762
+ nil (empty response body)
763
+
764
+ ### Authorization
765
+
766
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
767
+
768
+ ### HTTP request headers
769
+
770
+ - **Content-Type**: application/json
771
+ - **Accept**: application/json
772
+
773
+
774
+ ## delete_catalog_variant
775
+
776
+ > delete_catalog_variant(id)
777
+
778
+ Delete Catalog Variant
779
+
780
+ Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
781
+
782
+ ### Examples
783
+
784
+ ```ruby
785
+ require 'time'
786
+ require 'klaviyo-api-sdk'
787
+ # setup authorization
788
+ KlaviyoAPI.configure do |config|
789
+ # Configure API key authorization: Klaviyo-API-Key
790
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
791
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
792
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
793
+ end
794
+
795
+ api_instance = KlaviyoAPI::CatalogsApi.new
796
+ 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`.
797
+
798
+ begin
799
+ # Delete Catalog Variant
800
+ api_instance.delete_catalog_variant(id)
801
+ rescue KlaviyoAPI::ApiError => e
802
+ puts "Error when calling CatalogsApi->delete_catalog_variant: #{e}"
803
+ end
804
+ ```
805
+
806
+ #### Using the delete_catalog_variant_with_http_info variant
807
+
808
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
809
+
810
+ > <Array(nil, Integer, Hash)> delete_catalog_variant_with_http_info(id)
811
+
812
+ ```ruby
813
+ begin
814
+ # Delete Catalog Variant
815
+ data, status_code, headers = api_instance.delete_catalog_variant_with_http_info(id)
816
+ p status_code # => 2xx
817
+ p headers # => { ... }
818
+ p data # => nil
819
+ rescue KlaviyoAPI::ApiError => e
820
+ puts "Error when calling CatalogsApi->delete_catalog_variant_with_http_info: #{e}"
821
+ end
822
+ ```
823
+
824
+ ### Parameters
825
+
826
+ | Name | Type | Description | Notes |
827
+ | ---- | ---- | ----------- | ----- |
828
+ | **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;. | |
829
+
830
+ ### Return type
831
+
832
+ nil (empty response body)
833
+
834
+ ### Authorization
835
+
836
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
837
+
838
+ ### HTTP request headers
839
+
840
+ - **Content-Type**: Not defined
841
+ - **Accept**: application/json
842
+
843
+
844
+ ## get_catalog_categories
845
+
846
+ > Hash&lt;String, Object&gt; get_catalog_categories(opts)
847
+
848
+ Get Catalog Categories
849
+
850
+ Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
851
+
852
+ ### Examples
853
+
854
+ ```ruby
855
+ require 'time'
856
+ require 'klaviyo-api-sdk'
857
+ # setup authorization
858
+ KlaviyoAPI.configure do |config|
859
+ # Configure API key authorization: Klaviyo-API-Key
860
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
861
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
862
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
863
+ end
864
+
865
+ api_instance = KlaviyoAPI::CatalogsApi.new
866
+ opts = {
867
+ fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
868
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
869
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
870
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
871
+ }
872
+
873
+ begin
874
+ # Get Catalog Categories
875
+ result = api_instance.get_catalog_categories(opts)
876
+ p result
877
+ rescue KlaviyoAPI::ApiError => e
878
+ puts "Error when calling CatalogsApi->get_catalog_categories: #{e}"
879
+ end
880
+ ```
881
+
882
+ #### Using the get_catalog_categories_with_http_info variant
883
+
884
+ This returns an Array which contains the response data, status code and headers.
885
+
886
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_categories_with_http_info(opts)
887
+
888
+ ```ruby
889
+ begin
890
+ # Get Catalog Categories
891
+ data, status_code, headers = api_instance.get_catalog_categories_with_http_info(opts)
892
+ p status_code # => 2xx
893
+ p headers # => { ... }
894
+ p data # => Hash&lt;String, Object&gt;
895
+ rescue KlaviyoAPI::ApiError => e
896
+ puts "Error when calling CatalogsApi->get_catalog_categories_with_http_info: #{e}"
897
+ end
898
+ ```
899
+
900
+ ### Parameters
901
+
902
+ | Name | Type | Description | Notes |
903
+ | ---- | ---- | ----------- | ----- |
904
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
905
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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.id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60; | [optional] |
906
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
907
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting | [optional] |
908
+
909
+ ### Return type
910
+
911
+ **Hash&lt;String, Object&gt;**
912
+
913
+ ### Authorization
914
+
915
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
916
+
917
+ ### HTTP request headers
918
+
919
+ - **Content-Type**: Not defined
920
+ - **Accept**: application/json
921
+
922
+
923
+ ## get_catalog_category
924
+
925
+ > Hash&lt;String, Object&gt; get_catalog_category(id, opts)
926
+
927
+ Get Catalog Category
928
+
929
+ Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
930
+
931
+ ### Examples
932
+
933
+ ```ruby
934
+ require 'time'
935
+ require 'klaviyo-api-sdk'
936
+ # setup authorization
937
+ KlaviyoAPI.configure do |config|
938
+ # Configure API key authorization: Klaviyo-API-Key
939
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
940
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
941
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
942
+ end
943
+
944
+ api_instance = KlaviyoAPI::CatalogsApi.new
945
+ 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`.
946
+ opts = {
947
+ fields_catalog_category: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
948
+ }
949
+
950
+ begin
951
+ # Get Catalog Category
952
+ result = api_instance.get_catalog_category(id, opts)
953
+ p result
954
+ rescue KlaviyoAPI::ApiError => e
955
+ puts "Error when calling CatalogsApi->get_catalog_category: #{e}"
956
+ end
957
+ ```
958
+
959
+ #### Using the get_catalog_category_with_http_info variant
960
+
961
+ This returns an Array which contains the response data, status code and headers.
962
+
963
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_category_with_http_info(id, opts)
964
+
965
+ ```ruby
966
+ begin
967
+ # Get Catalog Category
968
+ data, status_code, headers = api_instance.get_catalog_category_with_http_info(id, opts)
969
+ p status_code # => 2xx
970
+ p headers # => { ... }
971
+ p data # => Hash&lt;String, Object&gt;
972
+ rescue KlaviyoAPI::ApiError => e
973
+ puts "Error when calling CatalogsApi->get_catalog_category_with_http_info: #{e}"
974
+ end
975
+ ```
976
+
977
+ ### Parameters
978
+
979
+ | Name | Type | Description | Notes |
980
+ | ---- | ---- | ----------- | ----- |
981
+ | **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;. | |
982
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
983
+
984
+ ### Return type
985
+
986
+ **Hash&lt;String, Object&gt;**
987
+
988
+ ### Authorization
989
+
990
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
991
+
992
+ ### HTTP request headers
993
+
994
+ - **Content-Type**: Not defined
995
+ - **Accept**: application/json
996
+
997
+
998
+ ## get_catalog_category_items
999
+
1000
+ > Hash&lt;String, Object&gt; get_catalog_category_items(id, opts)
1001
+
1002
+ Get Catalog Category Items
1003
+
1004
+ Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1005
+
1006
+ ### Examples
1007
+
1008
+ ```ruby
1009
+ require 'time'
1010
+ require 'klaviyo-api-sdk'
1011
+ # setup authorization
1012
+ KlaviyoAPI.configure do |config|
1013
+ # Configure API key authorization: Klaviyo-API-Key
1014
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1015
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1016
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1017
+ end
1018
+
1019
+ api_instance = KlaviyoAPI::CatalogsApi.new
1020
+ id = 'id_example' # String |
1021
+ opts = {
1022
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1023
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1024
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1025
+ include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
1026
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1027
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
1028
+ }
1029
+
1030
+ begin
1031
+ # Get Catalog Category Items
1032
+ result = api_instance.get_catalog_category_items(id, opts)
1033
+ p result
1034
+ rescue KlaviyoAPI::ApiError => e
1035
+ puts "Error when calling CatalogsApi->get_catalog_category_items: #{e}"
1036
+ end
1037
+ ```
1038
+
1039
+ #### Using the get_catalog_category_items_with_http_info variant
1040
+
1041
+ This returns an Array which contains the response data, status code and headers.
1042
+
1043
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_category_items_with_http_info(id, opts)
1044
+
1045
+ ```ruby
1046
+ begin
1047
+ # Get Catalog Category Items
1048
+ data, status_code, headers = api_instance.get_catalog_category_items_with_http_info(id, opts)
1049
+ p status_code # => 2xx
1050
+ p headers # => { ... }
1051
+ p data # => Hash&lt;String, Object&gt;
1052
+ rescue KlaviyoAPI::ApiError => e
1053
+ puts "Error when calling CatalogsApi->get_catalog_category_items_with_http_info: #{e}"
1054
+ end
1055
+ ```
1056
+
1057
+ ### Parameters
1058
+
1059
+ | Name | Type | Description | Notes |
1060
+ | ---- | ---- | ----------- | ----- |
1061
+ | **id** | **String** | | |
1062
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1063
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1064
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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.id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60; | [optional] |
1065
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
1066
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
1067
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting | [optional] |
1068
+
1069
+ ### Return type
1070
+
1071
+ **Hash&lt;String, Object&gt;**
1072
+
1073
+ ### Authorization
1074
+
1075
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1076
+
1077
+ ### HTTP request headers
1078
+
1079
+ - **Content-Type**: Not defined
1080
+ - **Accept**: application/json
1081
+
1082
+
1083
+ ## get_catalog_category_relationships_items
1084
+
1085
+ > Hash&lt;String, Object&gt; get_catalog_category_relationships_items(id, opts)
1086
+
1087
+ Get Catalog Category Relationships Items
1088
+
1089
+ 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`
1090
+
1091
+ ### Examples
1092
+
1093
+ ```ruby
1094
+ require 'time'
1095
+ require 'klaviyo-api-sdk'
1096
+ # setup authorization
1097
+ KlaviyoAPI.configure do |config|
1098
+ # Configure API key authorization: Klaviyo-API-Key
1099
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1101
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1102
+ end
1103
+
1104
+ api_instance = KlaviyoAPI::CatalogsApi.new
1105
+ id = 'id_example' # String |
1106
+ opts = {
1107
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1108
+ }
1109
+
1110
+ begin
1111
+ # Get Catalog Category Relationships Items
1112
+ result = api_instance.get_catalog_category_relationships_items(id, opts)
1113
+ p result
1114
+ rescue KlaviyoAPI::ApiError => e
1115
+ puts "Error when calling CatalogsApi->get_catalog_category_relationships_items: #{e}"
1116
+ end
1117
+ ```
1118
+
1119
+ #### Using the get_catalog_category_relationships_items_with_http_info variant
1120
+
1121
+ This returns an Array which contains the response data, status code and headers.
1122
+
1123
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_category_relationships_items_with_http_info(id, opts)
1124
+
1125
+ ```ruby
1126
+ begin
1127
+ # Get Catalog Category Relationships Items
1128
+ data, status_code, headers = api_instance.get_catalog_category_relationships_items_with_http_info(id, opts)
1129
+ p status_code # => 2xx
1130
+ p headers # => { ... }
1131
+ p data # => Hash&lt;String, Object&gt;
1132
+ rescue KlaviyoAPI::ApiError => e
1133
+ puts "Error when calling CatalogsApi->get_catalog_category_relationships_items_with_http_info: #{e}"
1134
+ end
1135
+ ```
1136
+
1137
+ ### Parameters
1138
+
1139
+ | Name | Type | Description | Notes |
1140
+ | ---- | ---- | ----------- | ----- |
1141
+ | **id** | **String** | | |
1142
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
1143
+
1144
+ ### Return type
1145
+
1146
+ **Hash&lt;String, Object&gt;**
1147
+
1148
+ ### Authorization
1149
+
1150
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1151
+
1152
+ ### HTTP request headers
1153
+
1154
+ - **Content-Type**: Not defined
1155
+ - **Accept**: application/json
1156
+
1157
+
1158
+ ## get_catalog_item
1159
+
1160
+ > Hash&lt;String, Object&gt; get_catalog_item(id, opts)
1161
+
1162
+ Get Catalog Item
1163
+
1164
+ Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1165
+
1166
+ ### Examples
1167
+
1168
+ ```ruby
1169
+ require 'time'
1170
+ require 'klaviyo-api-sdk'
1171
+ # setup authorization
1172
+ KlaviyoAPI.configure do |config|
1173
+ # Configure API key authorization: Klaviyo-API-Key
1174
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1175
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1176
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1177
+ end
1178
+
1179
+ api_instance = KlaviyoAPI::CatalogsApi.new
1180
+ 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`.
1181
+ opts = {
1182
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1183
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1184
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
1185
+ }
1186
+
1187
+ begin
1188
+ # Get Catalog Item
1189
+ result = api_instance.get_catalog_item(id, opts)
1190
+ p result
1191
+ rescue KlaviyoAPI::ApiError => e
1192
+ puts "Error when calling CatalogsApi->get_catalog_item: #{e}"
1193
+ end
1194
+ ```
1195
+
1196
+ #### Using the get_catalog_item_with_http_info variant
1197
+
1198
+ This returns an Array which contains the response data, status code and headers.
1199
+
1200
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_item_with_http_info(id, opts)
1201
+
1202
+ ```ruby
1203
+ begin
1204
+ # Get Catalog Item
1205
+ data, status_code, headers = api_instance.get_catalog_item_with_http_info(id, opts)
1206
+ p status_code # => 2xx
1207
+ p headers # => { ... }
1208
+ p data # => Hash&lt;String, Object&gt;
1209
+ rescue KlaviyoAPI::ApiError => e
1210
+ puts "Error when calling CatalogsApi->get_catalog_item_with_http_info: #{e}"
1211
+ end
1212
+ ```
1213
+
1214
+ ### Parameters
1215
+
1216
+ | Name | Type | Description | Notes |
1217
+ | ---- | ---- | ----------- | ----- |
1218
+ | **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;. | |
1219
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1220
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1221
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
1222
+
1223
+ ### Return type
1224
+
1225
+ **Hash&lt;String, Object&gt;**
1226
+
1227
+ ### Authorization
1228
+
1229
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1230
+
1231
+ ### HTTP request headers
1232
+
1233
+ - **Content-Type**: Not defined
1234
+ - **Accept**: application/json
1235
+
1236
+
1237
+ ## get_catalog_item_categories
1238
+
1239
+ > Hash&lt;String, Object&gt; get_catalog_item_categories(id, opts)
1240
+
1241
+ Get Catalog Item Categories
1242
+
1243
+ Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1244
+
1245
+ ### Examples
1246
+
1247
+ ```ruby
1248
+ require 'time'
1249
+ require 'klaviyo-api-sdk'
1250
+ # setup authorization
1251
+ KlaviyoAPI.configure do |config|
1252
+ # Configure API key authorization: Klaviyo-API-Key
1253
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1254
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1255
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1256
+ end
1257
+
1258
+ api_instance = KlaviyoAPI::CatalogsApi.new
1259
+ id = 'id_example' # String |
1260
+ opts = {
1261
+ fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1262
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
1263
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1264
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
1265
+ }
1266
+
1267
+ begin
1268
+ # Get Catalog Item Categories
1269
+ result = api_instance.get_catalog_item_categories(id, opts)
1270
+ p result
1271
+ rescue KlaviyoAPI::ApiError => e
1272
+ puts "Error when calling CatalogsApi->get_catalog_item_categories: #{e}"
1273
+ end
1274
+ ```
1275
+
1276
+ #### Using the get_catalog_item_categories_with_http_info variant
1277
+
1278
+ This returns an Array which contains the response data, status code and headers.
1279
+
1280
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_item_categories_with_http_info(id, opts)
1281
+
1282
+ ```ruby
1283
+ begin
1284
+ # Get Catalog Item Categories
1285
+ data, status_code, headers = api_instance.get_catalog_item_categories_with_http_info(id, opts)
1286
+ p status_code # => 2xx
1287
+ p headers # => { ... }
1288
+ p data # => Hash&lt;String, Object&gt;
1289
+ rescue KlaviyoAPI::ApiError => e
1290
+ puts "Error when calling CatalogsApi->get_catalog_item_categories_with_http_info: #{e}"
1291
+ end
1292
+ ```
1293
+
1294
+ ### Parameters
1295
+
1296
+ | Name | Type | Description | Notes |
1297
+ | ---- | ---- | ----------- | ----- |
1298
+ | **id** | **String** | | |
1299
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1300
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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.id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60; | [optional] |
1301
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
1302
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting | [optional] |
1303
+
1304
+ ### Return type
1305
+
1306
+ **Hash&lt;String, Object&gt;**
1307
+
1308
+ ### Authorization
1309
+
1310
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1311
+
1312
+ ### HTTP request headers
1313
+
1314
+ - **Content-Type**: Not defined
1315
+ - **Accept**: application/json
1316
+
1317
+
1318
+ ## get_catalog_item_relationships_categories
1319
+
1320
+ > Hash&lt;String, Object&gt; get_catalog_item_relationships_categories(id, opts)
1321
+
1322
+ Get Catalog Item Relationships Categories
1323
+
1324
+ 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`
1325
+
1326
+ ### Examples
1327
+
1328
+ ```ruby
1329
+ require 'time'
1330
+ require 'klaviyo-api-sdk'
1331
+ # setup authorization
1332
+ KlaviyoAPI.configure do |config|
1333
+ # Configure API key authorization: Klaviyo-API-Key
1334
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1335
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1336
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1337
+ end
1338
+
1339
+ api_instance = KlaviyoAPI::CatalogsApi.new
1340
+ id = 'id_example' # String |
1341
+ opts = {
1342
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1343
+ }
1344
+
1345
+ begin
1346
+ # Get Catalog Item Relationships Categories
1347
+ result = api_instance.get_catalog_item_relationships_categories(id, opts)
1348
+ p result
1349
+ rescue KlaviyoAPI::ApiError => e
1350
+ puts "Error when calling CatalogsApi->get_catalog_item_relationships_categories: #{e}"
1351
+ end
1352
+ ```
1353
+
1354
+ #### Using the get_catalog_item_relationships_categories_with_http_info variant
1355
+
1356
+ This returns an Array which contains the response data, status code and headers.
1357
+
1358
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_item_relationships_categories_with_http_info(id, opts)
1359
+
1360
+ ```ruby
1361
+ begin
1362
+ # Get Catalog Item Relationships Categories
1363
+ data, status_code, headers = api_instance.get_catalog_item_relationships_categories_with_http_info(id, opts)
1364
+ p status_code # => 2xx
1365
+ p headers # => { ... }
1366
+ p data # => Hash&lt;String, Object&gt;
1367
+ rescue KlaviyoAPI::ApiError => e
1368
+ puts "Error when calling CatalogsApi->get_catalog_item_relationships_categories_with_http_info: #{e}"
1369
+ end
1370
+ ```
1371
+
1372
+ ### Parameters
1373
+
1374
+ | Name | Type | Description | Notes |
1375
+ | ---- | ---- | ----------- | ----- |
1376
+ | **id** | **String** | | |
1377
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
1378
+
1379
+ ### Return type
1380
+
1381
+ **Hash&lt;String, Object&gt;**
1382
+
1383
+ ### Authorization
1384
+
1385
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1386
+
1387
+ ### HTTP request headers
1388
+
1389
+ - **Content-Type**: Not defined
1390
+ - **Accept**: application/json
1391
+
1392
+
1393
+ ## get_catalog_item_variants
1394
+
1395
+ > Hash&lt;String, Object&gt; get_catalog_item_variants(id, opts)
1396
+
1397
+ Get Catalog Item Variants
1398
+
1399
+ Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1400
+
1401
+ ### Examples
1402
+
1403
+ ```ruby
1404
+ require 'time'
1405
+ require 'klaviyo-api-sdk'
1406
+ # setup authorization
1407
+ KlaviyoAPI.configure do |config|
1408
+ # Configure API key authorization: Klaviyo-API-Key
1409
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1410
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1411
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1412
+ end
1413
+
1414
+ api_instance = KlaviyoAPI::CatalogsApi.new
1415
+ id = 'id_example' # String |
1416
+ opts = {
1417
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1418
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1419
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1420
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
1421
+ }
1422
+
1423
+ begin
1424
+ # Get Catalog Item Variants
1425
+ result = api_instance.get_catalog_item_variants(id, opts)
1426
+ p result
1427
+ rescue KlaviyoAPI::ApiError => e
1428
+ puts "Error when calling CatalogsApi->get_catalog_item_variants: #{e}"
1429
+ end
1430
+ ```
1431
+
1432
+ #### Using the get_catalog_item_variants_with_http_info variant
1433
+
1434
+ This returns an Array which contains the response data, status code and headers.
1435
+
1436
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_item_variants_with_http_info(id, opts)
1437
+
1438
+ ```ruby
1439
+ begin
1440
+ # Get Catalog Item Variants
1441
+ data, status_code, headers = api_instance.get_catalog_item_variants_with_http_info(id, opts)
1442
+ p status_code # => 2xx
1443
+ p headers # => { ... }
1444
+ p data # => Hash&lt;String, Object&gt;
1445
+ rescue KlaviyoAPI::ApiError => e
1446
+ puts "Error when calling CatalogsApi->get_catalog_item_variants_with_http_info: #{e}"
1447
+ end
1448
+ ```
1449
+
1450
+ ### Parameters
1451
+
1452
+ | Name | Type | Description | Notes |
1453
+ | ---- | ---- | ----------- | ----- |
1454
+ | **id** | **String** | | |
1455
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1456
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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.id&#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] |
1457
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
1458
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting | [optional] |
1459
+
1460
+ ### Return type
1461
+
1462
+ **Hash&lt;String, Object&gt;**
1463
+
1464
+ ### Authorization
1465
+
1466
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1467
+
1468
+ ### HTTP request headers
1469
+
1470
+ - **Content-Type**: Not defined
1471
+ - **Accept**: application/json
1472
+
1473
+
1474
+ ## get_catalog_items
1475
+
1476
+ > Hash&lt;String, Object&gt; get_catalog_items(opts)
1477
+
1478
+ Get Catalog Items
1479
+
1480
+ Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1481
+
1482
+ ### Examples
1483
+
1484
+ ```ruby
1485
+ require 'time'
1486
+ require 'klaviyo-api-sdk'
1487
+ # setup authorization
1488
+ KlaviyoAPI.configure do |config|
1489
+ # Configure API key authorization: Klaviyo-API-Key
1490
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1491
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1492
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1493
+ end
1494
+
1495
+ api_instance = KlaviyoAPI::CatalogsApi.new
1496
+ opts = {
1497
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1498
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1499
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1500
+ include: ['variants'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
1501
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1502
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
1503
+ }
1504
+
1505
+ begin
1506
+ # Get Catalog Items
1507
+ result = api_instance.get_catalog_items(opts)
1508
+ p result
1509
+ rescue KlaviyoAPI::ApiError => e
1510
+ puts "Error when calling CatalogsApi->get_catalog_items: #{e}"
1511
+ end
1512
+ ```
1513
+
1514
+ #### Using the get_catalog_items_with_http_info variant
1515
+
1516
+ This returns an Array which contains the response data, status code and headers.
1517
+
1518
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_items_with_http_info(opts)
1519
+
1520
+ ```ruby
1521
+ begin
1522
+ # Get Catalog Items
1523
+ data, status_code, headers = api_instance.get_catalog_items_with_http_info(opts)
1524
+ p status_code # => 2xx
1525
+ p headers # => { ... }
1526
+ p data # => Hash&lt;String, Object&gt;
1527
+ rescue KlaviyoAPI::ApiError => e
1528
+ puts "Error when calling CatalogsApi->get_catalog_items_with_http_info: #{e}"
1529
+ end
1530
+ ```
1531
+
1532
+ ### Parameters
1533
+
1534
+ | Name | Type | Description | Notes |
1535
+ | ---- | ---- | ----------- | ----- |
1536
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1537
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1538
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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.id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60; | [optional] |
1539
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
1540
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
1541
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting | [optional] |
1542
+
1543
+ ### Return type
1544
+
1545
+ **Hash&lt;String, Object&gt;**
1546
+
1547
+ ### Authorization
1548
+
1549
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1550
+
1551
+ ### HTTP request headers
1552
+
1553
+ - **Content-Type**: Not defined
1554
+ - **Accept**: application/json
1555
+
1556
+
1557
+ ## get_catalog_variant
1558
+
1559
+ > Hash&lt;String, Object&gt; get_catalog_variant(id, opts)
1560
+
1561
+ Get Catalog Variant
1562
+
1563
+ Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1564
+
1565
+ ### Examples
1566
+
1567
+ ```ruby
1568
+ require 'time'
1569
+ require 'klaviyo-api-sdk'
1570
+ # setup authorization
1571
+ KlaviyoAPI.configure do |config|
1572
+ # Configure API key authorization: Klaviyo-API-Key
1573
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1574
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1575
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1576
+ end
1577
+
1578
+ api_instance = KlaviyoAPI::CatalogsApi.new
1579
+ 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`.
1580
+ opts = {
1581
+ fields_catalog_variant: ['external_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1582
+ }
1583
+
1584
+ begin
1585
+ # Get Catalog Variant
1586
+ result = api_instance.get_catalog_variant(id, opts)
1587
+ p result
1588
+ rescue KlaviyoAPI::ApiError => e
1589
+ puts "Error when calling CatalogsApi->get_catalog_variant: #{e}"
1590
+ end
1591
+ ```
1592
+
1593
+ #### Using the get_catalog_variant_with_http_info variant
1594
+
1595
+ This returns an Array which contains the response data, status code and headers.
1596
+
1597
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_variant_with_http_info(id, opts)
1598
+
1599
+ ```ruby
1600
+ begin
1601
+ # Get Catalog Variant
1602
+ data, status_code, headers = api_instance.get_catalog_variant_with_http_info(id, opts)
1603
+ p status_code # => 2xx
1604
+ p headers # => { ... }
1605
+ p data # => Hash&lt;String, Object&gt;
1606
+ rescue KlaviyoAPI::ApiError => e
1607
+ puts "Error when calling CatalogsApi->get_catalog_variant_with_http_info: #{e}"
1608
+ end
1609
+ ```
1610
+
1611
+ ### Parameters
1612
+
1613
+ | Name | Type | Description | Notes |
1614
+ | ---- | ---- | ----------- | ----- |
1615
+ | **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;. | |
1616
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1617
+
1618
+ ### Return type
1619
+
1620
+ **Hash&lt;String, Object&gt;**
1621
+
1622
+ ### Authorization
1623
+
1624
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1625
+
1626
+ ### HTTP request headers
1627
+
1628
+ - **Content-Type**: Not defined
1629
+ - **Accept**: application/json
1630
+
1631
+
1632
+ ## get_catalog_variants
1633
+
1634
+ > Hash&lt;String, Object&gt; get_catalog_variants(opts)
1635
+
1636
+ Get Catalog Variants
1637
+
1638
+ Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1639
+
1640
+ ### Examples
1641
+
1642
+ ```ruby
1643
+ require 'time'
1644
+ require 'klaviyo-api-sdk'
1645
+ # setup authorization
1646
+ KlaviyoAPI.configure do |config|
1647
+ # Configure API key authorization: Klaviyo-API-Key
1648
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1649
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1650
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1651
+ end
1652
+
1653
+ api_instance = KlaviyoAPI::CatalogsApi.new
1654
+ opts = {
1655
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1656
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
1657
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1658
+ sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting
1659
+ }
1660
+
1661
+ begin
1662
+ # Get Catalog Variants
1663
+ result = api_instance.get_catalog_variants(opts)
1664
+ p result
1665
+ rescue KlaviyoAPI::ApiError => e
1666
+ puts "Error when calling CatalogsApi->get_catalog_variants: #{e}"
1667
+ end
1668
+ ```
1669
+
1670
+ #### Using the get_catalog_variants_with_http_info variant
1671
+
1672
+ This returns an Array which contains the response data, status code and headers.
1673
+
1674
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_catalog_variants_with_http_info(opts)
1675
+
1676
+ ```ruby
1677
+ begin
1678
+ # Get Catalog Variants
1679
+ data, status_code, headers = api_instance.get_catalog_variants_with_http_info(opts)
1680
+ p status_code # => 2xx
1681
+ p headers # => { ... }
1682
+ p data # => Hash&lt;String, Object&gt;
1683
+ rescue KlaviyoAPI::ApiError => e
1684
+ puts "Error when calling CatalogsApi->get_catalog_variants_with_http_info: #{e}"
1685
+ end
1686
+ ```
1687
+
1688
+ ### Parameters
1689
+
1690
+ | Name | Type | Description | Notes |
1691
+ | ---- | ---- | ----------- | ----- |
1692
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1693
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/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.id&#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] |
1694
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
1695
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting | [optional] |
1696
+
1697
+ ### Return type
1698
+
1699
+ **Hash&lt;String, Object&gt;**
1700
+
1701
+ ### Authorization
1702
+
1703
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1704
+
1705
+ ### HTTP request headers
1706
+
1707
+ - **Content-Type**: Not defined
1708
+ - **Accept**: application/json
1709
+
1710
+
1711
+ ## get_create_categories_job
1712
+
1713
+ > Hash&lt;String, Object&gt; get_create_categories_job(job_id, opts)
1714
+
1715
+ Get Create Categories Job
1716
+
1717
+ 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`
1718
+
1719
+ ### Examples
1720
+
1721
+ ```ruby
1722
+ require 'time'
1723
+ require 'klaviyo-api-sdk'
1724
+ # setup authorization
1725
+ KlaviyoAPI.configure do |config|
1726
+ # Configure API key authorization: Klaviyo-API-Key
1727
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1728
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1729
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1730
+ end
1731
+
1732
+ api_instance = KlaviyoAPI::CatalogsApi.new
1733
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
1734
+ opts = {
1735
+ fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1736
+ fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1737
+ include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
1738
+ }
1739
+
1740
+ begin
1741
+ # Get Create Categories Job
1742
+ result = api_instance.get_create_categories_job(job_id, opts)
1743
+ p result
1744
+ rescue KlaviyoAPI::ApiError => e
1745
+ puts "Error when calling CatalogsApi->get_create_categories_job: #{e}"
1746
+ end
1747
+ ```
1748
+
1749
+ #### Using the get_create_categories_job_with_http_info variant
1750
+
1751
+ This returns an Array which contains the response data, status code and headers.
1752
+
1753
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_create_categories_job_with_http_info(job_id, opts)
1754
+
1755
+ ```ruby
1756
+ begin
1757
+ # Get Create Categories Job
1758
+ data, status_code, headers = api_instance.get_create_categories_job_with_http_info(job_id, opts)
1759
+ p status_code # => 2xx
1760
+ p headers # => { ... }
1761
+ p data # => Hash&lt;String, Object&gt;
1762
+ rescue KlaviyoAPI::ApiError => e
1763
+ puts "Error when calling CatalogsApi->get_create_categories_job_with_http_info: #{e}"
1764
+ end
1765
+ ```
1766
+
1767
+ ### Parameters
1768
+
1769
+ | Name | Type | Description | Notes |
1770
+ | ---- | ---- | ----------- | ----- |
1771
+ | **job_id** | **String** | ID of the job to retrieve. | |
1772
+ | **fields_catalog_category_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1773
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1774
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
1775
+
1776
+ ### Return type
1777
+
1778
+ **Hash&lt;String, Object&gt;**
1779
+
1780
+ ### Authorization
1781
+
1782
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1783
+
1784
+ ### HTTP request headers
1785
+
1786
+ - **Content-Type**: Not defined
1787
+ - **Accept**: application/json
1788
+
1789
+
1790
+ ## get_create_categories_jobs
1791
+
1792
+ > Hash&lt;String, Object&gt; get_create_categories_jobs(opts)
1793
+
1794
+ Get Create Categories Jobs
1795
+
1796
+ Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1797
+
1798
+ ### Examples
1799
+
1800
+ ```ruby
1801
+ require 'time'
1802
+ require 'klaviyo-api-sdk'
1803
+ # setup authorization
1804
+ KlaviyoAPI.configure do |config|
1805
+ # Configure API key authorization: Klaviyo-API-Key
1806
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1807
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1808
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1809
+ end
1810
+
1811
+ api_instance = KlaviyoAPI::CatalogsApi.new
1812
+ opts = {
1813
+ fields_catalog_category_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1814
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
1815
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1816
+ }
1817
+
1818
+ begin
1819
+ # Get Create Categories Jobs
1820
+ result = api_instance.get_create_categories_jobs(opts)
1821
+ p result
1822
+ rescue KlaviyoAPI::ApiError => e
1823
+ puts "Error when calling CatalogsApi->get_create_categories_jobs: #{e}"
1824
+ end
1825
+ ```
1826
+
1827
+ #### Using the get_create_categories_jobs_with_http_info variant
1828
+
1829
+ This returns an Array which contains the response data, status code and headers.
1830
+
1831
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_create_categories_jobs_with_http_info(opts)
1832
+
1833
+ ```ruby
1834
+ begin
1835
+ # Get Create Categories Jobs
1836
+ data, status_code, headers = api_instance.get_create_categories_jobs_with_http_info(opts)
1837
+ p status_code # => 2xx
1838
+ p headers # => { ... }
1839
+ p data # => Hash&lt;String, Object&gt;
1840
+ rescue KlaviyoAPI::ApiError => e
1841
+ puts "Error when calling CatalogsApi->get_create_categories_jobs_with_http_info: #{e}"
1842
+ end
1843
+ ```
1844
+
1845
+ ### Parameters
1846
+
1847
+ | Name | Type | Description | Notes |
1848
+ | ---- | ---- | ----------- | ----- |
1849
+ | **fields_catalog_category_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1850
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
1851
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
1852
+
1853
+ ### Return type
1854
+
1855
+ **Hash&lt;String, Object&gt;**
1856
+
1857
+ ### Authorization
1858
+
1859
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1860
+
1861
+ ### HTTP request headers
1862
+
1863
+ - **Content-Type**: Not defined
1864
+ - **Accept**: application/json
1865
+
1866
+
1867
+ ## get_create_items_job
1868
+
1869
+ > Hash&lt;String, Object&gt; get_create_items_job(job_id, opts)
1870
+
1871
+ Get Create Items Job
1872
+
1873
+ 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`
1874
+
1875
+ ### Examples
1876
+
1877
+ ```ruby
1878
+ require 'time'
1879
+ require 'klaviyo-api-sdk'
1880
+ # setup authorization
1881
+ KlaviyoAPI.configure do |config|
1882
+ # Configure API key authorization: Klaviyo-API-Key
1883
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1884
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1885
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1886
+ end
1887
+
1888
+ api_instance = KlaviyoAPI::CatalogsApi.new
1889
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
1890
+ opts = {
1891
+ fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1892
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1893
+ include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
1894
+ }
1895
+
1896
+ begin
1897
+ # Get Create Items Job
1898
+ result = api_instance.get_create_items_job(job_id, opts)
1899
+ p result
1900
+ rescue KlaviyoAPI::ApiError => e
1901
+ puts "Error when calling CatalogsApi->get_create_items_job: #{e}"
1902
+ end
1903
+ ```
1904
+
1905
+ #### Using the get_create_items_job_with_http_info variant
1906
+
1907
+ This returns an Array which contains the response data, status code and headers.
1908
+
1909
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_create_items_job_with_http_info(job_id, opts)
1910
+
1911
+ ```ruby
1912
+ begin
1913
+ # Get Create Items Job
1914
+ data, status_code, headers = api_instance.get_create_items_job_with_http_info(job_id, opts)
1915
+ p status_code # => 2xx
1916
+ p headers # => { ... }
1917
+ p data # => Hash&lt;String, Object&gt;
1918
+ rescue KlaviyoAPI::ApiError => e
1919
+ puts "Error when calling CatalogsApi->get_create_items_job_with_http_info: #{e}"
1920
+ end
1921
+ ```
1922
+
1923
+ ### Parameters
1924
+
1925
+ | Name | Type | Description | Notes |
1926
+ | ---- | ---- | ----------- | ----- |
1927
+ | **job_id** | **String** | ID of the job to retrieve. | |
1928
+ | **fields_catalog_item_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1929
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
1930
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
1931
+
1932
+ ### Return type
1933
+
1934
+ **Hash&lt;String, Object&gt;**
1935
+
1936
+ ### Authorization
1937
+
1938
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1939
+
1940
+ ### HTTP request headers
1941
+
1942
+ - **Content-Type**: Not defined
1943
+ - **Accept**: application/json
1944
+
1945
+
1946
+ ## get_create_items_jobs
1947
+
1948
+ > Hash&lt;String, Object&gt; get_create_items_jobs(opts)
1949
+
1950
+ Get Create Items Jobs
1951
+
1952
+ Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
1953
+
1954
+ ### Examples
1955
+
1956
+ ```ruby
1957
+ require 'time'
1958
+ require 'klaviyo-api-sdk'
1959
+ # setup authorization
1960
+ KlaviyoAPI.configure do |config|
1961
+ # Configure API key authorization: Klaviyo-API-Key
1962
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1963
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1964
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1965
+ end
1966
+
1967
+ api_instance = KlaviyoAPI::CatalogsApi.new
1968
+ opts = {
1969
+ fields_catalog_item_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
1970
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
1971
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
1972
+ }
1973
+
1974
+ begin
1975
+ # Get Create Items Jobs
1976
+ result = api_instance.get_create_items_jobs(opts)
1977
+ p result
1978
+ rescue KlaviyoAPI::ApiError => e
1979
+ puts "Error when calling CatalogsApi->get_create_items_jobs: #{e}"
1980
+ end
1981
+ ```
1982
+
1983
+ #### Using the get_create_items_jobs_with_http_info variant
1984
+
1985
+ This returns an Array which contains the response data, status code and headers.
1986
+
1987
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_create_items_jobs_with_http_info(opts)
1988
+
1989
+ ```ruby
1990
+ begin
1991
+ # Get Create Items Jobs
1992
+ data, status_code, headers = api_instance.get_create_items_jobs_with_http_info(opts)
1993
+ p status_code # => 2xx
1994
+ p headers # => { ... }
1995
+ p data # => Hash&lt;String, Object&gt;
1996
+ rescue KlaviyoAPI::ApiError => e
1997
+ puts "Error when calling CatalogsApi->get_create_items_jobs_with_http_info: #{e}"
1998
+ end
1999
+ ```
2000
+
2001
+ ### Parameters
2002
+
2003
+ | Name | Type | Description | Notes |
2004
+ | ---- | ---- | ----------- | ----- |
2005
+ | **fields_catalog_item_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2006
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
2007
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
2008
+
2009
+ ### Return type
2010
+
2011
+ **Hash&lt;String, Object&gt;**
2012
+
2013
+ ### Authorization
2014
+
2015
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2016
+
2017
+ ### HTTP request headers
2018
+
2019
+ - **Content-Type**: Not defined
2020
+ - **Accept**: application/json
2021
+
2022
+
2023
+ ## get_create_variants_job
2024
+
2025
+ > Hash&lt;String, Object&gt; get_create_variants_job(job_id, opts)
2026
+
2027
+ Get Create Variants Job
2028
+
2029
+ 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`
2030
+
2031
+ ### Examples
2032
+
2033
+ ```ruby
2034
+ require 'time'
2035
+ require 'klaviyo-api-sdk'
2036
+ # setup authorization
2037
+ KlaviyoAPI.configure do |config|
2038
+ # Configure API key authorization: Klaviyo-API-Key
2039
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2040
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2041
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2042
+ end
2043
+
2044
+ api_instance = KlaviyoAPI::CatalogsApi.new
2045
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2046
+ opts = {
2047
+ fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2048
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2049
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
2050
+ }
2051
+
2052
+ begin
2053
+ # Get Create Variants Job
2054
+ result = api_instance.get_create_variants_job(job_id, opts)
2055
+ p result
2056
+ rescue KlaviyoAPI::ApiError => e
2057
+ puts "Error when calling CatalogsApi->get_create_variants_job: #{e}"
2058
+ end
2059
+ ```
2060
+
2061
+ #### Using the get_create_variants_job_with_http_info variant
2062
+
2063
+ This returns an Array which contains the response data, status code and headers.
2064
+
2065
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_create_variants_job_with_http_info(job_id, opts)
2066
+
2067
+ ```ruby
2068
+ begin
2069
+ # Get Create Variants Job
2070
+ data, status_code, headers = api_instance.get_create_variants_job_with_http_info(job_id, opts)
2071
+ p status_code # => 2xx
2072
+ p headers # => { ... }
2073
+ p data # => Hash&lt;String, Object&gt;
2074
+ rescue KlaviyoAPI::ApiError => e
2075
+ puts "Error when calling CatalogsApi->get_create_variants_job_with_http_info: #{e}"
2076
+ end
2077
+ ```
2078
+
2079
+ ### Parameters
2080
+
2081
+ | Name | Type | Description | Notes |
2082
+ | ---- | ---- | ----------- | ----- |
2083
+ | **job_id** | **String** | ID of the job to retrieve. | |
2084
+ | **fields_catalog_variant_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2085
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2086
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
2087
+
2088
+ ### Return type
2089
+
2090
+ **Hash&lt;String, Object&gt;**
2091
+
2092
+ ### Authorization
2093
+
2094
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2095
+
2096
+ ### HTTP request headers
2097
+
2098
+ - **Content-Type**: Not defined
2099
+ - **Accept**: application/json
2100
+
2101
+
2102
+ ## get_create_variants_jobs
2103
+
2104
+ > Hash&lt;String, Object&gt; get_create_variants_jobs(opts)
2105
+
2106
+ Get Create Variants Jobs
2107
+
2108
+ Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2109
+
2110
+ ### Examples
2111
+
2112
+ ```ruby
2113
+ require 'time'
2114
+ require 'klaviyo-api-sdk'
2115
+ # setup authorization
2116
+ KlaviyoAPI.configure do |config|
2117
+ # Configure API key authorization: Klaviyo-API-Key
2118
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2119
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2120
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2121
+ end
2122
+
2123
+ api_instance = KlaviyoAPI::CatalogsApi.new
2124
+ opts = {
2125
+ fields_catalog_variant_bulk_create_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2126
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2127
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
2128
+ }
2129
+
2130
+ begin
2131
+ # Get Create Variants Jobs
2132
+ result = api_instance.get_create_variants_jobs(opts)
2133
+ p result
2134
+ rescue KlaviyoAPI::ApiError => e
2135
+ puts "Error when calling CatalogsApi->get_create_variants_jobs: #{e}"
2136
+ end
2137
+ ```
2138
+
2139
+ #### Using the get_create_variants_jobs_with_http_info variant
2140
+
2141
+ This returns an Array which contains the response data, status code and headers.
2142
+
2143
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_create_variants_jobs_with_http_info(opts)
2144
+
2145
+ ```ruby
2146
+ begin
2147
+ # Get Create Variants Jobs
2148
+ data, status_code, headers = api_instance.get_create_variants_jobs_with_http_info(opts)
2149
+ p status_code # => 2xx
2150
+ p headers # => { ... }
2151
+ p data # => Hash&lt;String, Object&gt;
2152
+ rescue KlaviyoAPI::ApiError => e
2153
+ puts "Error when calling CatalogsApi->get_create_variants_jobs_with_http_info: #{e}"
2154
+ end
2155
+ ```
2156
+
2157
+ ### Parameters
2158
+
2159
+ | Name | Type | Description | Notes |
2160
+ | ---- | ---- | ----------- | ----- |
2161
+ | **fields_catalog_variant_bulk_create_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2162
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
2163
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
2164
+
2165
+ ### Return type
2166
+
2167
+ **Hash&lt;String, Object&gt;**
2168
+
2169
+ ### Authorization
2170
+
2171
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2172
+
2173
+ ### HTTP request headers
2174
+
2175
+ - **Content-Type**: Not defined
2176
+ - **Accept**: application/json
2177
+
2178
+
2179
+ ## get_delete_categories_job
2180
+
2181
+ > Hash&lt;String, Object&gt; get_delete_categories_job(job_id, opts)
2182
+
2183
+ Get Delete Categories Job
2184
+
2185
+ Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2186
+
2187
+ ### Examples
2188
+
2189
+ ```ruby
2190
+ require 'time'
2191
+ require 'klaviyo-api-sdk'
2192
+ # setup authorization
2193
+ KlaviyoAPI.configure do |config|
2194
+ # Configure API key authorization: Klaviyo-API-Key
2195
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2196
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2197
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2198
+ end
2199
+
2200
+ api_instance = KlaviyoAPI::CatalogsApi.new
2201
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2202
+ opts = {
2203
+ fields_catalog_category_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2204
+ }
2205
+
2206
+ begin
2207
+ # Get Delete Categories Job
2208
+ result = api_instance.get_delete_categories_job(job_id, opts)
2209
+ p result
2210
+ rescue KlaviyoAPI::ApiError => e
2211
+ puts "Error when calling CatalogsApi->get_delete_categories_job: #{e}"
2212
+ end
2213
+ ```
2214
+
2215
+ #### Using the get_delete_categories_job_with_http_info variant
2216
+
2217
+ This returns an Array which contains the response data, status code and headers.
2218
+
2219
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_delete_categories_job_with_http_info(job_id, opts)
2220
+
2221
+ ```ruby
2222
+ begin
2223
+ # Get Delete Categories Job
2224
+ data, status_code, headers = api_instance.get_delete_categories_job_with_http_info(job_id, opts)
2225
+ p status_code # => 2xx
2226
+ p headers # => { ... }
2227
+ p data # => Hash&lt;String, Object&gt;
2228
+ rescue KlaviyoAPI::ApiError => e
2229
+ puts "Error when calling CatalogsApi->get_delete_categories_job_with_http_info: #{e}"
2230
+ end
2231
+ ```
2232
+
2233
+ ### Parameters
2234
+
2235
+ | Name | Type | Description | Notes |
2236
+ | ---- | ---- | ----------- | ----- |
2237
+ | **job_id** | **String** | ID of the job to retrieve. | |
2238
+ | **fields_catalog_category_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2239
+
2240
+ ### Return type
2241
+
2242
+ **Hash&lt;String, Object&gt;**
2243
+
2244
+ ### Authorization
2245
+
2246
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2247
+
2248
+ ### HTTP request headers
2249
+
2250
+ - **Content-Type**: Not defined
2251
+ - **Accept**: application/json
2252
+
2253
+
2254
+ ## get_delete_categories_jobs
2255
+
2256
+ > Hash&lt;String, Object&gt; get_delete_categories_jobs(opts)
2257
+
2258
+ Get Delete Categories Jobs
2259
+
2260
+ Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2261
+
2262
+ ### Examples
2263
+
2264
+ ```ruby
2265
+ require 'time'
2266
+ require 'klaviyo-api-sdk'
2267
+ # setup authorization
2268
+ KlaviyoAPI.configure do |config|
2269
+ # Configure API key authorization: Klaviyo-API-Key
2270
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2271
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2272
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2273
+ end
2274
+
2275
+ api_instance = KlaviyoAPI::CatalogsApi.new
2276
+ opts = {
2277
+ fields_catalog_category_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2278
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2279
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
2280
+ }
2281
+
2282
+ begin
2283
+ # Get Delete Categories Jobs
2284
+ result = api_instance.get_delete_categories_jobs(opts)
2285
+ p result
2286
+ rescue KlaviyoAPI::ApiError => e
2287
+ puts "Error when calling CatalogsApi->get_delete_categories_jobs: #{e}"
2288
+ end
2289
+ ```
2290
+
2291
+ #### Using the get_delete_categories_jobs_with_http_info variant
2292
+
2293
+ This returns an Array which contains the response data, status code and headers.
2294
+
2295
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_delete_categories_jobs_with_http_info(opts)
2296
+
2297
+ ```ruby
2298
+ begin
2299
+ # Get Delete Categories Jobs
2300
+ data, status_code, headers = api_instance.get_delete_categories_jobs_with_http_info(opts)
2301
+ p status_code # => 2xx
2302
+ p headers # => { ... }
2303
+ p data # => Hash&lt;String, Object&gt;
2304
+ rescue KlaviyoAPI::ApiError => e
2305
+ puts "Error when calling CatalogsApi->get_delete_categories_jobs_with_http_info: #{e}"
2306
+ end
2307
+ ```
2308
+
2309
+ ### Parameters
2310
+
2311
+ | Name | Type | Description | Notes |
2312
+ | ---- | ---- | ----------- | ----- |
2313
+ | **fields_catalog_category_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2314
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
2315
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
2316
+
2317
+ ### Return type
2318
+
2319
+ **Hash&lt;String, Object&gt;**
2320
+
2321
+ ### Authorization
2322
+
2323
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2324
+
2325
+ ### HTTP request headers
2326
+
2327
+ - **Content-Type**: Not defined
2328
+ - **Accept**: application/json
2329
+
2330
+
2331
+ ## get_delete_items_job
2332
+
2333
+ > Hash&lt;String, Object&gt; get_delete_items_job(job_id, opts)
2334
+
2335
+ Get Delete Items Job
2336
+
2337
+ Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2338
+
2339
+ ### Examples
2340
+
2341
+ ```ruby
2342
+ require 'time'
2343
+ require 'klaviyo-api-sdk'
2344
+ # setup authorization
2345
+ KlaviyoAPI.configure do |config|
2346
+ # Configure API key authorization: Klaviyo-API-Key
2347
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2348
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2349
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2350
+ end
2351
+
2352
+ api_instance = KlaviyoAPI::CatalogsApi.new
2353
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2354
+ opts = {
2355
+ fields_catalog_item_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2356
+ }
2357
+
2358
+ begin
2359
+ # Get Delete Items Job
2360
+ result = api_instance.get_delete_items_job(job_id, opts)
2361
+ p result
2362
+ rescue KlaviyoAPI::ApiError => e
2363
+ puts "Error when calling CatalogsApi->get_delete_items_job: #{e}"
2364
+ end
2365
+ ```
2366
+
2367
+ #### Using the get_delete_items_job_with_http_info variant
2368
+
2369
+ This returns an Array which contains the response data, status code and headers.
2370
+
2371
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_delete_items_job_with_http_info(job_id, opts)
2372
+
2373
+ ```ruby
2374
+ begin
2375
+ # Get Delete Items Job
2376
+ data, status_code, headers = api_instance.get_delete_items_job_with_http_info(job_id, opts)
2377
+ p status_code # => 2xx
2378
+ p headers # => { ... }
2379
+ p data # => Hash&lt;String, Object&gt;
2380
+ rescue KlaviyoAPI::ApiError => e
2381
+ puts "Error when calling CatalogsApi->get_delete_items_job_with_http_info: #{e}"
2382
+ end
2383
+ ```
2384
+
2385
+ ### Parameters
2386
+
2387
+ | Name | Type | Description | Notes |
2388
+ | ---- | ---- | ----------- | ----- |
2389
+ | **job_id** | **String** | ID of the job to retrieve. | |
2390
+ | **fields_catalog_item_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2391
+
2392
+ ### Return type
2393
+
2394
+ **Hash&lt;String, Object&gt;**
2395
+
2396
+ ### Authorization
2397
+
2398
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2399
+
2400
+ ### HTTP request headers
2401
+
2402
+ - **Content-Type**: Not defined
2403
+ - **Accept**: application/json
2404
+
2405
+
2406
+ ## get_delete_items_jobs
2407
+
2408
+ > Hash&lt;String, Object&gt; get_delete_items_jobs(opts)
2409
+
2410
+ Get Delete Items Jobs
2411
+
2412
+ Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2413
+
2414
+ ### Examples
2415
+
2416
+ ```ruby
2417
+ require 'time'
2418
+ require 'klaviyo-api-sdk'
2419
+ # setup authorization
2420
+ KlaviyoAPI.configure do |config|
2421
+ # Configure API key authorization: Klaviyo-API-Key
2422
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2423
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2424
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2425
+ end
2426
+
2427
+ api_instance = KlaviyoAPI::CatalogsApi.new
2428
+ opts = {
2429
+ fields_catalog_item_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2430
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2431
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
2432
+ }
2433
+
2434
+ begin
2435
+ # Get Delete Items Jobs
2436
+ result = api_instance.get_delete_items_jobs(opts)
2437
+ p result
2438
+ rescue KlaviyoAPI::ApiError => e
2439
+ puts "Error when calling CatalogsApi->get_delete_items_jobs: #{e}"
2440
+ end
2441
+ ```
2442
+
2443
+ #### Using the get_delete_items_jobs_with_http_info variant
2444
+
2445
+ This returns an Array which contains the response data, status code and headers.
2446
+
2447
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_delete_items_jobs_with_http_info(opts)
2448
+
2449
+ ```ruby
2450
+ begin
2451
+ # Get Delete Items Jobs
2452
+ data, status_code, headers = api_instance.get_delete_items_jobs_with_http_info(opts)
2453
+ p status_code # => 2xx
2454
+ p headers # => { ... }
2455
+ p data # => Hash&lt;String, Object&gt;
2456
+ rescue KlaviyoAPI::ApiError => e
2457
+ puts "Error when calling CatalogsApi->get_delete_items_jobs_with_http_info: #{e}"
2458
+ end
2459
+ ```
2460
+
2461
+ ### Parameters
2462
+
2463
+ | Name | Type | Description | Notes |
2464
+ | ---- | ---- | ----------- | ----- |
2465
+ | **fields_catalog_item_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2466
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
2467
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
2468
+
2469
+ ### Return type
2470
+
2471
+ **Hash&lt;String, Object&gt;**
2472
+
2473
+ ### Authorization
2474
+
2475
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2476
+
2477
+ ### HTTP request headers
2478
+
2479
+ - **Content-Type**: Not defined
2480
+ - **Accept**: application/json
2481
+
2482
+
2483
+ ## get_delete_variants_job
2484
+
2485
+ > Hash&lt;String, Object&gt; get_delete_variants_job(job_id, opts)
2486
+
2487
+ Get Delete Variants Job
2488
+
2489
+ Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2490
+
2491
+ ### Examples
2492
+
2493
+ ```ruby
2494
+ require 'time'
2495
+ require 'klaviyo-api-sdk'
2496
+ # setup authorization
2497
+ KlaviyoAPI.configure do |config|
2498
+ # Configure API key authorization: Klaviyo-API-Key
2499
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2500
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2501
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2502
+ end
2503
+
2504
+ api_instance = KlaviyoAPI::CatalogsApi.new
2505
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2506
+ opts = {
2507
+ fields_catalog_variant_bulk_delete_job: ['job_id'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2508
+ }
2509
+
2510
+ begin
2511
+ # Get Delete Variants Job
2512
+ result = api_instance.get_delete_variants_job(job_id, opts)
2513
+ p result
2514
+ rescue KlaviyoAPI::ApiError => e
2515
+ puts "Error when calling CatalogsApi->get_delete_variants_job: #{e}"
2516
+ end
2517
+ ```
2518
+
2519
+ #### Using the get_delete_variants_job_with_http_info variant
2520
+
2521
+ This returns an Array which contains the response data, status code and headers.
2522
+
2523
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_delete_variants_job_with_http_info(job_id, opts)
2524
+
2525
+ ```ruby
2526
+ begin
2527
+ # Get Delete Variants Job
2528
+ data, status_code, headers = api_instance.get_delete_variants_job_with_http_info(job_id, opts)
2529
+ p status_code # => 2xx
2530
+ p headers # => { ... }
2531
+ p data # => Hash&lt;String, Object&gt;
2532
+ rescue KlaviyoAPI::ApiError => e
2533
+ puts "Error when calling CatalogsApi->get_delete_variants_job_with_http_info: #{e}"
2534
+ end
2535
+ ```
2536
+
2537
+ ### Parameters
2538
+
2539
+ | Name | Type | Description | Notes |
2540
+ | ---- | ---- | ----------- | ----- |
2541
+ | **job_id** | **String** | ID of the job to retrieve. | |
2542
+ | **fields_catalog_variant_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2543
+
2544
+ ### Return type
2545
+
2546
+ **Hash&lt;String, Object&gt;**
2547
+
2548
+ ### Authorization
2549
+
2550
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2551
+
2552
+ ### HTTP request headers
2553
+
2554
+ - **Content-Type**: Not defined
2555
+ - **Accept**: application/json
2556
+
2557
+
2558
+ ## get_delete_variants_jobs
2559
+
2560
+ > Hash&lt;String, Object&gt; get_delete_variants_jobs(opts)
2561
+
2562
+ Get Delete Variants Jobs
2563
+
2564
+ Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2565
+
2566
+ ### Examples
2567
+
2568
+ ```ruby
2569
+ require 'time'
2570
+ require 'klaviyo-api-sdk'
2571
+ # setup authorization
2572
+ KlaviyoAPI.configure do |config|
2573
+ # Configure API key authorization: Klaviyo-API-Key
2574
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2575
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2576
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2577
+ end
2578
+
2579
+ api_instance = KlaviyoAPI::CatalogsApi.new
2580
+ opts = {
2581
+ fields_catalog_variant_bulk_delete_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2582
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2583
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
2584
+ }
2585
+
2586
+ begin
2587
+ # Get Delete Variants Jobs
2588
+ result = api_instance.get_delete_variants_jobs(opts)
2589
+ p result
2590
+ rescue KlaviyoAPI::ApiError => e
2591
+ puts "Error when calling CatalogsApi->get_delete_variants_jobs: #{e}"
2592
+ end
2593
+ ```
2594
+
2595
+ #### Using the get_delete_variants_jobs_with_http_info variant
2596
+
2597
+ This returns an Array which contains the response data, status code and headers.
2598
+
2599
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_delete_variants_jobs_with_http_info(opts)
2600
+
2601
+ ```ruby
2602
+ begin
2603
+ # Get Delete Variants Jobs
2604
+ data, status_code, headers = api_instance.get_delete_variants_jobs_with_http_info(opts)
2605
+ p status_code # => 2xx
2606
+ p headers # => { ... }
2607
+ p data # => Hash&lt;String, Object&gt;
2608
+ rescue KlaviyoAPI::ApiError => e
2609
+ puts "Error when calling CatalogsApi->get_delete_variants_jobs_with_http_info: #{e}"
2610
+ end
2611
+ ```
2612
+
2613
+ ### Parameters
2614
+
2615
+ | Name | Type | Description | Notes |
2616
+ | ---- | ---- | ----------- | ----- |
2617
+ | **fields_catalog_variant_bulk_delete_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2618
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
2619
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
2620
+
2621
+ ### Return type
2622
+
2623
+ **Hash&lt;String, Object&gt;**
2624
+
2625
+ ### Authorization
2626
+
2627
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2628
+
2629
+ ### HTTP request headers
2630
+
2631
+ - **Content-Type**: Not defined
2632
+ - **Accept**: application/json
2633
+
2634
+
2635
+ ## get_update_categories_job
2636
+
2637
+ > Hash&lt;String, Object&gt; get_update_categories_job(job_id, opts)
2638
+
2639
+ Get Update Categories Job
2640
+
2641
+ 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`
2642
+
2643
+ ### Examples
2644
+
2645
+ ```ruby
2646
+ require 'time'
2647
+ require 'klaviyo-api-sdk'
2648
+ # setup authorization
2649
+ KlaviyoAPI.configure do |config|
2650
+ # Configure API key authorization: Klaviyo-API-Key
2651
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2652
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2653
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2654
+ end
2655
+
2656
+ api_instance = KlaviyoAPI::CatalogsApi.new
2657
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2658
+ opts = {
2659
+ fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2660
+ fields_catalog_category: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2661
+ include: ['categories'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
2662
+ }
2663
+
2664
+ begin
2665
+ # Get Update Categories Job
2666
+ result = api_instance.get_update_categories_job(job_id, opts)
2667
+ p result
2668
+ rescue KlaviyoAPI::ApiError => e
2669
+ puts "Error when calling CatalogsApi->get_update_categories_job: #{e}"
2670
+ end
2671
+ ```
2672
+
2673
+ #### Using the get_update_categories_job_with_http_info variant
2674
+
2675
+ This returns an Array which contains the response data, status code and headers.
2676
+
2677
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_update_categories_job_with_http_info(job_id, opts)
2678
+
2679
+ ```ruby
2680
+ begin
2681
+ # Get Update Categories Job
2682
+ data, status_code, headers = api_instance.get_update_categories_job_with_http_info(job_id, opts)
2683
+ p status_code # => 2xx
2684
+ p headers # => { ... }
2685
+ p data # => Hash&lt;String, Object&gt;
2686
+ rescue KlaviyoAPI::ApiError => e
2687
+ puts "Error when calling CatalogsApi->get_update_categories_job_with_http_info: #{e}"
2688
+ end
2689
+ ```
2690
+
2691
+ ### Parameters
2692
+
2693
+ | Name | Type | Description | Notes |
2694
+ | ---- | ---- | ----------- | ----- |
2695
+ | **job_id** | **String** | ID of the job to retrieve. | |
2696
+ | **fields_catalog_category_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2697
+ | **fields_catalog_category** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2698
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
2699
+
2700
+ ### Return type
2701
+
2702
+ **Hash&lt;String, Object&gt;**
2703
+
2704
+ ### Authorization
2705
+
2706
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2707
+
2708
+ ### HTTP request headers
2709
+
2710
+ - **Content-Type**: Not defined
2711
+ - **Accept**: application/json
2712
+
2713
+
2714
+ ## get_update_categories_jobs
2715
+
2716
+ > Hash&lt;String, Object&gt; get_update_categories_jobs(opts)
2717
+
2718
+ Get Update Categories Jobs
2719
+
2720
+ Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2721
+
2722
+ ### Examples
2723
+
2724
+ ```ruby
2725
+ require 'time'
2726
+ require 'klaviyo-api-sdk'
2727
+ # setup authorization
2728
+ KlaviyoAPI.configure do |config|
2729
+ # Configure API key authorization: Klaviyo-API-Key
2730
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2731
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2732
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2733
+ end
2734
+
2735
+ api_instance = KlaviyoAPI::CatalogsApi.new
2736
+ opts = {
2737
+ fields_catalog_category_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2738
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2739
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
2740
+ }
2741
+
2742
+ begin
2743
+ # Get Update Categories Jobs
2744
+ result = api_instance.get_update_categories_jobs(opts)
2745
+ p result
2746
+ rescue KlaviyoAPI::ApiError => e
2747
+ puts "Error when calling CatalogsApi->get_update_categories_jobs: #{e}"
2748
+ end
2749
+ ```
2750
+
2751
+ #### Using the get_update_categories_jobs_with_http_info variant
2752
+
2753
+ This returns an Array which contains the response data, status code and headers.
2754
+
2755
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_update_categories_jobs_with_http_info(opts)
2756
+
2757
+ ```ruby
2758
+ begin
2759
+ # Get Update Categories Jobs
2760
+ data, status_code, headers = api_instance.get_update_categories_jobs_with_http_info(opts)
2761
+ p status_code # => 2xx
2762
+ p headers # => { ... }
2763
+ p data # => Hash&lt;String, Object&gt;
2764
+ rescue KlaviyoAPI::ApiError => e
2765
+ puts "Error when calling CatalogsApi->get_update_categories_jobs_with_http_info: #{e}"
2766
+ end
2767
+ ```
2768
+
2769
+ ### Parameters
2770
+
2771
+ | Name | Type | Description | Notes |
2772
+ | ---- | ---- | ----------- | ----- |
2773
+ | **fields_catalog_category_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2774
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
2775
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
2776
+
2777
+ ### Return type
2778
+
2779
+ **Hash&lt;String, Object&gt;**
2780
+
2781
+ ### Authorization
2782
+
2783
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2784
+
2785
+ ### HTTP request headers
2786
+
2787
+ - **Content-Type**: Not defined
2788
+ - **Accept**: application/json
2789
+
2790
+
2791
+ ## get_update_items_job
2792
+
2793
+ > Hash&lt;String, Object&gt; get_update_items_job(job_id, opts)
2794
+
2795
+ Get Update Items Job
2796
+
2797
+ 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`
2798
+
2799
+ ### Examples
2800
+
2801
+ ```ruby
2802
+ require 'time'
2803
+ require 'klaviyo-api-sdk'
2804
+ # setup authorization
2805
+ KlaviyoAPI.configure do |config|
2806
+ # Configure API key authorization: Klaviyo-API-Key
2807
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2808
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2809
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2810
+ end
2811
+
2812
+ api_instance = KlaviyoAPI::CatalogsApi.new
2813
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2814
+ opts = {
2815
+ fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2816
+ fields_catalog_item: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2817
+ include: ['items'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
2818
+ }
2819
+
2820
+ begin
2821
+ # Get Update Items Job
2822
+ result = api_instance.get_update_items_job(job_id, opts)
2823
+ p result
2824
+ rescue KlaviyoAPI::ApiError => e
2825
+ puts "Error when calling CatalogsApi->get_update_items_job: #{e}"
2826
+ end
2827
+ ```
2828
+
2829
+ #### Using the get_update_items_job_with_http_info variant
2830
+
2831
+ This returns an Array which contains the response data, status code and headers.
2832
+
2833
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_update_items_job_with_http_info(job_id, opts)
2834
+
2835
+ ```ruby
2836
+ begin
2837
+ # Get Update Items Job
2838
+ data, status_code, headers = api_instance.get_update_items_job_with_http_info(job_id, opts)
2839
+ p status_code # => 2xx
2840
+ p headers # => { ... }
2841
+ p data # => Hash&lt;String, Object&gt;
2842
+ rescue KlaviyoAPI::ApiError => e
2843
+ puts "Error when calling CatalogsApi->get_update_items_job_with_http_info: #{e}"
2844
+ end
2845
+ ```
2846
+
2847
+ ### Parameters
2848
+
2849
+ | Name | Type | Description | Notes |
2850
+ | ---- | ---- | ----------- | ----- |
2851
+ | **job_id** | **String** | ID of the job to retrieve. | |
2852
+ | **fields_catalog_item_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2853
+ | **fields_catalog_item** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2854
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
2855
+
2856
+ ### Return type
2857
+
2858
+ **Hash&lt;String, Object&gt;**
2859
+
2860
+ ### Authorization
2861
+
2862
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2863
+
2864
+ ### HTTP request headers
2865
+
2866
+ - **Content-Type**: Not defined
2867
+ - **Accept**: application/json
2868
+
2869
+
2870
+ ## get_update_items_jobs
2871
+
2872
+ > Hash&lt;String, Object&gt; get_update_items_jobs(opts)
2873
+
2874
+ Get Update Items Jobs
2875
+
2876
+ Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
2877
+
2878
+ ### Examples
2879
+
2880
+ ```ruby
2881
+ require 'time'
2882
+ require 'klaviyo-api-sdk'
2883
+ # setup authorization
2884
+ KlaviyoAPI.configure do |config|
2885
+ # Configure API key authorization: Klaviyo-API-Key
2886
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2887
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2888
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2889
+ end
2890
+
2891
+ api_instance = KlaviyoAPI::CatalogsApi.new
2892
+ opts = {
2893
+ fields_catalog_item_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2894
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
2895
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
2896
+ }
2897
+
2898
+ begin
2899
+ # Get Update Items Jobs
2900
+ result = api_instance.get_update_items_jobs(opts)
2901
+ p result
2902
+ rescue KlaviyoAPI::ApiError => e
2903
+ puts "Error when calling CatalogsApi->get_update_items_jobs: #{e}"
2904
+ end
2905
+ ```
2906
+
2907
+ #### Using the get_update_items_jobs_with_http_info variant
2908
+
2909
+ This returns an Array which contains the response data, status code and headers.
2910
+
2911
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_update_items_jobs_with_http_info(opts)
2912
+
2913
+ ```ruby
2914
+ begin
2915
+ # Get Update Items Jobs
2916
+ data, status_code, headers = api_instance.get_update_items_jobs_with_http_info(opts)
2917
+ p status_code # => 2xx
2918
+ p headers # => { ... }
2919
+ p data # => Hash&lt;String, Object&gt;
2920
+ rescue KlaviyoAPI::ApiError => e
2921
+ puts "Error when calling CatalogsApi->get_update_items_jobs_with_http_info: #{e}"
2922
+ end
2923
+ ```
2924
+
2925
+ ### Parameters
2926
+
2927
+ | Name | Type | Description | Notes |
2928
+ | ---- | ---- | ----------- | ----- |
2929
+ | **fields_catalog_item_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
2930
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
2931
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
2932
+
2933
+ ### Return type
2934
+
2935
+ **Hash&lt;String, Object&gt;**
2936
+
2937
+ ### Authorization
2938
+
2939
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
2940
+
2941
+ ### HTTP request headers
2942
+
2943
+ - **Content-Type**: Not defined
2944
+ - **Accept**: application/json
2945
+
2946
+
2947
+ ## get_update_variants_job
2948
+
2949
+ > Hash&lt;String, Object&gt; get_update_variants_job(job_id, opts)
2950
+
2951
+ Get Update Variants Job
2952
+
2953
+ 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`
2954
+
2955
+ ### Examples
2956
+
2957
+ ```ruby
2958
+ require 'time'
2959
+ require 'klaviyo-api-sdk'
2960
+ # setup authorization
2961
+ KlaviyoAPI.configure do |config|
2962
+ # Configure API key authorization: Klaviyo-API-Key
2963
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
2964
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2965
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
2966
+ end
2967
+
2968
+ api_instance = KlaviyoAPI::CatalogsApi.new
2969
+ job_id = '01GSQPBF74KQ5YTDEPP41T1BZH' # String | ID of the job to retrieve.
2970
+ opts = {
2971
+ fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2972
+ fields_catalog_variant: ['external_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
2973
+ include: ['variants'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships
2974
+ }
2975
+
2976
+ begin
2977
+ # Get Update Variants Job
2978
+ result = api_instance.get_update_variants_job(job_id, opts)
2979
+ p result
2980
+ rescue KlaviyoAPI::ApiError => e
2981
+ puts "Error when calling CatalogsApi->get_update_variants_job: #{e}"
2982
+ end
2983
+ ```
2984
+
2985
+ #### Using the get_update_variants_job_with_http_info variant
2986
+
2987
+ This returns an Array which contains the response data, status code and headers.
2988
+
2989
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_update_variants_job_with_http_info(job_id, opts)
2990
+
2991
+ ```ruby
2992
+ begin
2993
+ # Get Update Variants Job
2994
+ data, status_code, headers = api_instance.get_update_variants_job_with_http_info(job_id, opts)
2995
+ p status_code # => 2xx
2996
+ p headers # => { ... }
2997
+ p data # => Hash&lt;String, Object&gt;
2998
+ rescue KlaviyoAPI::ApiError => e
2999
+ puts "Error when calling CatalogsApi->get_update_variants_job_with_http_info: #{e}"
3000
+ end
3001
+ ```
3002
+
3003
+ ### Parameters
3004
+
3005
+ | Name | Type | Description | Notes |
3006
+ | ---- | ---- | ----------- | ----- |
3007
+ | **job_id** | **String** | ID of the job to retrieve. | |
3008
+ | **fields_catalog_variant_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
3009
+ | **fields_catalog_variant** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
3010
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | [optional] |
3011
+
3012
+ ### Return type
3013
+
3014
+ **Hash&lt;String, Object&gt;**
3015
+
3016
+ ### Authorization
3017
+
3018
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3019
+
3020
+ ### HTTP request headers
3021
+
3022
+ - **Content-Type**: Not defined
3023
+ - **Accept**: application/json
3024
+
3025
+
3026
+ ## get_update_variants_jobs
3027
+
3028
+ > Hash&lt;String, Object&gt; get_update_variants_jobs(opts)
3029
+
3030
+ Get Update Variants Jobs
3031
+
3032
+ Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
3033
+
3034
+ ### Examples
3035
+
3036
+ ```ruby
3037
+ require 'time'
3038
+ require 'klaviyo-api-sdk'
3039
+ # setup authorization
3040
+ KlaviyoAPI.configure do |config|
3041
+ # Configure API key authorization: Klaviyo-API-Key
3042
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3043
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3044
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3045
+ end
3046
+
3047
+ api_instance = KlaviyoAPI::CatalogsApi.new
3048
+ opts = {
3049
+ fields_catalog_variant_bulk_update_job: ['job_id'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets
3050
+ filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
3051
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination
3052
+ }
3053
+
3054
+ begin
3055
+ # Get Update Variants Jobs
3056
+ result = api_instance.get_update_variants_jobs(opts)
3057
+ p result
3058
+ rescue KlaviyoAPI::ApiError => e
3059
+ puts "Error when calling CatalogsApi->get_update_variants_jobs: #{e}"
3060
+ end
3061
+ ```
3062
+
3063
+ #### Using the get_update_variants_jobs_with_http_info variant
3064
+
3065
+ This returns an Array which contains the response data, status code and headers.
3066
+
3067
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_update_variants_jobs_with_http_info(opts)
3068
+
3069
+ ```ruby
3070
+ begin
3071
+ # Get Update Variants Jobs
3072
+ data, status_code, headers = api_instance.get_update_variants_jobs_with_http_info(opts)
3073
+ p status_code # => 2xx
3074
+ p headers # => { ... }
3075
+ p data # => Hash&lt;String, Object&gt;
3076
+ rescue KlaviyoAPI::ApiError => e
3077
+ puts "Error when calling CatalogsApi->get_update_variants_jobs_with_http_info: #{e}"
3078
+ end
3079
+ ```
3080
+
3081
+ ### Parameters
3082
+
3083
+ | Name | Type | Description | Notes |
3084
+ | ---- | ---- | ----------- | ----- |
3085
+ | **fields_catalog_variant_bulk_update_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | [optional] |
3086
+ | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60; | [optional] |
3087
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | [optional] |
3088
+
3089
+ ### Return type
3090
+
3091
+ **Hash&lt;String, Object&gt;**
3092
+
3093
+ ### Authorization
3094
+
3095
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3096
+
3097
+ ### HTTP request headers
3098
+
3099
+ - **Content-Type**: Not defined
3100
+ - **Accept**: application/json
3101
+
3102
+
3103
+ ## spawn_create_categories_job
3104
+
3105
+ > Hash&lt;String, Object&gt; spawn_create_categories_job(catalog_category_create_job_create_query)
3106
+
3107
+ Spawn Create Categories Job
3108
+
3109
+ 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`
3110
+
3111
+ ### Examples
3112
+
3113
+ ```ruby
3114
+ require 'time'
3115
+ require 'klaviyo-api-sdk'
3116
+ # setup authorization
3117
+ KlaviyoAPI.configure do |config|
3118
+ # Configure API key authorization: Klaviyo-API-Key
3119
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3120
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3121
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3122
+ end
3123
+
3124
+ api_instance = KlaviyoAPI::CatalogsApi.new
3125
+ 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::CatalogCategoryCreateJobCreateQueryResourceObjectAttributesCategories.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'})})]})})})}) # CatalogCategoryCreateJobCreateQuery |
3126
+
3127
+ begin
3128
+ # Spawn Create Categories Job
3129
+ result = api_instance.spawn_create_categories_job(catalog_category_create_job_create_query)
3130
+ p result
3131
+ rescue KlaviyoAPI::ApiError => e
3132
+ puts "Error when calling CatalogsApi->spawn_create_categories_job: #{e}"
3133
+ end
3134
+ ```
3135
+
3136
+ #### Using the spawn_create_categories_job_with_http_info variant
3137
+
3138
+ This returns an Array which contains the response data, status code and headers.
3139
+
3140
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_create_categories_job_with_http_info(catalog_category_create_job_create_query)
3141
+
3142
+ ```ruby
3143
+ begin
3144
+ # Spawn Create Categories Job
3145
+ data, status_code, headers = api_instance.spawn_create_categories_job_with_http_info(catalog_category_create_job_create_query)
3146
+ p status_code # => 2xx
3147
+ p headers # => { ... }
3148
+ p data # => Hash&lt;String, Object&gt;
3149
+ rescue KlaviyoAPI::ApiError => e
3150
+ puts "Error when calling CatalogsApi->spawn_create_categories_job_with_http_info: #{e}"
3151
+ end
3152
+ ```
3153
+
3154
+ ### Parameters
3155
+
3156
+ | Name | Type | Description | Notes |
3157
+ | ---- | ---- | ----------- | ----- |
3158
+ | **catalog_category_create_job_create_query** | [**CatalogCategoryCreateJobCreateQuery**](CatalogCategoryCreateJobCreateQuery.md) | | |
3159
+
3160
+ ### Return type
3161
+
3162
+ **Hash&lt;String, Object&gt;**
3163
+
3164
+ ### Authorization
3165
+
3166
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3167
+
3168
+ ### HTTP request headers
3169
+
3170
+ - **Content-Type**: application/json
3171
+ - **Accept**: application/json
3172
+
3173
+
3174
+ ## spawn_create_items_job
3175
+
3176
+ > Hash&lt;String, Object&gt; spawn_create_items_job(catalog_item_create_job_create_query)
3177
+
3178
+ Spawn Create Items Job
3179
+
3180
+ 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`
3181
+
3182
+ ### Examples
3183
+
3184
+ ```ruby
3185
+ require 'time'
3186
+ require 'klaviyo-api-sdk'
3187
+ # setup authorization
3188
+ KlaviyoAPI.configure do |config|
3189
+ # Configure API key authorization: Klaviyo-API-Key
3190
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3191
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3192
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3193
+ end
3194
+
3195
+ api_instance = KlaviyoAPI::CatalogsApi.new
3196
+ 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::CatalogItemCreateJobCreateQueryResourceObjectAttributesItems.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'})})]})})})}) # CatalogItemCreateJobCreateQuery |
3197
+
3198
+ begin
3199
+ # Spawn Create Items Job
3200
+ result = api_instance.spawn_create_items_job(catalog_item_create_job_create_query)
3201
+ p result
3202
+ rescue KlaviyoAPI::ApiError => e
3203
+ puts "Error when calling CatalogsApi->spawn_create_items_job: #{e}"
3204
+ end
3205
+ ```
3206
+
3207
+ #### Using the spawn_create_items_job_with_http_info variant
3208
+
3209
+ This returns an Array which contains the response data, status code and headers.
3210
+
3211
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_create_items_job_with_http_info(catalog_item_create_job_create_query)
3212
+
3213
+ ```ruby
3214
+ begin
3215
+ # Spawn Create Items Job
3216
+ data, status_code, headers = api_instance.spawn_create_items_job_with_http_info(catalog_item_create_job_create_query)
3217
+ p status_code # => 2xx
3218
+ p headers # => { ... }
3219
+ p data # => Hash&lt;String, Object&gt;
3220
+ rescue KlaviyoAPI::ApiError => e
3221
+ puts "Error when calling CatalogsApi->spawn_create_items_job_with_http_info: #{e}"
3222
+ end
3223
+ ```
3224
+
3225
+ ### Parameters
3226
+
3227
+ | Name | Type | Description | Notes |
3228
+ | ---- | ---- | ----------- | ----- |
3229
+ | **catalog_item_create_job_create_query** | [**CatalogItemCreateJobCreateQuery**](CatalogItemCreateJobCreateQuery.md) | | |
3230
+
3231
+ ### Return type
3232
+
3233
+ **Hash&lt;String, Object&gt;**
3234
+
3235
+ ### Authorization
3236
+
3237
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3238
+
3239
+ ### HTTP request headers
3240
+
3241
+ - **Content-Type**: application/json
3242
+ - **Accept**: application/json
3243
+
3244
+
3245
+ ## spawn_create_variants_job
3246
+
3247
+ > Hash&lt;String, Object&gt; spawn_create_variants_job(catalog_variant_create_job_create_query)
3248
+
3249
+ Spawn Create Variants Job
3250
+
3251
+ 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`
3252
+
3253
+ ### Examples
3254
+
3255
+ ```ruby
3256
+ require 'time'
3257
+ require 'klaviyo-api-sdk'
3258
+ # setup authorization
3259
+ KlaviyoAPI.configure do |config|
3260
+ # Configure API key authorization: Klaviyo-API-Key
3261
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3262
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3263
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3264
+ end
3265
+
3266
+ api_instance = KlaviyoAPI::CatalogsApi.new
3267
+ 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::CatalogVariantCreateJobCreateQueryResourceObjectAttributesVariants.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'})})]})})})}) # CatalogVariantCreateJobCreateQuery |
3268
+
3269
+ begin
3270
+ # Spawn Create Variants Job
3271
+ result = api_instance.spawn_create_variants_job(catalog_variant_create_job_create_query)
3272
+ p result
3273
+ rescue KlaviyoAPI::ApiError => e
3274
+ puts "Error when calling CatalogsApi->spawn_create_variants_job: #{e}"
3275
+ end
3276
+ ```
3277
+
3278
+ #### Using the spawn_create_variants_job_with_http_info variant
3279
+
3280
+ This returns an Array which contains the response data, status code and headers.
3281
+
3282
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_query)
3283
+
3284
+ ```ruby
3285
+ begin
3286
+ # Spawn Create Variants Job
3287
+ data, status_code, headers = api_instance.spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_query)
3288
+ p status_code # => 2xx
3289
+ p headers # => { ... }
3290
+ p data # => Hash&lt;String, Object&gt;
3291
+ rescue KlaviyoAPI::ApiError => e
3292
+ puts "Error when calling CatalogsApi->spawn_create_variants_job_with_http_info: #{e}"
3293
+ end
3294
+ ```
3295
+
3296
+ ### Parameters
3297
+
3298
+ | Name | Type | Description | Notes |
3299
+ | ---- | ---- | ----------- | ----- |
3300
+ | **catalog_variant_create_job_create_query** | [**CatalogVariantCreateJobCreateQuery**](CatalogVariantCreateJobCreateQuery.md) | | |
3301
+
3302
+ ### Return type
3303
+
3304
+ **Hash&lt;String, Object&gt;**
3305
+
3306
+ ### Authorization
3307
+
3308
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3309
+
3310
+ ### HTTP request headers
3311
+
3312
+ - **Content-Type**: application/json
3313
+ - **Accept**: application/json
3314
+
3315
+
3316
+ ## spawn_delete_categories_job
3317
+
3318
+ > Hash&lt;String, Object&gt; spawn_delete_categories_job(catalog_category_delete_job_create_query)
3319
+
3320
+ Spawn Delete Categories Job
3321
+
3322
+ 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`
3323
+
3324
+ ### Examples
3325
+
3326
+ ```ruby
3327
+ require 'time'
3328
+ require 'klaviyo-api-sdk'
3329
+ # setup authorization
3330
+ KlaviyoAPI.configure do |config|
3331
+ # Configure API key authorization: Klaviyo-API-Key
3332
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3333
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3334
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3335
+ end
3336
+
3337
+ api_instance = KlaviyoAPI::CatalogsApi.new
3338
+ 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::CatalogCategoryDeleteJobCreateQueryResourceObjectAttributesCategories.new({data: [KlaviyoAPI::CatalogCategoryDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'})]})})})}) # CatalogCategoryDeleteJobCreateQuery |
3339
+
3340
+ begin
3341
+ # Spawn Delete Categories Job
3342
+ result = api_instance.spawn_delete_categories_job(catalog_category_delete_job_create_query)
3343
+ p result
3344
+ rescue KlaviyoAPI::ApiError => e
3345
+ puts "Error when calling CatalogsApi->spawn_delete_categories_job: #{e}"
3346
+ end
3347
+ ```
3348
+
3349
+ #### Using the spawn_delete_categories_job_with_http_info variant
3350
+
3351
+ This returns an Array which contains the response data, status code and headers.
3352
+
3353
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_delete_categories_job_with_http_info(catalog_category_delete_job_create_query)
3354
+
3355
+ ```ruby
3356
+ begin
3357
+ # Spawn Delete Categories Job
3358
+ data, status_code, headers = api_instance.spawn_delete_categories_job_with_http_info(catalog_category_delete_job_create_query)
3359
+ p status_code # => 2xx
3360
+ p headers # => { ... }
3361
+ p data # => Hash&lt;String, Object&gt;
3362
+ rescue KlaviyoAPI::ApiError => e
3363
+ puts "Error when calling CatalogsApi->spawn_delete_categories_job_with_http_info: #{e}"
3364
+ end
3365
+ ```
3366
+
3367
+ ### Parameters
3368
+
3369
+ | Name | Type | Description | Notes |
3370
+ | ---- | ---- | ----------- | ----- |
3371
+ | **catalog_category_delete_job_create_query** | [**CatalogCategoryDeleteJobCreateQuery**](CatalogCategoryDeleteJobCreateQuery.md) | | |
3372
+
3373
+ ### Return type
3374
+
3375
+ **Hash&lt;String, Object&gt;**
3376
+
3377
+ ### Authorization
3378
+
3379
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3380
+
3381
+ ### HTTP request headers
3382
+
3383
+ - **Content-Type**: application/json
3384
+ - **Accept**: application/json
3385
+
3386
+
3387
+ ## spawn_delete_items_job
3388
+
3389
+ > Hash&lt;String, Object&gt; spawn_delete_items_job(catalog_item_delete_job_create_query)
3390
+
3391
+ Spawn Delete Items Job
3392
+
3393
+ 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`
3394
+
3395
+ ### Examples
3396
+
3397
+ ```ruby
3398
+ require 'time'
3399
+ require 'klaviyo-api-sdk'
3400
+ # setup authorization
3401
+ KlaviyoAPI.configure do |config|
3402
+ # Configure API key authorization: Klaviyo-API-Key
3403
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3404
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3405
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3406
+ end
3407
+
3408
+ api_instance = KlaviyoAPI::CatalogsApi.new
3409
+ 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::CatalogItemDeleteJobCreateQueryResourceObjectAttributesItems.new({data: [KlaviyoAPI::CatalogItemDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1'})]})})})}) # CatalogItemDeleteJobCreateQuery |
3410
+
3411
+ begin
3412
+ # Spawn Delete Items Job
3413
+ result = api_instance.spawn_delete_items_job(catalog_item_delete_job_create_query)
3414
+ p result
3415
+ rescue KlaviyoAPI::ApiError => e
3416
+ puts "Error when calling CatalogsApi->spawn_delete_items_job: #{e}"
3417
+ end
3418
+ ```
3419
+
3420
+ #### Using the spawn_delete_items_job_with_http_info variant
3421
+
3422
+ This returns an Array which contains the response data, status code and headers.
3423
+
3424
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query)
3425
+
3426
+ ```ruby
3427
+ begin
3428
+ # Spawn Delete Items Job
3429
+ data, status_code, headers = api_instance.spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query)
3430
+ p status_code # => 2xx
3431
+ p headers # => { ... }
3432
+ p data # => Hash&lt;String, Object&gt;
3433
+ rescue KlaviyoAPI::ApiError => e
3434
+ puts "Error when calling CatalogsApi->spawn_delete_items_job_with_http_info: #{e}"
3435
+ end
3436
+ ```
3437
+
3438
+ ### Parameters
3439
+
3440
+ | Name | Type | Description | Notes |
3441
+ | ---- | ---- | ----------- | ----- |
3442
+ | **catalog_item_delete_job_create_query** | [**CatalogItemDeleteJobCreateQuery**](CatalogItemDeleteJobCreateQuery.md) | | |
3443
+
3444
+ ### Return type
3445
+
3446
+ **Hash&lt;String, Object&gt;**
3447
+
3448
+ ### Authorization
3449
+
3450
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3451
+
3452
+ ### HTTP request headers
3453
+
3454
+ - **Content-Type**: application/json
3455
+ - **Accept**: application/json
3456
+
3457
+
3458
+ ## spawn_delete_variants_job
3459
+
3460
+ > Hash&lt;String, Object&gt; spawn_delete_variants_job(catalog_variant_delete_job_create_query)
3461
+
3462
+ Spawn Delete Variants Job
3463
+
3464
+ 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`
3465
+
3466
+ ### Examples
3467
+
3468
+ ```ruby
3469
+ require 'time'
3470
+ require 'klaviyo-api-sdk'
3471
+ # setup authorization
3472
+ KlaviyoAPI.configure do |config|
3473
+ # Configure API key authorization: Klaviyo-API-Key
3474
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3475
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3476
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3477
+ end
3478
+
3479
+ api_instance = KlaviyoAPI::CatalogsApi.new
3480
+ 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::CatalogVariantDeleteJobCreateQueryResourceObjectAttributesVariants.new({data: [KlaviyoAPI::CatalogVariantDeleteQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'})]})})})}) # CatalogVariantDeleteJobCreateQuery |
3481
+
3482
+ begin
3483
+ # Spawn Delete Variants Job
3484
+ result = api_instance.spawn_delete_variants_job(catalog_variant_delete_job_create_query)
3485
+ p result
3486
+ rescue KlaviyoAPI::ApiError => e
3487
+ puts "Error when calling CatalogsApi->spawn_delete_variants_job: #{e}"
3488
+ end
3489
+ ```
3490
+
3491
+ #### Using the spawn_delete_variants_job_with_http_info variant
3492
+
3493
+ This returns an Array which contains the response data, status code and headers.
3494
+
3495
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_query)
3496
+
3497
+ ```ruby
3498
+ begin
3499
+ # Spawn Delete Variants Job
3500
+ data, status_code, headers = api_instance.spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_query)
3501
+ p status_code # => 2xx
3502
+ p headers # => { ... }
3503
+ p data # => Hash&lt;String, Object&gt;
3504
+ rescue KlaviyoAPI::ApiError => e
3505
+ puts "Error when calling CatalogsApi->spawn_delete_variants_job_with_http_info: #{e}"
3506
+ end
3507
+ ```
3508
+
3509
+ ### Parameters
3510
+
3511
+ | Name | Type | Description | Notes |
3512
+ | ---- | ---- | ----------- | ----- |
3513
+ | **catalog_variant_delete_job_create_query** | [**CatalogVariantDeleteJobCreateQuery**](CatalogVariantDeleteJobCreateQuery.md) | | |
3514
+
3515
+ ### Return type
3516
+
3517
+ **Hash&lt;String, Object&gt;**
3518
+
3519
+ ### Authorization
3520
+
3521
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3522
+
3523
+ ### HTTP request headers
3524
+
3525
+ - **Content-Type**: application/json
3526
+ - **Accept**: application/json
3527
+
3528
+
3529
+ ## spawn_update_categories_job
3530
+
3531
+ > Hash&lt;String, Object&gt; spawn_update_categories_job(catalog_category_update_job_create_query)
3532
+
3533
+ Spawn Update Categories Job
3534
+
3535
+ 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`
3536
+
3537
+ ### Examples
3538
+
3539
+ ```ruby
3540
+ require 'time'
3541
+ require 'klaviyo-api-sdk'
3542
+ # setup authorization
3543
+ KlaviyoAPI.configure do |config|
3544
+ # Configure API key authorization: Klaviyo-API-Key
3545
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3546
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3547
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3548
+ end
3549
+
3550
+ api_instance = KlaviyoAPI::CatalogsApi.new
3551
+ 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::CatalogCategoryUpdateJobCreateQueryResourceObjectAttributesCategories.new({data: [KlaviyoAPI::CatalogCategoryUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL', attributes: KlaviyoAPI::CatalogCategoryUpdateQueryResourceObjectAttributes.new})]})})})}) # CatalogCategoryUpdateJobCreateQuery |
3552
+
3553
+ begin
3554
+ # Spawn Update Categories Job
3555
+ result = api_instance.spawn_update_categories_job(catalog_category_update_job_create_query)
3556
+ p result
3557
+ rescue KlaviyoAPI::ApiError => e
3558
+ puts "Error when calling CatalogsApi->spawn_update_categories_job: #{e}"
3559
+ end
3560
+ ```
3561
+
3562
+ #### Using the spawn_update_categories_job_with_http_info variant
3563
+
3564
+ This returns an Array which contains the response data, status code and headers.
3565
+
3566
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_update_categories_job_with_http_info(catalog_category_update_job_create_query)
3567
+
3568
+ ```ruby
3569
+ begin
3570
+ # Spawn Update Categories Job
3571
+ data, status_code, headers = api_instance.spawn_update_categories_job_with_http_info(catalog_category_update_job_create_query)
3572
+ p status_code # => 2xx
3573
+ p headers # => { ... }
3574
+ p data # => Hash&lt;String, Object&gt;
3575
+ rescue KlaviyoAPI::ApiError => e
3576
+ puts "Error when calling CatalogsApi->spawn_update_categories_job_with_http_info: #{e}"
3577
+ end
3578
+ ```
3579
+
3580
+ ### Parameters
3581
+
3582
+ | Name | Type | Description | Notes |
3583
+ | ---- | ---- | ----------- | ----- |
3584
+ | **catalog_category_update_job_create_query** | [**CatalogCategoryUpdateJobCreateQuery**](CatalogCategoryUpdateJobCreateQuery.md) | | |
3585
+
3586
+ ### Return type
3587
+
3588
+ **Hash&lt;String, Object&gt;**
3589
+
3590
+ ### Authorization
3591
+
3592
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3593
+
3594
+ ### HTTP request headers
3595
+
3596
+ - **Content-Type**: application/json
3597
+ - **Accept**: application/json
3598
+
3599
+
3600
+ ## spawn_update_items_job
3601
+
3602
+ > Hash&lt;String, Object&gt; spawn_update_items_job(catalog_item_update_job_create_query)
3603
+
3604
+ Spawn Update Items Job
3605
+
3606
+ 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`
3607
+
3608
+ ### Examples
3609
+
3610
+ ```ruby
3611
+ require 'time'
3612
+ require 'klaviyo-api-sdk'
3613
+ # setup authorization
3614
+ KlaviyoAPI.configure do |config|
3615
+ # Configure API key authorization: Klaviyo-API-Key
3616
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3617
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3618
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3619
+ end
3620
+
3621
+ api_instance = KlaviyoAPI::CatalogsApi.new
3622
+ 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::CatalogItemUpdateJobCreateQueryResourceObjectAttributesItems.new({data: [KlaviyoAPI::CatalogItemUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1', attributes: KlaviyoAPI::CatalogItemUpdateQueryResourceObjectAttributes.new})]})})})}) # CatalogItemUpdateJobCreateQuery |
3623
+
3624
+ begin
3625
+ # Spawn Update Items Job
3626
+ result = api_instance.spawn_update_items_job(catalog_item_update_job_create_query)
3627
+ p result
3628
+ rescue KlaviyoAPI::ApiError => e
3629
+ puts "Error when calling CatalogsApi->spawn_update_items_job: #{e}"
3630
+ end
3631
+ ```
3632
+
3633
+ #### Using the spawn_update_items_job_with_http_info variant
3634
+
3635
+ This returns an Array which contains the response data, status code and headers.
3636
+
3637
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_update_items_job_with_http_info(catalog_item_update_job_create_query)
3638
+
3639
+ ```ruby
3640
+ begin
3641
+ # Spawn Update Items Job
3642
+ data, status_code, headers = api_instance.spawn_update_items_job_with_http_info(catalog_item_update_job_create_query)
3643
+ p status_code # => 2xx
3644
+ p headers # => { ... }
3645
+ p data # => Hash&lt;String, Object&gt;
3646
+ rescue KlaviyoAPI::ApiError => e
3647
+ puts "Error when calling CatalogsApi->spawn_update_items_job_with_http_info: #{e}"
3648
+ end
3649
+ ```
3650
+
3651
+ ### Parameters
3652
+
3653
+ | Name | Type | Description | Notes |
3654
+ | ---- | ---- | ----------- | ----- |
3655
+ | **catalog_item_update_job_create_query** | [**CatalogItemUpdateJobCreateQuery**](CatalogItemUpdateJobCreateQuery.md) | | |
3656
+
3657
+ ### Return type
3658
+
3659
+ **Hash&lt;String, Object&gt;**
3660
+
3661
+ ### Authorization
3662
+
3663
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3664
+
3665
+ ### HTTP request headers
3666
+
3667
+ - **Content-Type**: application/json
3668
+ - **Accept**: application/json
3669
+
3670
+
3671
+ ## spawn_update_variants_job
3672
+
3673
+ > Hash&lt;String, Object&gt; spawn_update_variants_job(catalog_variant_update_job_create_query)
3674
+
3675
+ Spawn Update Variants Job
3676
+
3677
+ 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`
3678
+
3679
+ ### Examples
3680
+
3681
+ ```ruby
3682
+ require 'time'
3683
+ require 'klaviyo-api-sdk'
3684
+ # setup authorization
3685
+ KlaviyoAPI.configure do |config|
3686
+ # Configure API key authorization: Klaviyo-API-Key
3687
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3688
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3689
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3690
+ end
3691
+
3692
+ api_instance = KlaviyoAPI::CatalogsApi.new
3693
+ 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::CatalogVariantUpdateJobCreateQueryResourceObjectAttributesVariants.new({data: [KlaviyoAPI::CatalogVariantUpdateQueryResourceObject.new({type: KlaviyoAPI::CatalogVariantEnum::CATALOG_VARIANT, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM', attributes: KlaviyoAPI::CatalogVariantUpdateQueryResourceObjectAttributes.new})]})})})}) # CatalogVariantUpdateJobCreateQuery |
3694
+
3695
+ begin
3696
+ # Spawn Update Variants Job
3697
+ result = api_instance.spawn_update_variants_job(catalog_variant_update_job_create_query)
3698
+ p result
3699
+ rescue KlaviyoAPI::ApiError => e
3700
+ puts "Error when calling CatalogsApi->spawn_update_variants_job: #{e}"
3701
+ end
3702
+ ```
3703
+
3704
+ #### Using the spawn_update_variants_job_with_http_info variant
3705
+
3706
+ This returns an Array which contains the response data, status code and headers.
3707
+
3708
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_query)
3709
+
3710
+ ```ruby
3711
+ begin
3712
+ # Spawn Update Variants Job
3713
+ data, status_code, headers = api_instance.spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_query)
3714
+ p status_code # => 2xx
3715
+ p headers # => { ... }
3716
+ p data # => Hash&lt;String, Object&gt;
3717
+ rescue KlaviyoAPI::ApiError => e
3718
+ puts "Error when calling CatalogsApi->spawn_update_variants_job_with_http_info: #{e}"
3719
+ end
3720
+ ```
3721
+
3722
+ ### Parameters
3723
+
3724
+ | Name | Type | Description | Notes |
3725
+ | ---- | ---- | ----------- | ----- |
3726
+ | **catalog_variant_update_job_create_query** | [**CatalogVariantUpdateJobCreateQuery**](CatalogVariantUpdateJobCreateQuery.md) | | |
3727
+
3728
+ ### Return type
3729
+
3730
+ **Hash&lt;String, Object&gt;**
3731
+
3732
+ ### Authorization
3733
+
3734
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3735
+
3736
+ ### HTTP request headers
3737
+
3738
+ - **Content-Type**: application/json
3739
+ - **Accept**: application/json
3740
+
3741
+
3742
+ ## update_catalog_category
3743
+
3744
+ > Hash&lt;String, Object&gt; update_catalog_category(id, catalog_category_update_query)
3745
+
3746
+ Update Catalog Category
3747
+
3748
+ Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
3749
+
3750
+ ### Examples
3751
+
3752
+ ```ruby
3753
+ require 'time'
3754
+ require 'klaviyo-api-sdk'
3755
+ # setup authorization
3756
+ KlaviyoAPI.configure do |config|
3757
+ # Configure API key authorization: Klaviyo-API-Key
3758
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3759
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3760
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3761
+ end
3762
+
3763
+ api_instance = KlaviyoAPI::CatalogsApi.new
3764
+ 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`.
3765
+ 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 |
3766
+
3767
+ begin
3768
+ # Update Catalog Category
3769
+ result = api_instance.update_catalog_category(id, catalog_category_update_query)
3770
+ p result
3771
+ rescue KlaviyoAPI::ApiError => e
3772
+ puts "Error when calling CatalogsApi->update_catalog_category: #{e}"
3773
+ end
3774
+ ```
3775
+
3776
+ #### Using the update_catalog_category_with_http_info variant
3777
+
3778
+ This returns an Array which contains the response data, status code and headers.
3779
+
3780
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_catalog_category_with_http_info(id, catalog_category_update_query)
3781
+
3782
+ ```ruby
3783
+ begin
3784
+ # Update Catalog Category
3785
+ data, status_code, headers = api_instance.update_catalog_category_with_http_info(id, catalog_category_update_query)
3786
+ p status_code # => 2xx
3787
+ p headers # => { ... }
3788
+ p data # => Hash&lt;String, Object&gt;
3789
+ rescue KlaviyoAPI::ApiError => e
3790
+ puts "Error when calling CatalogsApi->update_catalog_category_with_http_info: #{e}"
3791
+ end
3792
+ ```
3793
+
3794
+ ### Parameters
3795
+
3796
+ | Name | Type | Description | Notes |
3797
+ | ---- | ---- | ----------- | ----- |
3798
+ | **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;. | |
3799
+ | **catalog_category_update_query** | [**CatalogCategoryUpdateQuery**](CatalogCategoryUpdateQuery.md) | | |
3800
+
3801
+ ### Return type
3802
+
3803
+ **Hash&lt;String, Object&gt;**
3804
+
3805
+ ### Authorization
3806
+
3807
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3808
+
3809
+ ### HTTP request headers
3810
+
3811
+ - **Content-Type**: application/json
3812
+ - **Accept**: application/json
3813
+
3814
+
3815
+ ## update_catalog_category_relationships_items
3816
+
3817
+ > update_catalog_category_relationships_items(id, catalog_category_item_op)
3818
+
3819
+ Update Catalog Category Relationships Items
3820
+
3821
+ Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
3822
+
3823
+ ### Examples
3824
+
3825
+ ```ruby
3826
+ require 'time'
3827
+ require 'klaviyo-api-sdk'
3828
+ # setup authorization
3829
+ KlaviyoAPI.configure do |config|
3830
+ # Configure API key authorization: Klaviyo-API-Key
3831
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3832
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3833
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3834
+ end
3835
+
3836
+ api_instance = KlaviyoAPI::CatalogsApi.new
3837
+ id = 'id_example' # String |
3838
+ catalog_category_item_op = KlaviyoAPI::CatalogCategoryItemOp.new({data: [KlaviyoAPI::CatalogVariantCreateQueryResourceObjectRelationshipsItemData.new({type: KlaviyoAPI::CatalogItemEnum::CATALOG_ITEM, id: '$custom:::$default:::SAMPLE-DATA-ITEM-1'})]}) # CatalogCategoryItemOp |
3839
+
3840
+ begin
3841
+ # Update Catalog Category Relationships Items
3842
+ api_instance.update_catalog_category_relationships_items(id, catalog_category_item_op)
3843
+ rescue KlaviyoAPI::ApiError => e
3844
+ puts "Error when calling CatalogsApi->update_catalog_category_relationships_items: #{e}"
3845
+ end
3846
+ ```
3847
+
3848
+ #### Using the update_catalog_category_relationships_items_with_http_info variant
3849
+
3850
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
3851
+
3852
+ > <Array(nil, Integer, Hash)> update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
3853
+
3854
+ ```ruby
3855
+ begin
3856
+ # Update Catalog Category Relationships Items
3857
+ data, status_code, headers = api_instance.update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op)
3858
+ p status_code # => 2xx
3859
+ p headers # => { ... }
3860
+ p data # => nil
3861
+ rescue KlaviyoAPI::ApiError => e
3862
+ puts "Error when calling CatalogsApi->update_catalog_category_relationships_items_with_http_info: #{e}"
3863
+ end
3864
+ ```
3865
+
3866
+ ### Parameters
3867
+
3868
+ | Name | Type | Description | Notes |
3869
+ | ---- | ---- | ----------- | ----- |
3870
+ | **id** | **String** | | |
3871
+ | **catalog_category_item_op** | [**CatalogCategoryItemOp**](CatalogCategoryItemOp.md) | | |
3872
+
3873
+ ### Return type
3874
+
3875
+ nil (empty response body)
3876
+
3877
+ ### Authorization
3878
+
3879
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3880
+
3881
+ ### HTTP request headers
3882
+
3883
+ - **Content-Type**: application/json
3884
+ - **Accept**: application/json
3885
+
3886
+
3887
+ ## update_catalog_item
3888
+
3889
+ > Hash&lt;String, Object&gt; update_catalog_item(id, catalog_item_update_query)
3890
+
3891
+ Update Catalog Item
3892
+
3893
+ Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
3894
+
3895
+ ### Examples
3896
+
3897
+ ```ruby
3898
+ require 'time'
3899
+ require 'klaviyo-api-sdk'
3900
+ # setup authorization
3901
+ KlaviyoAPI.configure do |config|
3902
+ # Configure API key authorization: Klaviyo-API-Key
3903
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3904
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3905
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3906
+ end
3907
+
3908
+ api_instance = KlaviyoAPI::CatalogsApi.new
3909
+ 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`.
3910
+ 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 |
3911
+
3912
+ begin
3913
+ # Update Catalog Item
3914
+ result = api_instance.update_catalog_item(id, catalog_item_update_query)
3915
+ p result
3916
+ rescue KlaviyoAPI::ApiError => e
3917
+ puts "Error when calling CatalogsApi->update_catalog_item: #{e}"
3918
+ end
3919
+ ```
3920
+
3921
+ #### Using the update_catalog_item_with_http_info variant
3922
+
3923
+ This returns an Array which contains the response data, status code and headers.
3924
+
3925
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_catalog_item_with_http_info(id, catalog_item_update_query)
3926
+
3927
+ ```ruby
3928
+ begin
3929
+ # Update Catalog Item
3930
+ data, status_code, headers = api_instance.update_catalog_item_with_http_info(id, catalog_item_update_query)
3931
+ p status_code # => 2xx
3932
+ p headers # => { ... }
3933
+ p data # => Hash&lt;String, Object&gt;
3934
+ rescue KlaviyoAPI::ApiError => e
3935
+ puts "Error when calling CatalogsApi->update_catalog_item_with_http_info: #{e}"
3936
+ end
3937
+ ```
3938
+
3939
+ ### Parameters
3940
+
3941
+ | Name | Type | Description | Notes |
3942
+ | ---- | ---- | ----------- | ----- |
3943
+ | **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;. | |
3944
+ | **catalog_item_update_query** | [**CatalogItemUpdateQuery**](CatalogItemUpdateQuery.md) | | |
3945
+
3946
+ ### Return type
3947
+
3948
+ **Hash&lt;String, Object&gt;**
3949
+
3950
+ ### Authorization
3951
+
3952
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
3953
+
3954
+ ### HTTP request headers
3955
+
3956
+ - **Content-Type**: application/json
3957
+ - **Accept**: application/json
3958
+
3959
+
3960
+ ## update_catalog_item_relationships_categories
3961
+
3962
+ > update_catalog_item_relationships_categories(id, catalog_item_category_op)
3963
+
3964
+ Update Catalog Item Relationships Categories
3965
+
3966
+ Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
3967
+
3968
+ ### Examples
3969
+
3970
+ ```ruby
3971
+ require 'time'
3972
+ require 'klaviyo-api-sdk'
3973
+ # setup authorization
3974
+ KlaviyoAPI.configure do |config|
3975
+ # Configure API key authorization: Klaviyo-API-Key
3976
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
3977
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3978
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
3979
+ end
3980
+
3981
+ api_instance = KlaviyoAPI::CatalogsApi.new
3982
+ id = 'id_example' # String |
3983
+ catalog_item_category_op = KlaviyoAPI::CatalogItemCategoryOp.new({data: [KlaviyoAPI::CatalogItemCreateQueryResourceObjectRelationshipsCategoriesDataInner.new({type: KlaviyoAPI::CatalogCategoryEnum::CATALOG_CATEGORY, id: '$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'})]}) # CatalogItemCategoryOp |
3984
+
3985
+ begin
3986
+ # Update Catalog Item Relationships Categories
3987
+ api_instance.update_catalog_item_relationships_categories(id, catalog_item_category_op)
3988
+ rescue KlaviyoAPI::ApiError => e
3989
+ puts "Error when calling CatalogsApi->update_catalog_item_relationships_categories: #{e}"
3990
+ end
3991
+ ```
3992
+
3993
+ #### Using the update_catalog_item_relationships_categories_with_http_info variant
3994
+
3995
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
3996
+
3997
+ > <Array(nil, Integer, Hash)> update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
3998
+
3999
+ ```ruby
4000
+ begin
4001
+ # Update Catalog Item Relationships Categories
4002
+ data, status_code, headers = api_instance.update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op)
4003
+ p status_code # => 2xx
4004
+ p headers # => { ... }
4005
+ p data # => nil
4006
+ rescue KlaviyoAPI::ApiError => e
4007
+ puts "Error when calling CatalogsApi->update_catalog_item_relationships_categories_with_http_info: #{e}"
4008
+ end
4009
+ ```
4010
+
4011
+ ### Parameters
4012
+
4013
+ | Name | Type | Description | Notes |
4014
+ | ---- | ---- | ----------- | ----- |
4015
+ | **id** | **String** | | |
4016
+ | **catalog_item_category_op** | [**CatalogItemCategoryOp**](CatalogItemCategoryOp.md) | | |
4017
+
4018
+ ### Return type
4019
+
4020
+ nil (empty response body)
4021
+
4022
+ ### Authorization
4023
+
4024
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
4025
+
4026
+ ### HTTP request headers
4027
+
4028
+ - **Content-Type**: application/json
4029
+ - **Accept**: application/json
4030
+
4031
+
4032
+ ## update_catalog_variant
4033
+
4034
+ > Hash&lt;String, Object&gt; update_catalog_variant(id, catalog_variant_update_query)
4035
+
4036
+ Update Catalog Variant
4037
+
4038
+ Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
4039
+
4040
+ ### Examples
4041
+
4042
+ ```ruby
4043
+ require 'time'
4044
+ require 'klaviyo-api-sdk'
4045
+ # setup authorization
4046
+ KlaviyoAPI.configure do |config|
4047
+ # Configure API key authorization: Klaviyo-API-Key
4048
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
4049
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4050
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
4051
+ end
4052
+
4053
+ api_instance = KlaviyoAPI::CatalogsApi.new
4054
+ 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`.
4055
+ 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 |
4056
+
4057
+ begin
4058
+ # Update Catalog Variant
4059
+ result = api_instance.update_catalog_variant(id, catalog_variant_update_query)
4060
+ p result
4061
+ rescue KlaviyoAPI::ApiError => e
4062
+ puts "Error when calling CatalogsApi->update_catalog_variant: #{e}"
4063
+ end
4064
+ ```
4065
+
4066
+ #### Using the update_catalog_variant_with_http_info variant
4067
+
4068
+ This returns an Array which contains the response data, status code and headers.
4069
+
4070
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_catalog_variant_with_http_info(id, catalog_variant_update_query)
4071
+
4072
+ ```ruby
4073
+ begin
4074
+ # Update Catalog Variant
4075
+ data, status_code, headers = api_instance.update_catalog_variant_with_http_info(id, catalog_variant_update_query)
4076
+ p status_code # => 2xx
4077
+ p headers # => { ... }
4078
+ p data # => Hash&lt;String, Object&gt;
4079
+ rescue KlaviyoAPI::ApiError => e
4080
+ puts "Error when calling CatalogsApi->update_catalog_variant_with_http_info: #{e}"
4081
+ end
4082
+ ```
4083
+
4084
+ ### Parameters
4085
+
4086
+ | Name | Type | Description | Notes |
4087
+ | ---- | ---- | ----------- | ----- |
4088
+ | **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;. | |
4089
+ | **catalog_variant_update_query** | [**CatalogVariantUpdateQuery**](CatalogVariantUpdateQuery.md) | | |
4090
+
4091
+ ### Return type
4092
+
4093
+ **Hash&lt;String, Object&gt;**
4094
+
4095
+ ### Authorization
4096
+
4097
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
4098
+
4099
+ ### HTTP request headers
4100
+
4101
+ - **Content-Type**: application/json
4102
+ - **Accept**: application/json
4103
+