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,17 +4,18 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **external_id** | **String** | | [optional] |
8
- | **title** | **String** | | [optional] |
9
- | **description** | **String** | | [optional] |
10
- | **url** | **String** | | [optional] |
11
- | **image_full_url** | **String** | | [optional] |
12
- | **image_thumbnail_url** | **String** | | [optional] |
13
- | **images** | **Array<String>** | | [optional] |
14
- | **custom_metadata** | **Object** | | [optional] |
15
- | **published** | **Boolean** | | [optional] |
16
- | **created** | **Time** | | [optional] |
17
- | **updated** | **Time** | | [optional] |
7
+ | **external_id** | **String** | The ID of the catalog item in an external system. | [optional] |
8
+ | **title** | **String** | The title of the catalog item. | [optional] |
9
+ | **description** | **String** | A description of the catalog item. | [optional] |
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
+ | **url** | **String** | URL pointing to the location of the catalog item on your website. | [optional] |
12
+ | **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item. | [optional] |
13
+ | **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item | [optional] |
14
+ | **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item. | [optional] |
15
+ | **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb. | [optional] |
16
+ | **published** | **Boolean** | Boolean value indicating whether the catalog item is published. | [optional] |
17
+ | **created** | **Time** | Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
18
+ | **updated** | **Time** | Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
18
19
 
19
20
  ## Example
20
21
 
@@ -22,15 +23,16 @@
22
23
  require 'klaviyo-api-sdk'
23
24
 
24
25
  instance = KlaviyoAPI::IncludedItemsAttributes.new(
25
- external_id: null,
26
- title: null,
27
- description: null,
28
- url: null,
29
- image_full_url: null,
30
- image_thumbnail_url: null,
31
- images: null,
32
- custom_metadata: null,
33
- published: null,
26
+ external_id: SAMPLE-DATA-ITEM-1,
27
+ title: Ocean Blue Shirt (Sample),
28
+ description: Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.,
29
+ price: null,
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,
34
36
  created: null,
35
37
  updated: null
36
38
  )
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | | |
8
+ | **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
9
9
  | **attributes** | [**IncludedListsAttributes**](IncludedListsAttributes.md) | | |
10
10
  | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
11
11
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
16
16
 
17
17
  instance = KlaviyoAPI::IncludedLists.new(
18
18
  type: null,
19
- id: null,
19
+ id: Y6nRLr,
20
20
  attributes: null,
21
21
  links: null
22
22
  )
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **created** | **Time** | | [optional] |
9
- | **updated** | **Time** | | [optional] |
7
+ | **name** | **String** | A helpful name to label the list | [optional] |
8
+ | **created** | **Time** | Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
9
+ | **updated** | **Time** | Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -14,7 +14,7 @@
14
14
  require 'klaviyo-api-sdk'
15
15
 
16
16
  instance = KlaviyoAPI::IncludedListsAttributes.new(
17
- name: null,
17
+ name: Newsletter,
18
18
  created: null,
19
19
  updated: null
20
20
  )
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | | |
8
+ | **id** | **String** | Primary key that uniquely identifies this profile. Generated by Klaviyo. | |
9
9
  | **attributes** | [**IncludedProfilesAttributes**](IncludedProfilesAttributes.md) | | |
10
10
  | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
11
11
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
16
16
 
17
17
  instance = KlaviyoAPI::IncludedProfiles.new(
18
18
  type: null,
19
- id: null,
19
+ id: 01GDDKASAP8TKDDA2GRZDSVP4H,
20
20
  attributes: null,
21
21
  links: null
22
22
  )
@@ -4,20 +4,20 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | [optional] |
8
- | **phone_number** | **String** | | [optional] |
9
- | **external_id** | **String** | | [optional] |
7
+ | **email** | **String** | Individual's email address | [optional] |
8
+ | **phone_number** | **String** | Individual's phone number in E.164 format | [optional] |
9
+ | **external_id** | **String** | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system. | [optional] |
10
10
  | **anonymous_id** | **String** | | [optional] |
