klaviyo-api-sdk 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (324) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/README.md +314 -136
  4. data/docs/CampaignRecipientEstimationJobCreateQuery.md +18 -0
  5. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +20 -0
  6. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +18 -0
  7. data/docs/CampaignTagOp.md +18 -0
  8. data/docs/CampaignTagOpDataInner.md +20 -0
  9. data/docs/CampaignsApi.md +1277 -0
  10. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  11. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +6 -6
  12. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  13. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +2 -2
  14. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  15. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +2 -2
  16. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +2 -2
  17. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  18. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +21 -19
  19. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  20. data/docs/CatalogItemDeleteQueryAsSubResource.md +2 -2
  21. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  22. data/docs/CatalogItemUpdateQueryAsSubResource.md +2 -2
  23. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +18 -16
  24. data/docs/CatalogJobErrorPayload.md +8 -8
  25. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +1 -1
  26. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +27 -27
  27. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +1 -1
  28. data/docs/CatalogVariantDeleteQueryAsSubResource.md +2 -2
  29. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +1 -1
  30. data/docs/CatalogVariantUpdateQueryAsSubResource.md +2 -2
  31. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +22 -22
  32. data/docs/CatalogsApi.md +238 -238
  33. data/docs/ErrorSource.md +1 -1
  34. data/docs/EventsApi.md +26 -26
  35. data/docs/FlowsApi.md +64 -56
  36. data/docs/GetCampaigns4XXResponse.md +18 -0
  37. data/docs/GetCampaigns4XXResponseErrorsInner.md +26 -0
  38. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +20 -0
  39. data/docs/IncludedCategories.md +2 -2
  40. data/docs/IncludedCategoriesAttributes.md +5 -5
  41. data/docs/IncludedItems.md +2 -2
  42. data/docs/IncludedItemsAttributes.md +22 -20
  43. data/docs/IncludedLists.md +2 -2
  44. data/docs/IncludedListsAttributes.md +4 -4
  45. data/docs/IncludedProfiles.md +2 -2
  46. data/docs/IncludedProfilesAttributes.md +21 -21
  47. data/docs/IncludedSegments.md +1 -1
  48. data/docs/IncludedSegmentsAttributes.md +22 -0
  49. data/docs/IncludedTags.md +24 -0
  50. data/docs/IncludedVariants.md +2 -2
  51. data/docs/IncludedVariantsAttributes.md +28 -28
  52. data/docs/ListCreateQueryAsSubResourceAttributes.md +2 -2
  53. data/docs/ListPartialUpdateQueryAsSubResource.md +2 -2
  54. data/docs/ListsApi.md +30 -30
  55. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +5 -5
  56. data/docs/MetricsApi.md +9 -9
  57. data/docs/OnsiteProfileMetaIdentifiers.md +10 -10
  58. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +18 -18
  59. data/docs/ProfileLocation.md +15 -15
  60. data/docs/ProfileLocationLongitude.md +49 -0
  61. data/docs/ProfilePartialUpdateQueryAsSubResource.md +2 -2
  62. data/docs/ProfilesApi.md +26 -26
  63. data/docs/STOScheduleOptions.md +18 -0
  64. data/docs/SegmentPartialUpdateQueryAsSubResource.md +1 -1
  65. data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +18 -0
  66. data/docs/SegmentsApi.md +19 -19
  67. data/docs/SendOptionsSubObject.md +1 -3
  68. data/docs/SendStrategySubObject.md +4 -2
  69. data/docs/Subscription.md +8 -4
  70. data/docs/SubscriptionChannels.md +20 -0
  71. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +2 -2
  72. data/docs/Suppression.md +1 -1
  73. data/docs/TagsApi.md +24 -24
  74. data/docs/TemplateCloneQueryAsSubResource.md +0 -2
  75. data/docs/TemplatesApi.md +11 -11
  76. data/docs/ThrottledScheduleOptions.md +1 -1
  77. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +3 -3
  78. data/klaviyo-api-sdk.gemspec +2 -2
  79. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +1275 -0
  80. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +299 -299
  81. data/lib/klaviyo-api-sdk/api/client_api.rb +3 -3
  82. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  83. data/lib/klaviyo-api-sdk/api/events_api.rb +33 -33
  84. data/lib/klaviyo-api-sdk/api/flows_api.rb +86 -74
  85. data/lib/klaviyo-api-sdk/api/lists_api.rb +39 -39
  86. data/lib/klaviyo-api-sdk/api/metrics_api.rb +14 -14
  87. data/lib/klaviyo-api-sdk/api/profiles_api.rb +34 -34
  88. data/lib/klaviyo-api-sdk/api/segments_api.rb +25 -25
  89. data/lib/klaviyo-api-sdk/api/tags_api.rb +41 -41
  90. data/lib/klaviyo-api-sdk/api/templates_api.rb +18 -18
  91. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  92. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  93. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  95. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource_attributes.rb +1 -1
  98. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource_attributes.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource_attributes.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource_attributes.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource_attributes.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +224 -0
  111. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +272 -0
  112. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb +225 -0
  113. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_as_sub_resource_attributes.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource_attributes.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/campaign_tag_op.rb +226 -0
  120. data/lib/klaviyo-api-sdk/models/campaign_tag_op_data_inner.rb +272 -0
  121. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource_attributes.rb +5 -2
  127. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +2 -2
  131. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +2 -2
  137. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource_attributes.rb +2 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_attributes.rb +23 -3
  145. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_as_sub_resource.rb +2 -2
  152. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +2 -2
  157. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource_attributes.rb +20 -2
  158. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +5 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource_attributes.rb +2 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_attributes.rb +16 -8
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb +2 -1
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +2 -2
  172. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource_attributes.rb +2 -1
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +2 -2
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource_attributes.rb +12 -2
  178. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/email_message_content.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/error_source.rb +2 -1
  185. data/lib/klaviyo-api-sdk/models/event_create_query.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/event_create_query_as_sub_resource_attributes.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource_attributes.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response.rb +226 -0
  192. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner.rb +275 -0
  193. data/lib/klaviyo-api-sdk/models/get_campaigns4_xx_response_errors_inner_source.rb +228 -0
  194. data/lib/klaviyo-api-sdk/models/included_categories.rb +2 -2
  195. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +4 -1
  196. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/included_flows.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/included_items.rb +2 -1
  206. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +23 -2
  207. data/lib/klaviyo-api-sdk/models/included_lists.rb +2 -1
  208. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +4 -1
  209. data/lib/klaviyo-api-sdk/models/included_metrics.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/included_profiles.rb +2 -1
  212. data/lib/klaviyo-api-sdk/models/included_profiles_attributes.rb +13 -1
  213. data/lib/klaviyo-api-sdk/models/included_segments.rb +2 -2
  214. data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +240 -0
  215. data/lib/klaviyo-api-sdk/models/included_tags.rb +301 -0
  216. data/lib/klaviyo-api-sdk/models/included_variants.rb +2 -1
  217. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +16 -2
  218. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/list_create_query_as_sub_resource_attributes.rb +2 -1
  222. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  223. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +2 -1
  227. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +1 -1
  229. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource_attributes.rb +17 -15
  230. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  235. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +16 -11
  236. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource_attributes.rb +10 -1
  242. data/lib/klaviyo-api-sdk/models/profile_location.rb +9 -2
  243. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +2 -1
  244. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +106 -0
  245. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +2 -1
  247. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +2 -2
  249. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource_attributes.rb +224 -0
  250. data/lib/klaviyo-api-sdk/models/send_options.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +5 -15
  252. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +15 -6
  253. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/sms_message_content.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +225 -0
  259. data/lib/klaviyo-api-sdk/models/subscription.rb +26 -5
  260. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +256 -0
  261. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/tag_create_query_as_sub_resource_attributes.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource_attributes.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  275. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource_attributes.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource_attributes.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +2 -13
  284. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource_attributes.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +1 -1
  287. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource_attributes.rb +1 -1
  288. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  289. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource_attributes.rb +1 -1
  291. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource_attributes.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  295. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource_attributes.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/utm_param_info.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  304. data/lib/klaviyo-api-sdk/version.rb +1 -1
  305. data/lib/klaviyo-api-sdk.rb +14 -5
  306. data/spec/api/campaigns_api_spec.rb +284 -0
  307. data/spec/api_client_spec.rb +1 -1
  308. data/spec/configuration_spec.rb +1 -1
  309. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +34 -0
  310. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +44 -0
  311. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +34 -0
  312. data/spec/models/campaign_tag_op_data_inner_spec.rb +44 -0
  313. data/spec/models/campaign_tag_op_spec.rb +34 -0
  314. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +40 -0
  315. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +58 -0
  316. data/spec/models/get_campaigns4_xx_response_spec.rb +34 -0
  317. data/spec/models/included_segments_attributes_spec.rb +46 -0
  318. data/spec/models/included_tags_spec.rb +56 -0
  319. data/spec/models/profile_location_longitude_spec.rb +31 -0
  320. data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +34 -0
  321. data/spec/models/sto_schedule_options_spec.rb +34 -0
  322. data/spec/models/subscription_channels_spec.rb +48 -0
  323. data/spec/spec_helper.rb +1 -1
  324. metadata +51 -6
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **categories** | [**Array<CatalogCategoryCreateQueryAsSubResource>**](CatalogCategoryCreateQueryAsSubResource.md) | | |
7
+ | **categories** | [**Array<CatalogCategoryCreateQueryAsSubResource>**](CatalogCategoryCreateQueryAsSubResource.md) | Array of catalog categories to create. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **external_id** | **String** | | |
8
- | **name** | **String** | | |
9
- | **integration_type** | **String** | The integration type. Currently, this can only be set to $custom (and defaults to $custom if not included in the payload). | [optional] |
10
- | **catalog_type** | **String** | | [optional][default to '$default'] |
7
+ | **external_id** | **String** | The ID of the catalog category in an external system. | |
8
+ | **name** | **String** | The name of the catalog category. | |
9
+ | **integration_type** | **String** | The integration type. Currently only \"$custom\" is supported. | [optional] |
10
+ | **catalog_type** | **String** | The type of catalog. Currently only \"$default\" is supported. | [optional][default to '$default'] |
11
11
 
