klaviyo-api-sdk 2.0.0 → 3.0.0

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