11
- | **first_name** | **String** | | [optional] |
12
- | **last_name** | **String** | | [optional] |
13
- | **organization** | **String** | | [optional] |
14
- | **title** | **String** | | [optional] |
15
- | **image** | **String** | | [optional] |
16
- | **created** | **Time** | | [optional] |
17
- | **updated** | **Time** | | [optional] |
18
- | **last_event_date** | **Time** | | [optional] |
11
+ | **first_name** | **String** | Individual's first name | [optional] |
12
+ | **last_name** | **String** | Individual's last name | [optional] |
13
+ | **organization** | **String** | Name of the company or organization within the company for whom the individual works | [optional] |
14
+ | **title** | **String** | Individual's job title | [optional] |
15
+ | **image** | **String** | URL pointing to the location of a profile image | [optional] |
16
+ | **created** | **Time** | Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
17
+ | **updated** | **Time** | Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
18
+ | **last_event_date** | **Time** | Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
19
19
  | **location** | [**ProfileLocation**](ProfileLocation.md) | | [optional] |
20
- | **properties** | **Object** | | [optional] |
20
+ | **properties** | **Object** | An object containing key/value pairs for any custom properties assigned to this profile | [optional] |
21
21
 
22
22
  ## Example
23
23
 
@@ -25,20 +25,20 @@
25
25
  require 'klaviyo-api-sdk'
26
26
 
27
27
  instance = KlaviyoAPI::IncludedProfilesAttributes.new(
28
- email: null,
29
- phone_number: null,
30
- external_id: null,
28
+ email: sarah.mason@klaviyo-demo.com,
29
+ phone_number: +15005550006,
30
+ external_id: 63f64a2b-c6bf-40c7-b81f-bed08162edbe,
31
31
  anonymous_id: null,
32
- first_name: null,
33
- last_name: null,
34
- organization: null,
35
- title: null,
36
- image: null,
32
+ first_name: Sarah,
33
+ last_name: Mason,
34
+ organization: Klaviyo,
35
+ title: Engineer,
36
+ image: https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg,
37
37
  created: null,
38
38
  updated: null,
39
39
  last_event_date: null,
40
40
  location: null,
41
- properties: null
41
+ properties: {"pseudonym":"Dr. Octopus"}
42
42
  )