12
12
  ## Example
13
13
 
@@ -15,8 +15,8 @@
15
15
  require 'klaviyo-api-sdk'
16
16
 
17
17
  instance = KlaviyoAPI::CatalogCategoryCreateQueryAsSubResourceAttributes.new(
18
- external_id: null,
19
- name: null,
18
+ external_id: SAMPLE-DATA-CATEGORY-APPAREL,
19
+ name: Sample Data Category Apparel,
20
20
  integration_type: null,
21
21
  catalog_type: $default
22
22
  )
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **categories** | [**Array<CatalogCategoryDeleteQueryAsSubResource>**](CatalogCategoryDeleteQueryAsSubResource.md) | | |
7
+ | **categories** | [**Array<CatalogCategoryDeleteQueryAsSubResource>**](CatalogCategoryDeleteQueryAsSubResource.md) | Array of catalog categories to delete. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
8
+ | **id** | **String** | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
9
9
 
10
10
  ## Example
11
11
 
@@ -14,7 +14,7 @@ require 'klaviyo-api-sdk'
14
14
 
15
15
  instance = KlaviyoAPI::CatalogCategoryDeleteQueryAsSubResource.new(
16
16
  type: null,
17
- id: null
17
+ id: $custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL
18
18
  )
19
19
  ```
20
20
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **categories** | [**Array<CatalogCategoryUpdateQueryAsSubResource>**](CatalogCategoryUpdateQueryAsSubResource.md) | | |
7
+ | **categories** | [**Array<CatalogCategoryUpdateQueryAsSubResource>**](CatalogCategoryUpdateQueryAsSubResource.md) | Array of catalog categories to update. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
8
+ | **id** | **String** | The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
9
9
  | **attributes** | [**CatalogCategoryUpdateQueryAsSubResourceAttributes**](CatalogCategoryUpdateQueryAsSubResourceAttributes.md) | | |
10
10
  | **relationships** | [**CatalogVariantCreateQueryAsSubResourceRelationships**](CatalogVariantCreateQueryAsSubResourceRelationships.md) | | [optional] |
11
11
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
16
16
 
17
17
  instance = KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResource.new(
18
18
  type: null,
19
- id: null,
19
+ id: $custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL,
20
20
  attributes: null,
21
21
  relationships: null
22
22
  )
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
7
+ | **name** | **String** | The name of the catalog category. | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -12,7 +12,7 @@
12
12
  require 'klaviyo-api-sdk'
13
13
 
14
14
  instance = KlaviyoAPI::CatalogCategoryUpdateQueryAsSubResourceAttributes.new(
15
- name: null
15
+ name: Sample Data Category Apparel
16
16
  )
17
17
  ```
18
18
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<CatalogItemCreateQueryAsSubResource>**](CatalogItemCreateQueryAsSubResource.md) | | |
7
+ | **items** | [**Array<CatalogItemCreateQueryAsSubResource>**](CatalogItemCreateQueryAsSubResource.md) | Array of catalog items to create. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -4,17 +4,18 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **external_id** | **String** | | |
8
- | **integration_type** | **String** | The integration type. Currently, this can only be set to $custom (and defaults to $custom if not included in the payload). | [optional] |
9
- | **title** | **String** | | |
10
- | **catalog_type** | **String** | | [optional][default to '$default'] |
11
- | **description** | **String** | | |
12
- | **url** | **String** | | |
13
- | **image_full_url** | **String** | | [optional] |
14
- | **image_thumbnail_url** | **String** | | [optional] |
15
- | **images** | **Array<String>** | | [optional] |
16
- | **custom_metadata** | **Object** | | [optional] |
17
- | **published** | **Boolean** | | [optional][default to true] |
7
+ | **external_id** | **String** | The ID of the catalog item in an external system. | |
8
+ | **integration_type** | **String** | The integration type. Currently only \"$custom\" is supported. | [optional] |
9
+ | **title** | **String** | The title of the catalog item. | |
10
+ | **price** | **Float** | This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant). | [optional] |
11
+ | **catalog_type** | **String** | The type of catalog. Currently only \"$default\" is supported. | [optional][default to '$default'] |
12
+ | **description** | **String** | A description of the catalog item. | |
13
+ | **url** | **String** | URL pointing to the location of the catalog item on your website. | |
14
+ | **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item. | [optional] |
15
+ | **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item | [optional] |
16
+ | **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item. | [optional] |
17
+ | **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb. | [optional] |
18
+ | **published** | **Boolean** | Boolean value indicating whether the catalog item is published. | [optional][default to true] |
18
19
 