43
43
  ```
44
44
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
8
  | **id** | **String** | | |
9
- | **attributes** | [**IncludedListsAttributes**](IncludedListsAttributes.md) | | |
9
+ | **attributes** | [**IncludedSegmentsAttributes**](IncludedSegmentsAttributes.md) | | |
10
10
  | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
11
11
 
12
12
  ## Example
@@ -0,0 +1,22 @@
1
+ # KlaviyoAPI::IncludedSegmentsAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A helpful name to label the segment | [optional] |
8
+ | **created** | **Time** | Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
9
+ | **updated** | **Time** | Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'klaviyo-api-sdk'
15
+
16
+ instance = KlaviyoAPI::IncludedSegmentsAttributes.new(
17
+ name: Repeat Purchasers,
18
+ created: null,
19
+ updated: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # KlaviyoAPI::IncludedTags
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | |
8
+ | **id** | **String** | The Tag ID | |
9
+ | **attributes** | [**TagUpdateQueryAsSubResourceAttributes**](TagUpdateQueryAsSubResourceAttributes.md) | | |
10
+ | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'klaviyo-api-sdk'
16
+
17
+ instance = KlaviyoAPI::IncludedTags.new(
18
+ type: null,
19
+ id: abcd1234-ef56-gh78-ij90-abcdef123456,
20
+ attributes: null,
21
+ links: null
22
+ )
23
+ ```
24
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **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`. | |
9
9
  | **attributes** | [**IncludedVariantsAttributes**](IncludedVariantsAttributes.md) | | |
10
10
  | **links** | [**IncludedVariantsLinks**](IncludedVariantsLinks.md) | | |
11
11
 
@@ -16,7 +16,7 @@ require 'klaviyo-api-sdk'
16
16
 
17
17
  instance = KlaviyoAPI::IncludedVariants.new(
18
18
  type: null,
19
- id: null,
19
+ id: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
20
20
  attributes: null,
21
21
  links: null
22
22
  )
@@ -4,21 +4,21 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **external_id** | **String** | | [optional] |
8
- | **title** | **String** | | [optional] |
9
- | **description** | **String** | | [optional] |
10
- | **sku** | **String** | | [optional] |
11
- | **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] |
12
- | **inventory_quantity** | **Float** | | [optional] |
13
- | **price** | **Float** | | [optional] |
14
- | **url** | **String** | | [optional] |
15
- | **image_full_url** | **String** | | [optional] |
16
- | **image_thumbnail_url** | **String** | | [optional] |
17
- | **images** | **Array<String>** | | [optional] |
18
- | **custom_metadata** | **Object** | | [optional] |
19
- | **published** | **Boolean** | | [optional] |
20
- | **created** | **Time** | | [optional] |
21
- | **updated** | **Time** | | [optional] |
7
+ | **external_id** | **String** | The ID of the catalog item variant in an external system. | [optional] |
8
+ | **title** | **String** | The title of the catalog item variant. | [optional] |
9
+ | **description** | **String** | A description of the catalog item variant. | [optional] |
10
+ | **sku** | **String** | The SKU of the catalog item variant. | [optional] |
11
+ | **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] |
12
+ | **inventory_quantity** | **Float** | The quantity of the catalog item variant currently in stock. | [optional] |
13
+ | **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] |
14
+ | **url** | **String** | URL pointing to the location of the catalog item variant on your website. | [optional] |
15
+ | **image_full_url** | **String** | URL pointing to the location of a full image of the catalog item variant. | [optional] |
16
+ | **image_thumbnail_url** | **String** | URL pointing to the location of an image thumbnail of the catalog item variant. | [optional] |
17
+ | **images** | **Array<String>** | List of URLs pointing to the locations of images of the catalog item variant. | [optional] |
18
+ | **custom_metadata** | **Object** | Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. | [optional] |
19
+ | **published** | **Boolean** | Boolean value indicating whether the catalog item variant is published. | [optional] |
20
+ | **created** | **Time** | Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
21
+ | **updated** | **Time** | Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). | [optional] |
22
22
 
23
23
  ## Example
24
24
 
@@ -26,19 +26,19 @@
26
26
  require 'klaviyo-api-sdk'
27
27
 
28
28
  instance = KlaviyoAPI::IncludedVariantsAttributes.new(
29
- external_id: null,
30
- title: null,
31
- description: null,
32
- sku: null,
33
- inventory_policy: null,
34
- inventory_quantity: null,
35
- price: null,
36
- url: null,
37
- image_full_url: null,
38
- image_thumbnail_url: null,
39
- images: null,
40
- custom_metadata: null,
41
- published: null,
29
+ external_id: SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM,
30
+ title: Ocean Blue Shirt (Sample) Variant Medium,
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
+ sku: OBS-MD,
33
+ inventory_policy: 2,
34
+ inventory_quantity: 25,
35
+ price: 42,
36
+ url: https://via.placeholder.com/150,
37
+ image_full_url: https://via.placeholder.com/300,
38
+ image_thumbnail_url: https://via.placeholder.com/150,
39
+ images: ["https://via.placeholder.com/150"],
40
+ custom_metadata: {"Top Pick":true},
41
+ published: true,
42
42
  created: null,
43
43
  updated: null
44
44
  )
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | |
7
+ | **name** | **String** | A helpful name to label the list | |
8
8
 
9
9
  ## Example
10
10
 
@@ -12,7 +12,7 @@
12
12
  require 'klaviyo-api-sdk'
13
13
 
14
14
  instance = KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new(
15
- name: null
15
+ name: Newsletter
16
16
  )
17
17
  ```
18
18
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | |
8
- | **id** | **String** | | |
8
+ | **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
9
9
  | **attributes** | [**ListCreateQueryAsSubResourceAttributes**](ListCreateQueryAsSubResourceAttributes.md) | | |
10
10
 
11
11
  ## Example
@@ -15,7 +15,7 @@ require 'klaviyo-api-sdk'
15
15
 
16
16
  instance = KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new(
17
17
  type: null,
18
- id: null,
18
+ id: Y6nRLr,
19
19
  attributes: null
20
20
  )