19
20
  ## Example
20
21
 
@@ -22,16 +23,17 @@
22
23
  require 'klaviyo-api-sdk'
23
24
 
24
25
  instance = KlaviyoAPI::CatalogItemCreateQueryAsSubResourceAttributes.new(
25
- external_id: null,
26
+ external_id: SAMPLE-DATA-ITEM-1,
26
27
  integration_type: null,
27
- title: null,
28
+ title: Ocean Blue Shirt (Sample),
29
+ price: 42,
28
30
  catalog_type: $default,
29
- description: null,
30
- url: null,
31
- image_full_url: null,
32
- image_thumbnail_url: null,
33
- images: null,
34
- custom_metadata: null,
31
+ description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
32
+ url: https://via.placeholder.com/150,
33
+ image_full_url: https://via.placeholder.com/300,
34
+ image_thumbnail_url: https://via.placeholder.com/150,
35
+ images: ["https://via.placeholder.com/150"],
36
+ custom_metadata: {"Top Pick":true},
35
37
  published: true
36
38
  )
37
39
  ```
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<CatalogItemDeleteQueryAsSubResource>**](CatalogItemDeleteQueryAsSubResource.md) | | |
7
+ | **items** | [**Array<CatalogItemDeleteQueryAsSubResource>**](CatalogItemDeleteQueryAsSubResource.md) | Array of catalog items to delete. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
8
+ | **id** | **String** | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
9
9
 
10
10
  ## Example
11
11
 
@@ -14,7 +14,7 @@ require 'klaviyo-api-sdk'
14
14
 
15
15
  instance = KlaviyoAPI::CatalogItemDeleteQueryAsSubResource.new(
16
16
  type: null,
17
- id: null
17
+ id: $custom:::$default:::SAMPLE-DATA-ITEM-1
18
18
  )
19
19
  ```
20
20
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<CatalogItemUpdateQueryAsSubResource>**](CatalogItemUpdateQueryAsSubResource.md) | | |
7
+ | **items** | [**Array<CatalogItemUpdateQueryAsSubResource>**](CatalogItemUpdateQueryAsSubResource.md) | Array of catalog items to update. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
8
+ | **id** | **String** | The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
9
9
  | **attributes** | [**CatalogItemUpdateQueryAsSubResourceAttributes**](CatalogItemUpdateQueryAsSubResourceAttributes.md) | | |
10
10
  | **relationships** | [**CatalogItemCreateQueryAsSubResourceRelationships**](CatalogItemCreateQueryAsSubResourceRelationships.md) | | [optional] |
11
11
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
16
16
 
17
17
  instance = KlaviyoAPI::CatalogItemUpdateQueryAsSubResource.new(
18
18
  type: null,
19
- id: null,
19
+ id: $custom:::$default:::SAMPLE-DATA-ITEM-1,
20
20
  attributes: null,
21
21
  relationships: null
22
22
  )
@@ -4,14 +4,15 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **title** | **String** | | [optional] |
8
- | **description** | **String** | | [optional] |
9
- | **url** | **String** | | [optional] |
10
- | **image_full_url** | **String** | | [optional] |
11
- | **image_thumbnail_url** | **String** | | [optional] |
12
- | **images** | **Array<String>** | | [optional] |
13
- | **custom_metadata** | **Object** | | [optional] |
14
- | **published** | **Boolean** | | [optional] |
7
+ | **title** | **String** | The title of the catalog item. | [optional] |
8
+ | **price** | **Float** | This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant). | [optional] |
9
+ | **description** | **String** | A description of the catalog item. | [optional] |
10
+ | **url** | **String** | URL pointing to the location of the catalog item on your website. | [optional] |
11
+ | **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item. | [optional] |
12
+ | **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item | [optional] |
13
+ | **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item. | [optional] |
14
+ | **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb. | [optional] |
15
+ | **published** | **Boolean** | Boolean value indicating whether the catalog item is published. | [optional] |
15
16
 
16
17
  ## Example
17
18
 
@@ -19,14 +20,15 @@
19
20
  require 'klaviyo-api-sdk'
20
21
 
21
22
  instance = KlaviyoAPI::CatalogItemUpdateQueryAsSubResourceAttributes.new(
22
- title: null,
23
- description: null,
24
- url: null,
25
- image_full_url: null,
26
- image_thumbnail_url: null,
27
- images: null,
28
- custom_metadata: null,
29
- published: null
23
+ title: Ocean Blue Shirt (Sample),
24
+ price: 42,
25
+ description: A description of the catalog item.,
26
+ url: https://via.placeholder.com/150,
27
+ image_full_url: https://via.placeholder.com/300,
28
+ image_thumbnail_url: https://via.placeholder.com/150,
29
+ images: ["https://via.placeholder.com/150"],
30
+ custom_metadata: {"Top Pick":true},
31
+ published: true
30
32
  )