21
21
  ```
data/docs/ListsApi.md CHANGED
@@ -38,7 +38,7 @@ KlaviyoAPI.configure do |config|
38
38
  end
39
39
 
40
40
  api_instance = KlaviyoAPI::ListsApi.new
41
- list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::ListCreateQueryAsSubResource.new({type: 'list', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # ListCreateQuery |
41
+ list_create_query = KlaviyoAPI::ListCreateQuery.new({data: KlaviyoAPI::ListCreateQueryAsSubResource.new({type: 'list', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'Newsletter'})})}) # ListCreateQuery |
42
42
 
43
43
  begin
44
44
  # Create List
@@ -183,7 +183,7 @@ KlaviyoAPI.configure do |config|
183
183
  end
184
184
 
185
185
  api_instance = KlaviyoAPI::ListsApi.new
186
- id = 'id_example' # String |
186
+ id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
187
187
 
188
188
  begin
189
189
  # Delete List
@@ -215,7 +215,7 @@ end
215
215
 
216
216
  | Name | Type | Description | Notes |
217
217
  | ---- | ---- | ----------- | ----- |
218
- | **id** | **String** | | |
218
+ | **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
219
219
 
220
220
  ### Return type
221
221
 
@@ -327,9 +327,9 @@ KlaviyoAPI.configure do |config|
327
327
  end
328
328
 
329
329
  api_instance = KlaviyoAPI::ListsApi.new
330
- id = 'id_example' # String |
330
+ id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
331
331
  opts = {
332
- fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
332
+ fields_list: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
333
333
  }
334
334
 
335
335
  begin
@@ -363,8 +363,8 @@ end
363
363
 
364
364
  | Name | Type | Description | Notes |
365
365
  | ---- | ---- | ----------- | ----- |
366
- | **id** | **String** | | |
367
- | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
366
+ | **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
367
+ | **fields_list** | [**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] |
368
368
 
369
369
  ### Return type
370
370
 
@@ -402,11 +402,11 @@ KlaviyoAPI.configure do |config|
402
402
  end
403
403
 
404
404
  api_instance = KlaviyoAPI::ListsApi.new
405
- list_id = 'list_id_example' # String |
405
+ list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
406
406
  opts = {
407
- fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
408
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
409
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
407
+ fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
408
+ 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>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
409
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
410
410
  }
411
411
 
412
412
  begin
@@ -440,10 +440,10 @@ end
440
440
 
441
441
  | Name | Type | Description | Notes |
442
442
  | ---- | ---- | ----------- | ----- |
443
- | **list_id** | **String** | | |
444
- | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
445
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
446
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
443
+ | **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
444
+ | **fields_profile** | [**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] |
445
+ | **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;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
446
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
447
447
 
448
448
  ### Return type
449
449
 
@@ -484,7 +484,7 @@ api_instance = KlaviyoAPI::ListsApi.new
484
484
  id = 'id_example' # String |
485
485
  related_resource = 'profiles' # String |
486
486
  opts = {
487
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
487
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
488
488
  }
489
489
 
490
490
  begin
@@ -520,7 +520,7 @@ end
520
520
  | ---- | ---- | ----------- | ----- |
521
521
  | **id** | **String** | | |
522
522
  | **related_resource** | **String** | | |
523
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
523
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
524
524
 
525
525
  ### Return type
526
526
 
@@ -558,9 +558,9 @@ KlaviyoAPI.configure do |config|
558
558
  end
559
559
 
560
560
  api_instance = KlaviyoAPI::ListsApi.new
561
- list_id = 'list_id_example' # String |
561
+ list_id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
562
562
  opts = {
563
- fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
563
+ fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
564
564
  }
565
565
 
566
566
  begin
@@ -594,8 +594,8 @@ end
594
594
 
595
595
  | Name | Type | Description | Notes |
596
596
  | ---- | ---- | ----------- | ----- |
597
- | **list_id** | **String** | | |
598
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
597
+ | **list_id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
598
+ | **fields_tag** | [**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] |
599
599
 
600
600
  ### Return type
601
601
 
@@ -634,9 +634,9 @@ end
634
634
 
635
635
  api_instance = KlaviyoAPI::ListsApi.new
636
636
  opts = {
637
- fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
638
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
639
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination
637
+ fields_list: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
638
+ 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>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
639
+ page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
640
640
  }
641
641
 
642
642
  begin
@@ -670,9 +670,9 @@ end
670
670
 
671
671
  | Name | Type | Description | Notes |
672
672
  | ---- | ---- | ----------- | ----- |
673
- | **fields_list** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | [optional] |
674
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
675
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | [optional] |
673
+ | **fields_list** | [**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] |
674
+ | **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;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
675
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
676
676
 
677
677
  ### Return type
678
678
 
@@ -710,8 +710,8 @@ KlaviyoAPI.configure do |config|
710
710
  end
711
711
 
712
712
  api_instance = KlaviyoAPI::ListsApi.new
713
- id = 'id_example' # String |
714
- list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new({type: 'list', id: 'id_example', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # ListPartialUpdateQuery |
713
+ id = 'Y6nRLr' # String | Primary key that uniquely identifies this list. Generated by Klaviyo.
714
+ list_partial_update_query = KlaviyoAPI::ListPartialUpdateQuery.new({data: KlaviyoAPI::ListPartialUpdateQueryAsSubResource.new({type: 'list', id: 'Y6nRLr', attributes: KlaviyoAPI::ListCreateQueryAsSubResourceAttributes.new({name: 'Newsletter'})})}) # ListPartialUpdateQuery |
715
715
 
716
716
  begin
717
717
  # Update List
@@ -744,7 +744,7 @@ end
744
744
 
745
745
  | Name | Type | Description | Notes |
746
746
  | ---- | ---- | ----------- | ----- |
747
- | **id** | **String** | | |
747
+ | **id** | **String** | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
748
748
  | **list_partial_update_query** | [**ListPartialUpdateQuery**](ListPartialUpdateQuery.md) | | |
749
749
 
750
750
  ### Return type
@@ -5,15 +5,15 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **metric_id** | **String** | The metric ID used in the aggregation. | |
8
+ | **page_cursor** | **String** | Optional pagination cursor to iterate over large result sets | [optional] |
8
9
  | **measurements** | **Array&lt;String&gt;** | Measurement key, e.g. &#x60;unique&#x60;, &#x60;sum_value&#x60;, &#x60;count&#x60; | |
9
10
  | **interval** | **String** | Aggregation interval, e.g. \&quot;hour\&quot;, \&quot;day\&quot;, \&quot;week\&quot;, \&quot;month\&quot; | |
10
11
  | **page_size** | **Integer** | Alter the maximum number of returned rows in a single page of aggregation results | [optional][default to 500] |
11
12
  | **by** | **Array&lt;String&gt;** | Optional attribute(s) used for partitioning by the aggregation function | [optional] |
12
13
  | **return_fields** | **Array&lt;String&gt;** | Provide fields to limit the returned data | [optional] |
13
- | **filter** | **Array&lt;String&gt;** | List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). These filters follow a similar format to those in &#x60;GET&#x60; requests, the primary difference is that this endpoint asks for a list. The time range can be filtered by providing a &#x60;greater_or_equal&#x60; and a &#x60;less-than&#x60; filter on the &#x60;datetime&#x60; field. | |
14
+ | **filter** | **Array&lt;String&gt;** | List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). These filters follow a similar format to those in &#x60;GET&#x60; requests, the primary difference is that this endpoint asks for a list. The time range can be filtered by providing a &#x60;greater-or-equal&#x60; and a &#x60;less-than&#x60; filter on the &#x60;datetime&#x60; field. | |
14
15
  | **timezone** | **String** | The timezone used for processing the query, e.g. &#x60;&#39;America/New_York&#39;&#x60;. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones). While most are supported, a few notable exceptions are &#x60;Factory&#x60;, &#x60;Europe/Kyiv&#x60; and &#x60;Pacific/Kanton&#x60;. This field is case-sensitive. | [optional][default to &#39;UTC&#39;] |
15
- | **sort** | **String** | | [optional] |
16
- | **page_cursor** | **String** | | [optional] |
16
+ | **sort** | **String** | Provide a sort key (e.g. -$message) | [optional] |
17
17
 
18
18
  ## Example
19
19
 
@@ -22,6 +22,7 @@ require 'klaviyo-api-sdk'
22
22
 
23
23
  instance = KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new(
24
24
  metric_id: 0rG4eQ,
25
+ page_cursor: null,
25
26
  measurements: count,
26
27
  interval: day,
27
28
  page_size: 500,
@@ -29,8 +30,7 @@ instance = KlaviyoAPI::MetricAggregateQueryAsSubResourceAttributes.new(
29
30
  return_fields: null,
30
31
  filter: [&quot;greater-or-equal(datetime,2022-12-01T00:00:00)&quot;,&quot;less-than(datetime,2022-12-08T00:00:00&quot;],
31
32
  timezone: America/New_York,
32
- sort: null,
33
- page_cursor: null
33
+ sort: null
34
34
  )
35
35
  ```
36
36