31
33
  ```
32
34
 
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
- | **code** | **String** | | |
9
- | **title** | **String** | | |
10
- | **detail** | **String** | | |
7
+ | **id** | **String** | Unique identifier for the error. | |
8
+ | **code** | **String** | A code for classifying the error type. | |
9
+ | **title** | **String** | A high-level message about the error. | |
10
+ | **detail** | **String** | Specific details about the error. | |
11
11
  | **source** | [**ErrorSource**](ErrorSource.md) | | |
12
12
 
13
13
  ## Example
@@ -16,10 +16,10 @@
16
16
  require 'klaviyo-api-sdk'
17
17
 
18
18
  instance = KlaviyoAPI::CatalogJobErrorPayload.new(
19
- id: null,
20
- code: null,
21
- title: null,
22
- detail: null,
19
+ id: e4eebb08-b055-4a6f-bb13-c8cb69c9eb94,
20
+ code: invalid,
21
+ title: Invalid input,
22
+ detail: The payload provided in the request is invalid.,
23
23
  source: null
24
24
  )
25
25
  ```
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **variants** | [**Array<CatalogVariantCreateQueryAsSubResource>**](CatalogVariantCreateQueryAsSubResource.md) | | |
7
+ | **variants** | [**Array<CatalogVariantCreateQueryAsSubResource>**](CatalogVariantCreateQueryAsSubResource.md) | Array of catalog variants to create. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -4,21 +4,21 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **external_id** | **String** | | |
8
- | **catalog_type** | **String** | | [optional][default to '$default'] |
9
- | **integration_type** | **String** | The integration type. Currently, this can only be set to $custom (and defaults to $custom if not included in the payload). | [optional] |
10
- | **title** | **String** | | |
11
- | **description** | **String** | | |
12
- | **sku** | **String** | | |
13
- | **inventory_policy** | **Integer** | A field that controls product visibility in product feeds/blocks. This field has two options: DENY (1): a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. CONTINUE (2): a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. UNKNOWN (0): the behavior will be the same as if it were set to 2 [Default] | |
14
- | **inventory_quantity** | **Float** | | |
15
- | **price** | **Float** | | |
16
- | **url** | **String** | | |
17
- | **image_full_url** | **String** | | [optional] |
18
- | **image_thumbnail_url** | **String** | | [optional] |
19
- | **images** | **Array<String>** | | [optional] |
20
- | **custom_metadata** | **Object** | | [optional] |
21
- | **published** | **Boolean** | | [optional][default to true] |
7
+ | **external_id** | **String** | The ID of the catalog item variant in an external system. | |
8
+ | **catalog_type** | **String** | The type of catalog. Currently only \"$default\" is supported. | [optional][default to '$default'] |
9
+ | **integration_type** | **String** | The integration type. Currently only \"$custom\" is supported. | [optional] |
10
+ | **title** | **String** | The title of the catalog item variant. | |
11
+ | **description** | **String** | A description of the catalog item variant. | |
12
+ | **sku** | **String** | The SKU of the catalog item variant. | |
13
+ | **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional] |
14
+ | **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. | |
15
+ | **price** | **Float** | This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). | |
16
+ | **url** | **String** | URL pointing to the location of the catalog item variant on your website. | |
17
+ | **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item variant. | [optional] |
18
+ | **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item variant. | [optional] |
19
+ | **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item variant. | [optional] |
20
+ | **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. | [optional] |
21
+ | **published** | **Boolean** | Boolean value indicating whether the catalog item variant is published. | [optional][default to true] |
22
22
 
23
23
  ## Example
24
24
 
@@ -26,20 +26,20 @@
26
26
  require 'klaviyo-api-sdk'
27
27
 
28
28
  instance = KlaviyoAPI::CatalogVariantCreateQueryAsSubResourceAttributes.new(
29
- external_id: null,
29
+ external_id: SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
30
30
  catalog_type: $default,
31
31
  integration_type: null,
32
- title: null,
33
- description: null,
34
- sku: null,
35
- inventory_policy: null,
36
- inventory_quantity: null,
37
- price: null,
38
- url: null,
39
- image_full_url: null,
40
- image_thumbnail_url: null,
41
- images: null,
42
- custom_metadata: null,
32
+ title: Ocean Blue Shirt (Sample) Variant Medium,
33
+ description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
34
+ sku: OBS-MD,
35
+ inventory_policy: 25,
36
+ inventory_quantity: 25,
37
+ price: 42,
38
+ url: https://via.placeholder.com/150,
39
+ image_full_url: https://via.placeholder.com/300,
40
+ image_thumbnail_url: https://via.placeholder.com/150,
41
+ images: ["https://via.placeholder.com/150"],
42
+ custom_metadata: {"Top Pick":true},
43
43
  published: true
44
44
  )
45
45
  ```
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **variants** | [**Array<CatalogVariantDeleteQueryAsSubResource>**](CatalogVariantDeleteQueryAsSubResource.md) | | |
7
+ | **variants** | [**Array<CatalogVariantDeleteQueryAsSubResource>**](CatalogVariantDeleteQueryAsSubResource.md) | Array of catalog variants to delete. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
8
+ | **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
9
9
 
10
10
  ## Example
11
11
 
@@ -14,7 +14,7 @@ require 'klaviyo-api-sdk'
14
14
 
15
15
  instance = KlaviyoAPI::CatalogVariantDeleteQueryAsSubResource.new(
16
16
  type: null,
17
- id: null
17
+ id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM
18
18
  )
19
19
  ```
20
20
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **variants** | [**Array<CatalogVariantUpdateQueryAsSubResource>**](CatalogVariantUpdateQueryAsSubResource.md) | | |
7
+ | **variants** | [**Array<CatalogVariantUpdateQueryAsSubResource>**](CatalogVariantUpdateQueryAsSubResource.md) | Array of catalog variants to update. | |
8
8
 
9
9
  ## Example
10
10
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs & non-custom integrations is forthcoming. | |
8
+ | **id** | **String** | The catalog variant ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. | |
9
9
  | **attributes** | [**CatalogVariantUpdateQueryAsSubResourceAttributes**](CatalogVariantUpdateQueryAsSubResourceAttributes.md) | | |
10
10
 
11
11
  ## Example
@@ -15,7 +15,7 @@ require 'klaviyo-api-sdk'
15
15
 
16
16
  instance = KlaviyoAPI::CatalogVariantUpdateQueryAsSubResource.new(
17
17
  type: null,
18
- id: null,
18
+ id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
19
19
  attributes: null
20
20
  )
21
21
  ```
@@ -4,17 +4,17 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **title** | **String** | | [optional] |
8
- | **description** | **String** | | [optional] |
9
- | **inventory_policy** | **Integer** | A field that controls product visibility in product feeds/blocks. This field has two options: DENY (1): a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. CONTINUE (2): a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. UNKNOWN (0): the behavior will be the same as if it were set to 2 [Default] | [optional] |
10
- | **inventory_quantity** | **Float** | | [optional] |
11
- | **price** | **Float** | | [optional] |
12
- | **url** | **String** | | [optional] |
13
- | **image_full_url** | **String** | | [optional] |
14
- | **image_thumbnail_url** | **String** | | [optional] |
15
- | **images** | **Array<String>** | | [optional] |
16
- | **custom_metadata** | **Object** | | [optional] |
17
- | **published** | **Boolean** | | [optional] |
7
+ | **title** | **String** | The title of the catalog item variant. | [optional] |
8
+ | **description** | **String** | A description of the catalog item variant. | [optional] |
9
+ | **inventory_policy** | **Integer** | This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. | [optional] |
10
+ | **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. | [optional] |
11
+ | **price** | **Float** | This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). | [optional] |
12
+ | **url** | **String** | URL pointing to the location of the catalog item variant on your website. | [optional] |
13
+ | **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item variant. | [optional] |
14
+ | **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item variant. | [optional] |
15
+ | **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item variant. | [optional] |
16
+ | **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. | [optional] |
17
+ | **published** | **Boolean** | Boolean value indicating whether the catalog item variant is published. | [optional] |
18
18
 
19
19
  ## Example
20
20
 
@@ -22,17 +22,17 @@
22
22
  require 'klaviyo-api-sdk'
23
23
 
24
24
  instance = KlaviyoAPI::CatalogVariantUpdateQueryAsSubResourceAttributes.new(
25
- title: null,
26
- description: null,
27
- inventory_policy: null,
28
- inventory_quantity: null,
29
- price: null,
30
- url: null,
31
- image_full_url: null,
32
- image_thumbnail_url: null,
33
- images: null,
34
- custom_metadata: null,
35
- published: null
25
+ title: Ocean Blue Shirt (Sample) Variant Medium,
26
+ description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
27
+ inventory_policy: 2,
28
+ inventory_quantity: 25,
29
+ price: 42,
30
+ url: https://via.placeholder.com/150,
31
+ image_full_url: https://via.placeholder.com/300,
32
+ image_thumbnail_url: https://via.placeholder.com/150,
33
+ images: ["https://via.placeholder.com/150"],
34
+ custom_metadata: {"Top Pick":true},
35
+ published: true
36
36
  )
37
37
  ```
38
38