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
@@ -0,0 +1,1277 @@
1
+ # KlaviyoAPI::CampaignsApi
2
+
3
+ All URIs are relative to *https://a.klaviyo.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_campaign**](CampaignsApi.md#create_campaign) | **POST** /api/campaigns/ | Create Campaign |
8
+ | [**create_campaign_clone**](CampaignsApi.md#create_campaign_clone) | **POST** /api/campaign-clone/ | Create Campaign Clone |
9
+ | [**create_campaign_message_assign_template**](CampaignsApi.md#create_campaign_message_assign_template) | **POST** /api/campaign-message-assign-template/ | Create Campaign Message Assign Template |
10
+ | [**create_campaign_recipient_estimation_job**](CampaignsApi.md#create_campaign_recipient_estimation_job) | **POST** /api/campaign-recipient-estimation-jobs/ | Create Campaign Recipient Estimation Job |
11
+ | [**create_campaign_send_job**](CampaignsApi.md#create_campaign_send_job) | **POST** /api/campaign-send-jobs/ | Create Campaign Send Job |
12
+ | [**delete_campaign**](CampaignsApi.md#delete_campaign) | **DELETE** /api/campaigns/{id}/ | Delete Campaign |
13
+ | [**get_campaign**](CampaignsApi.md#get_campaign) | **GET** /api/campaigns/{id}/ | Get Campaign |
14
+ | [**get_campaign_message**](CampaignsApi.md#get_campaign_message) | **GET** /api/campaign-messages/{id}/ | Get Campaign Message |
15
+ | [**get_campaign_recipient_estimation**](CampaignsApi.md#get_campaign_recipient_estimation) | **GET** /api/campaign-recipient-estimations/{id}/ | Get Campaign Recipient Estimation |
16
+ | [**get_campaign_recipient_estimation_job**](CampaignsApi.md#get_campaign_recipient_estimation_job) | **GET** /api/campaign-recipient-estimation-jobs/{id}/ | Get Campaign Recipient Estimation Job |
17
+ | [**get_campaign_relationships**](CampaignsApi.md#get_campaign_relationships) | **GET** /api/campaigns/{id}/relationships/{related_resource}/ | Get Campaign Relationships |
18
+ | [**get_campaign_send_job**](CampaignsApi.md#get_campaign_send_job) | **GET** /api/campaign-send-jobs/{id}/ | Get Campaign Send Job |
19
+ | [**get_campaign_tags**](CampaignsApi.md#get_campaign_tags) | **GET** /api/campaigns/{campaign_id}/tags/ | Get Campaign Tags |
20
+ | [**get_campaigns**](CampaignsApi.md#get_campaigns) | **GET** /api/campaigns/ | Get Campaigns |
21
+ | [**update_campaign**](CampaignsApi.md#update_campaign) | **PATCH** /api/campaigns/{id}/ | Update Campaign |
22
+ | [**update_campaign_message**](CampaignsApi.md#update_campaign_message) | **PATCH** /api/campaign-messages/{id}/ | Update Campaign Message |
23
+ | [**update_campaign_send_job**](CampaignsApi.md#update_campaign_send_job) | **PATCH** /api/campaign-send-jobs/{id}/ | Update Campaign Send Job |
24
+
25
+
26
+ ## create_campaign
27
+
28
+ > Hash<String, Object> create_campaign(campaign_create_query)
29
+
30
+ Create Campaign
31
+
32
+ Creates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
33
+
34
+ ### Examples
35
+
36
+ ```ruby
37
+ require 'time'
38
+ require 'klaviyo-api-sdk'
39
+ # setup authorization
40
+ KlaviyoAPI.configure do |config|
41
+ # Configure API key authorization: Klaviyo-API-Key
42
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
43
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
44
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
45
+ end
46
+
47
+ api_instance = KlaviyoAPI::CampaignsApi.new
48
+ campaign_create_query = KlaviyoAPI::CampaignCreateQuery.new({data: KlaviyoAPI::CampaignCreateQueryAsSubResource.new({type: 'campaign', attributes: KlaviyoAPI::CampaignCreateQueryAsSubResourceAttributes.new({name: 'My new campaign', channel: 'email', audiences: KlaviyoAPI::AudiencesSubObject.new, send_strategy: KlaviyoAPI::SendStrategySubObject.new({method: 'static'}), send_options: KlaviyoAPI::SendOptionsSubObject.new})})}) # CampaignCreateQuery | Creates a campaign from parameters
49
+
50
+ begin
51
+ # Create Campaign
52
+ result = api_instance.create_campaign(campaign_create_query)
53
+ p result
54
+ rescue KlaviyoAPI::ApiError => e
55
+ puts "Error when calling CampaignsApi->create_campaign: #{e}"
56
+ end
57
+ ```
58
+
59
+ #### Using the create_campaign_with_http_info variant
60
+
61
+ This returns an Array which contains the response data, status code and headers.
62
+
63
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_campaign_with_http_info(campaign_create_query)
64
+
65
+ ```ruby
66
+ begin
67
+ # Create Campaign
68
+ data, status_code, headers = api_instance.create_campaign_with_http_info(campaign_create_query)
69
+ p status_code # => 2xx
70
+ p headers # => { ... }
71
+ p data # => Hash&lt;String, Object&gt;
72
+ rescue KlaviyoAPI::ApiError => e
73
+ puts "Error when calling CampaignsApi->create_campaign_with_http_info: #{e}"
74
+ end
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ | Name | Type | Description | Notes |
80
+ | ---- | ---- | ----------- | ----- |
81
+ | **campaign_create_query** | [**CampaignCreateQuery**](CampaignCreateQuery.md) | Creates a campaign from parameters | |
82
+
83
+ ### Return type
84
+
85
+ **Hash&lt;String, Object&gt;**
86
+
87
+ ### Authorization
88
+
89
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
90
+
91
+ ### HTTP request headers
92
+
93
+ - **Content-Type**: application/json
94
+ - **Accept**: application/json
95
+
96
+
97
+ ## create_campaign_clone
98
+
99
+ > Hash&lt;String, Object&gt; create_campaign_clone(campaign_clone_query)
100
+
101
+ Create Campaign Clone
102
+
103
+ Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
104
+
105
+ ### Examples
106
+
107
+ ```ruby
108
+ require 'time'
109
+ require 'klaviyo-api-sdk'
110
+ # setup authorization
111
+ KlaviyoAPI.configure do |config|
112
+ # Configure API key authorization: Klaviyo-API-Key
113
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
114
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
115
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
116
+ end
117
+
118
+ api_instance = KlaviyoAPI::CampaignsApi.new
119
+ campaign_clone_query = KlaviyoAPI::CampaignCloneQuery.new({data: KlaviyoAPI::CampaignCloneQueryAsSubResource.new({type: 'campaign', attributes: KlaviyoAPI::CampaignCloneQueryAsSubResourceAttributes.new({id: 'id_example'})})}) # CampaignCloneQuery | Clones a campaign from an existing campaign
120
+
121
+ begin
122
+ # Create Campaign Clone
123
+ result = api_instance.create_campaign_clone(campaign_clone_query)
124
+ p result
125
+ rescue KlaviyoAPI::ApiError => e
126
+ puts "Error when calling CampaignsApi->create_campaign_clone: #{e}"
127
+ end
128
+ ```
129
+
130
+ #### Using the create_campaign_clone_with_http_info variant
131
+
132
+ This returns an Array which contains the response data, status code and headers.
133
+
134
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_campaign_clone_with_http_info(campaign_clone_query)
135
+
136
+ ```ruby
137
+ begin
138
+ # Create Campaign Clone
139
+ data, status_code, headers = api_instance.create_campaign_clone_with_http_info(campaign_clone_query)
140
+ p status_code # => 2xx
141
+ p headers # => { ... }
142
+ p data # => Hash&lt;String, Object&gt;
143
+ rescue KlaviyoAPI::ApiError => e
144
+ puts "Error when calling CampaignsApi->create_campaign_clone_with_http_info: #{e}"
145
+ end
146
+ ```
147
+
148
+ ### Parameters
149
+
150
+ | Name | Type | Description | Notes |
151
+ | ---- | ---- | ----------- | ----- |
152
+ | **campaign_clone_query** | [**CampaignCloneQuery**](CampaignCloneQuery.md) | Clones a campaign from an existing campaign | |
153
+
154
+ ### Return type
155
+
156
+ **Hash&lt;String, Object&gt;**
157
+
158
+ ### Authorization
159
+
160
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
161
+
162
+ ### HTTP request headers
163
+
164
+ - **Content-Type**: application/json
165
+ - **Accept**: application/json
166
+
167
+
168
+ ## create_campaign_message_assign_template
169
+
170
+ > Hash&lt;String, Object&gt; create_campaign_message_assign_template(campaign_message_assign_template_query)
171
+
172
+ Create Campaign Message Assign Template
173
+
174
+ Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
175
+
176
+ ### Examples
177
+
178
+ ```ruby
179
+ require 'time'
180
+ require 'klaviyo-api-sdk'
181
+ # setup authorization
182
+ KlaviyoAPI.configure do |config|
183
+ # Configure API key authorization: Klaviyo-API-Key
184
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
185
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
186
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
187
+ end
188
+
189
+ api_instance = KlaviyoAPI::CampaignsApi.new
190
+ campaign_message_assign_template_query = KlaviyoAPI::CampaignMessageAssignTemplateQuery.new({data: KlaviyoAPI::CampaignMessageAssignTemplateQueryAsSubResource.new({type: 'campaign-message', attributes: KlaviyoAPI::CampaignMessageAssignTemplateQueryAsSubResourceAttributes.new({id: 'id_example', template_id: 'RipRmi'})})}) # CampaignMessageAssignTemplateQuery | Takes a reusable template, clones it, and assigns the non-reusable clone to the message.
191
+
192
+ begin
193
+ # Create Campaign Message Assign Template
194
+ result = api_instance.create_campaign_message_assign_template(campaign_message_assign_template_query)
195
+ p result
196
+ rescue KlaviyoAPI::ApiError => e
197
+ puts "Error when calling CampaignsApi->create_campaign_message_assign_template: #{e}"
198
+ end
199
+ ```
200
+
201
+ #### Using the create_campaign_message_assign_template_with_http_info variant
202
+
203
+ This returns an Array which contains the response data, status code and headers.
204
+
205
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_campaign_message_assign_template_with_http_info(campaign_message_assign_template_query)
206
+
207
+ ```ruby
208
+ begin
209
+ # Create Campaign Message Assign Template
210
+ data, status_code, headers = api_instance.create_campaign_message_assign_template_with_http_info(campaign_message_assign_template_query)
211
+ p status_code # => 2xx
212
+ p headers # => { ... }
213
+ p data # => Hash&lt;String, Object&gt;
214
+ rescue KlaviyoAPI::ApiError => e
215
+ puts "Error when calling CampaignsApi->create_campaign_message_assign_template_with_http_info: #{e}"
216
+ end
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ | Name | Type | Description | Notes |
222
+ | ---- | ---- | ----------- | ----- |
223
+ | **campaign_message_assign_template_query** | [**CampaignMessageAssignTemplateQuery**](CampaignMessageAssignTemplateQuery.md) | Takes a reusable template, clones it, and assigns the non-reusable clone to the message. | |
224
+
225
+ ### Return type
226
+
227
+ **Hash&lt;String, Object&gt;**
228
+
229
+ ### Authorization
230
+
231
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: application/json
236
+ - **Accept**: application/json
237
+
238
+
239
+ ## create_campaign_recipient_estimation_job
240
+
241
+ > Hash&lt;String, Object&gt; create_campaign_recipient_estimation_job(campaign_recipient_estimation_job_create_query)
242
+
243
+ Create Campaign Recipient Estimation Job
244
+
245
+ Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
246
+
247
+ ### Examples
248
+
249
+ ```ruby
250
+ require 'time'
251
+ require 'klaviyo-api-sdk'
252
+ # setup authorization
253
+ KlaviyoAPI.configure do |config|
254
+ # Configure API key authorization: Klaviyo-API-Key
255
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
256
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
257
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
258
+ end
259
+
260
+ api_instance = KlaviyoAPI::CampaignsApi.new
261
+ campaign_recipient_estimation_job_create_query = KlaviyoAPI::CampaignRecipientEstimationJobCreateQuery.new({data: KlaviyoAPI::CampaignRecipientEstimationJobCreateQueryAsSubResource.new({type: 'campaign-recipient-estimation-job', attributes: KlaviyoAPI::CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.new({id: 'id_example'})})}) # CampaignRecipientEstimationJobCreateQuery | Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get Campaign Recipient Estimation Job` endpoint to retrieve the status of this estimation job. Use the `Get Campaign Recipient Estimation` endpoint to retrieve the estimated recipient count for a given campaign.
262
+
263
+ begin
264
+ # Create Campaign Recipient Estimation Job
265
+ result = api_instance.create_campaign_recipient_estimation_job(campaign_recipient_estimation_job_create_query)
266
+ p result
267
+ rescue KlaviyoAPI::ApiError => e
268
+ puts "Error when calling CampaignsApi->create_campaign_recipient_estimation_job: #{e}"
269
+ end
270
+ ```
271
+
272
+ #### Using the create_campaign_recipient_estimation_job_with_http_info variant
273
+
274
+ This returns an Array which contains the response data, status code and headers.
275
+
276
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_campaign_recipient_estimation_job_with_http_info(campaign_recipient_estimation_job_create_query)
277
+
278
+ ```ruby
279
+ begin
280
+ # Create Campaign Recipient Estimation Job
281
+ data, status_code, headers = api_instance.create_campaign_recipient_estimation_job_with_http_info(campaign_recipient_estimation_job_create_query)
282
+ p status_code # => 2xx
283
+ p headers # => { ... }
284
+ p data # => Hash&lt;String, Object&gt;
285
+ rescue KlaviyoAPI::ApiError => e
286
+ puts "Error when calling CampaignsApi->create_campaign_recipient_estimation_job_with_http_info: #{e}"
287
+ end
288
+ ```
289
+
290
+ ### Parameters
291
+
292
+ | Name | Type | Description | Notes |
293
+ | ---- | ---- | ----------- | ----- |
294
+ | **campaign_recipient_estimation_job_create_query** | [**CampaignRecipientEstimationJobCreateQuery**](CampaignRecipientEstimationJobCreateQuery.md) | Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the &#x60;Get Campaign Recipient Estimation Job&#x60; endpoint to retrieve the status of this estimation job. Use the &#x60;Get Campaign Recipient Estimation&#x60; endpoint to retrieve the estimated recipient count for a given campaign. | |
295
+
296
+ ### Return type
297
+
298
+ **Hash&lt;String, Object&gt;**
299
+
300
+ ### Authorization
301
+
302
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
303
+
304
+ ### HTTP request headers
305
+
306
+ - **Content-Type**: application/json
307
+ - **Accept**: application/json
308
+
309
+
310
+ ## create_campaign_send_job
311
+
312
+ > Hash&lt;String, Object&gt; create_campaign_send_job(campaign_send_job_create_query)
313
+
314
+ Create Campaign Send Job
315
+
316
+ Trigger a campaign to send asynchronously<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
317
+
318
+ ### Examples
319
+
320
+ ```ruby
321
+ require 'time'
322
+ require 'klaviyo-api-sdk'
323
+ # setup authorization
324
+ KlaviyoAPI.configure do |config|
325
+ # Configure API key authorization: Klaviyo-API-Key
326
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
327
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
328
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
329
+ end
330
+
331
+ api_instance = KlaviyoAPI::CampaignsApi.new
332
+ campaign_send_job_create_query = KlaviyoAPI::CampaignSendJobCreateQuery.new({data: KlaviyoAPI::CampaignSendJobCreateQueryAsSubResource.new({type: 'campaign-send-job', attributes: KlaviyoAPI::CampaignSendJobCreateQueryAsSubResourceAttributes.new({id: 'id_example'})})}) # CampaignSendJobCreateQuery | Trigger the campaign to send asynchronously
333
+
334
+ begin
335
+ # Create Campaign Send Job
336
+ result = api_instance.create_campaign_send_job(campaign_send_job_create_query)
337
+ p result
338
+ rescue KlaviyoAPI::ApiError => e
339
+ puts "Error when calling CampaignsApi->create_campaign_send_job: #{e}"
340
+ end
341
+ ```
342
+
343
+ #### Using the create_campaign_send_job_with_http_info variant
344
+
345
+ This returns an Array which contains the response data, status code and headers.
346
+
347
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_campaign_send_job_with_http_info(campaign_send_job_create_query)
348
+
349
+ ```ruby
350
+ begin
351
+ # Create Campaign Send Job
352
+ data, status_code, headers = api_instance.create_campaign_send_job_with_http_info(campaign_send_job_create_query)
353
+ p status_code # => 2xx
354
+ p headers # => { ... }
355
+ p data # => Hash&lt;String, Object&gt;
356
+ rescue KlaviyoAPI::ApiError => e
357
+ puts "Error when calling CampaignsApi->create_campaign_send_job_with_http_info: #{e}"
358
+ end
359
+ ```
360
+
361
+ ### Parameters
362
+
363
+ | Name | Type | Description | Notes |
364
+ | ---- | ---- | ----------- | ----- |
365
+ | **campaign_send_job_create_query** | [**CampaignSendJobCreateQuery**](CampaignSendJobCreateQuery.md) | Trigger the campaign to send asynchronously | |
366
+
367
+ ### Return type
368
+
369
+ **Hash&lt;String, Object&gt;**
370
+
371
+ ### Authorization
372
+
373
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
374
+
375
+ ### HTTP request headers
376
+
377
+ - **Content-Type**: application/json
378
+ - **Accept**: application/json
379
+
380
+
381
+ ## delete_campaign
382
+
383
+ > delete_campaign(id)
384
+
385
+ Delete Campaign
386
+
387
+ Delete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
388
+
389
+ ### Examples
390
+
391
+ ```ruby
392
+ require 'time'
393
+ require 'klaviyo-api-sdk'
394
+ # setup authorization
395
+ KlaviyoAPI.configure do |config|
396
+ # Configure API key authorization: Klaviyo-API-Key
397
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
398
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
399
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
400
+ end
401
+
402
+ api_instance = KlaviyoAPI::CampaignsApi.new
403
+ id = 'id_example' # String | The campaign ID to be deleted
404
+
405
+ begin
406
+ # Delete Campaign
407
+ api_instance.delete_campaign(id)
408
+ rescue KlaviyoAPI::ApiError => e
409
+ puts "Error when calling CampaignsApi->delete_campaign: #{e}"
410
+ end
411
+ ```
412
+
413
+ #### Using the delete_campaign_with_http_info variant
414
+
415
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
416
+
417
+ > <Array(nil, Integer, Hash)> delete_campaign_with_http_info(id)
418
+
419
+ ```ruby
420
+ begin
421
+ # Delete Campaign
422
+ data, status_code, headers = api_instance.delete_campaign_with_http_info(id)
423
+ p status_code # => 2xx
424
+ p headers # => { ... }
425
+ p data # => nil
426
+ rescue KlaviyoAPI::ApiError => e
427
+ puts "Error when calling CampaignsApi->delete_campaign_with_http_info: #{e}"
428
+ end
429
+ ```
430
+
431
+ ### Parameters
432
+
433
+ | Name | Type | Description | Notes |
434
+ | ---- | ---- | ----------- | ----- |
435
+ | **id** | **String** | The campaign ID to be deleted | |
436
+
437
+ ### Return type
438
+
439
+ nil (empty response body)
440
+
441
+ ### Authorization
442
+
443
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
444
+
445
+ ### HTTP request headers
446
+
447
+ - **Content-Type**: Not defined
448
+ - **Accept**: application/json
449
+
450
+
451
+ ## get_campaign
452
+
453
+ > Hash&lt;String, Object&gt; get_campaign(id, opts)
454
+
455
+ Get Campaign
456
+
457
+ Returns a specific campaign based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Read`
458
+
459
+ ### Examples
460
+
461
+ ```ruby
462
+ require 'time'
463
+ require 'klaviyo-api-sdk'
464
+ # setup authorization
465
+ KlaviyoAPI.configure do |config|
466
+ # Configure API key authorization: Klaviyo-API-Key
467
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
468
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
469
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
470
+ end
471
+
472
+ api_instance = KlaviyoAPI::CampaignsApi.new
473
+ id = 'id_example' # String | The campaign ID to be retrieved
474
+ opts = {
475
+ fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
476
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
477
+ include: ['tags'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
478
+ }
479
+
480
+ begin
481
+ # Get Campaign
482
+ result = api_instance.get_campaign(id, opts)
483
+ p result
484
+ rescue KlaviyoAPI::ApiError => e
485
+ puts "Error when calling CampaignsApi->get_campaign: #{e}"
486
+ end
487
+ ```
488
+
489
+ #### Using the get_campaign_with_http_info variant
490
+
491
+ This returns an Array which contains the response data, status code and headers.
492
+
493
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaign_with_http_info(id, opts)
494
+
495
+ ```ruby
496
+ begin
497
+ # Get Campaign
498
+ data, status_code, headers = api_instance.get_campaign_with_http_info(id, opts)
499
+ p status_code # => 2xx
500
+ p headers # => { ... }
501
+ p data # => Hash&lt;String, Object&gt;
502
+ rescue KlaviyoAPI::ApiError => e
503
+ puts "Error when calling CampaignsApi->get_campaign_with_http_info: #{e}"
504
+ end
505
+ ```
506
+
507
+ ### Parameters
508
+
509
+ | Name | Type | Description | Notes |
510
+ | ---- | ---- | ----------- | ----- |
511
+ | **id** | **String** | The campaign ID to be retrieved | |
512
+ | **fields_campaign** | [**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] |
513
+ | **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] |
514
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
515
+
516
+ ### Return type
517
+
518
+ **Hash&lt;String, Object&gt;**
519
+
520
+ ### Authorization
521
+
522
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: Not defined
527
+ - **Accept**: application/json
528
+
529
+
530
+ ## get_campaign_message
531
+
532
+ > Hash&lt;String, Object&gt; get_campaign_message(id, opts)
533
+
534
+ Get Campaign Message
535
+
536
+ Returns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Read`
537
+
538
+ ### Examples
539
+
540
+ ```ruby
541
+ require 'time'
542
+ require 'klaviyo-api-sdk'
543
+ # setup authorization
544
+ KlaviyoAPI.configure do |config|
545
+ # Configure API key authorization: Klaviyo-API-Key
546
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
547
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
548
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
549
+ end
550
+
551
+ api_instance = KlaviyoAPI::CampaignsApi.new
552
+ id = 'id_example' # String | The message ID to be retrieved
553
+ opts = {
554
+ fields_campaign_message: ['label'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
555
+ }
556
+
557
+ begin
558
+ # Get Campaign Message
559
+ result = api_instance.get_campaign_message(id, opts)
560
+ p result
561
+ rescue KlaviyoAPI::ApiError => e
562
+ puts "Error when calling CampaignsApi->get_campaign_message: #{e}"
563
+ end
564
+ ```
565
+
566
+ #### Using the get_campaign_message_with_http_info variant
567
+
568
+ This returns an Array which contains the response data, status code and headers.
569
+
570
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaign_message_with_http_info(id, opts)
571
+
572
+ ```ruby
573
+ begin
574
+ # Get Campaign Message
575
+ data, status_code, headers = api_instance.get_campaign_message_with_http_info(id, opts)
576
+ p status_code # => 2xx
577
+ p headers # => { ... }
578
+ p data # => Hash&lt;String, Object&gt;
579
+ rescue KlaviyoAPI::ApiError => e
580
+ puts "Error when calling CampaignsApi->get_campaign_message_with_http_info: #{e}"
581
+ end
582
+ ```
583
+
584
+ ### Parameters
585
+
586
+ | Name | Type | Description | Notes |
587
+ | ---- | ---- | ----------- | ----- |
588
+ | **id** | **String** | The message ID to be retrieved | |
589
+ | **fields_campaign_message** | [**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] |
590
+
591
+ ### Return type
592
+
593
+ **Hash&lt;String, Object&gt;**
594
+
595
+ ### Authorization
596
+
597
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
598
+
599
+ ### HTTP request headers
600
+
601
+ - **Content-Type**: Not defined
602
+ - **Accept**: application/json
603
+
604
+
605
+ ## get_campaign_recipient_estimation
606
+
607
+ > Hash&lt;String, Object&gt; get_campaign_recipient_estimation(id, opts)
608
+
609
+ Get Campaign Recipient Estimation
610
+
611
+ Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Read`
612
+
613
+ ### Examples
614
+
615
+ ```ruby
616
+ require 'time'
617
+ require 'klaviyo-api-sdk'
618
+ # setup authorization
619
+ KlaviyoAPI.configure do |config|
620
+ # Configure API key authorization: Klaviyo-API-Key
621
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
622
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
623
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
624
+ end
625
+
626
+ api_instance = KlaviyoAPI::CampaignsApi.new
627
+ id = 'id_example' # String | The ID of the campaign for which to get the estimated number of recipients
628
+ opts = {
629
+ fields_campaign_recipient_estimation: ['estimated_recipient_count'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
630
+ }
631
+
632
+ begin
633
+ # Get Campaign Recipient Estimation
634
+ result = api_instance.get_campaign_recipient_estimation(id, opts)
635
+ p result
636
+ rescue KlaviyoAPI::ApiError => e
637
+ puts "Error when calling CampaignsApi->get_campaign_recipient_estimation: #{e}"
638
+ end
639
+ ```
640
+
641
+ #### Using the get_campaign_recipient_estimation_with_http_info variant
642
+
643
+ This returns an Array which contains the response data, status code and headers.
644
+
645
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaign_recipient_estimation_with_http_info(id, opts)
646
+
647
+ ```ruby
648
+ begin
649
+ # Get Campaign Recipient Estimation
650
+ data, status_code, headers = api_instance.get_campaign_recipient_estimation_with_http_info(id, opts)
651
+ p status_code # => 2xx
652
+ p headers # => { ... }
653
+ p data # => Hash&lt;String, Object&gt;
654
+ rescue KlaviyoAPI::ApiError => e
655
+ puts "Error when calling CampaignsApi->get_campaign_recipient_estimation_with_http_info: #{e}"
656
+ end
657
+ ```
658
+
659
+ ### Parameters
660
+
661
+ | Name | Type | Description | Notes |
662
+ | ---- | ---- | ----------- | ----- |
663
+ | **id** | **String** | The ID of the campaign for which to get the estimated number of recipients | |
664
+ | **fields_campaign_recipient_estimation** | [**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] |
665
+
666
+ ### Return type
667
+
668
+ **Hash&lt;String, Object&gt;**
669
+
670
+ ### Authorization
671
+
672
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
673
+
674
+ ### HTTP request headers
675
+
676
+ - **Content-Type**: Not defined
677
+ - **Accept**: application/json
678
+
679
+
680
+ ## get_campaign_recipient_estimation_job
681
+
682
+ > Hash&lt;String, Object&gt; get_campaign_recipient_estimation_job(id, opts)
683
+
684
+ Get Campaign Recipient Estimation Job
685
+
686
+ Retrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Read`
687
+
688
+ ### Examples
689
+
690
+ ```ruby
691
+ require 'time'
692
+ require 'klaviyo-api-sdk'
693
+ # setup authorization
694
+ KlaviyoAPI.configure do |config|
695
+ # Configure API key authorization: Klaviyo-API-Key
696
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
697
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
698
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
699
+ end
700
+
701
+ api_instance = KlaviyoAPI::CampaignsApi.new
702
+ id = 'id_example' # String | The ID of the campaign to get recipient estimation status
703
+ opts = {
704
+ fields_campaign_recipient_estimation_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
705
+ }
706
+
707
+ begin
708
+ # Get Campaign Recipient Estimation Job
709
+ result = api_instance.get_campaign_recipient_estimation_job(id, opts)
710
+ p result
711
+ rescue KlaviyoAPI::ApiError => e
712
+ puts "Error when calling CampaignsApi->get_campaign_recipient_estimation_job: #{e}"
713
+ end
714
+ ```
715
+
716
+ #### Using the get_campaign_recipient_estimation_job_with_http_info variant
717
+
718
+ This returns an Array which contains the response data, status code and headers.
719
+
720
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaign_recipient_estimation_job_with_http_info(id, opts)
721
+
722
+ ```ruby
723
+ begin
724
+ # Get Campaign Recipient Estimation Job
725
+ data, status_code, headers = api_instance.get_campaign_recipient_estimation_job_with_http_info(id, opts)
726
+ p status_code # => 2xx
727
+ p headers # => { ... }
728
+ p data # => Hash&lt;String, Object&gt;
729
+ rescue KlaviyoAPI::ApiError => e
730
+ puts "Error when calling CampaignsApi->get_campaign_recipient_estimation_job_with_http_info: #{e}"
731
+ end
732
+ ```
733
+
734
+ ### Parameters
735
+
736
+ | Name | Type | Description | Notes |
737
+ | ---- | ---- | ----------- | ----- |
738
+ | **id** | **String** | The ID of the campaign to get recipient estimation status | |
739
+ | **fields_campaign_recipient_estimation_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
740
+
741
+ ### Return type
742
+
743
+ **Hash&lt;String, Object&gt;**
744
+
745
+ ### Authorization
746
+
747
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
748
+
749
+ ### HTTP request headers
750
+
751
+ - **Content-Type**: Not defined
752
+ - **Accept**: application/json
753
+
754
+
755
+ ## get_campaign_relationships
756
+
757
+ > Hash&lt;String, Object&gt; get_campaign_relationships(id, related_resource)
758
+
759
+ Get Campaign Relationships
760
+
761
+ If the `related_resource` is `tags`, returns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Campaigns Read` `Tags Read`
762
+
763
+ ### Examples
764
+
765
+ ```ruby
766
+ require 'time'
767
+ require 'klaviyo-api-sdk'
768
+ # setup authorization
769
+ KlaviyoAPI.configure do |config|
770
+ # Configure API key authorization: Klaviyo-API-Key
771
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
772
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
773
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
774
+ end
775
+
776
+ api_instance = KlaviyoAPI::CampaignsApi.new
777
+ id = 'id_example' # String |
778
+ related_resource = 'related_resource_example' # String |
779
+
780
+ begin
781
+ # Get Campaign Relationships
782
+ result = api_instance.get_campaign_relationships(id, related_resource)
783
+ p result
784
+ rescue KlaviyoAPI::ApiError => e
785
+ puts "Error when calling CampaignsApi->get_campaign_relationships: #{e}"
786
+ end
787
+ ```
788
+
789
+ #### Using the get_campaign_relationships_with_http_info variant
790
+
791
+ This returns an Array which contains the response data, status code and headers.
792
+
793
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaign_relationships_with_http_info(id, related_resource)
794
+
795
+ ```ruby
796
+ begin
797
+ # Get Campaign Relationships
798
+ data, status_code, headers = api_instance.get_campaign_relationships_with_http_info(id, related_resource)
799
+ p status_code # => 2xx
800
+ p headers # => { ... }
801
+ p data # => Hash&lt;String, Object&gt;
802
+ rescue KlaviyoAPI::ApiError => e
803
+ puts "Error when calling CampaignsApi->get_campaign_relationships_with_http_info: #{e}"
804
+ end
805
+ ```
806
+
807
+ ### Parameters
808
+
809
+ | Name | Type | Description | Notes |
810
+ | ---- | ---- | ----------- | ----- |
811
+ | **id** | **String** | | |
812
+ | **related_resource** | **String** | | |
813
+
814
+ ### Return type
815
+
816
+ **Hash&lt;String, Object&gt;**
817
+
818
+ ### Authorization
819
+
820
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
821
+
822
+ ### HTTP request headers
823
+
824
+ - **Content-Type**: Not defined
825
+ - **Accept**: application/json
826
+
827
+
828
+ ## get_campaign_send_job
829
+
830
+ > Hash&lt;String, Object&gt; get_campaign_send_job(id, opts)
831
+
832
+ Get Campaign Send Job
833
+
834
+ Get a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Read`
835
+
836
+ ### Examples
837
+
838
+ ```ruby
839
+ require 'time'
840
+ require 'klaviyo-api-sdk'
841
+ # setup authorization
842
+ KlaviyoAPI.configure do |config|
843
+ # Configure API key authorization: Klaviyo-API-Key
844
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
845
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
846
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
847
+ end
848
+
849
+ api_instance = KlaviyoAPI::CampaignsApi.new
850
+ id = 'id_example' # String | The ID of the campaign to send
851
+ opts = {
852
+ fields_campaign_send_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
853
+ }
854
+
855
+ begin
856
+ # Get Campaign Send Job
857
+ result = api_instance.get_campaign_send_job(id, opts)
858
+ p result
859
+ rescue KlaviyoAPI::ApiError => e
860
+ puts "Error when calling CampaignsApi->get_campaign_send_job: #{e}"
861
+ end
862
+ ```
863
+
864
+ #### Using the get_campaign_send_job_with_http_info variant
865
+
866
+ This returns an Array which contains the response data, status code and headers.
867
+
868
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaign_send_job_with_http_info(id, opts)
869
+
870
+ ```ruby
871
+ begin
872
+ # Get Campaign Send Job
873
+ data, status_code, headers = api_instance.get_campaign_send_job_with_http_info(id, opts)
874
+ p status_code # => 2xx
875
+ p headers # => { ... }
876
+ p data # => Hash&lt;String, Object&gt;
877
+ rescue KlaviyoAPI::ApiError => e
878
+ puts "Error when calling CampaignsApi->get_campaign_send_job_with_http_info: #{e}"
879
+ end
880
+ ```
881
+
882
+ ### Parameters
883
+
884
+ | Name | Type | Description | Notes |
885
+ | ---- | ---- | ----------- | ----- |
886
+ | **id** | **String** | The ID of the campaign to send | |
887
+ | **fields_campaign_send_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
888
+
889
+ ### Return type
890
+
891
+ **Hash&lt;String, Object&gt;**
892
+
893
+ ### Authorization
894
+
895
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
896
+
897
+ ### HTTP request headers
898
+
899
+ - **Content-Type**: Not defined
900
+ - **Accept**: application/json
901
+
902
+
903
+ ## get_campaign_tags
904
+
905
+ > Hash&lt;String, Object&gt; get_campaign_tags(campaign_id, opts)
906
+
907
+ Get Campaign Tags
908
+
909
+ Return all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Campaigns Read` `Tags Read`
910
+
911
+ ### Examples
912
+
913
+ ```ruby
914
+ require 'time'
915
+ require 'klaviyo-api-sdk'
916
+ # setup authorization
917
+ KlaviyoAPI.configure do |config|
918
+ # Configure API key authorization: Klaviyo-API-Key
919
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
920
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
921
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
922
+ end
923
+
924
+ api_instance = KlaviyoAPI::CampaignsApi.new
925
+ campaign_id = 'campaign_id_example' # String |
926
+ opts = {
927
+ fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
928
+ }
929
+
930
+ begin
931
+ # Get Campaign Tags
932
+ result = api_instance.get_campaign_tags(campaign_id, opts)
933
+ p result
934
+ rescue KlaviyoAPI::ApiError => e
935
+ puts "Error when calling CampaignsApi->get_campaign_tags: #{e}"
936
+ end
937
+ ```
938
+
939
+ #### Using the get_campaign_tags_with_http_info variant
940
+
941
+ This returns an Array which contains the response data, status code and headers.
942
+
943
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaign_tags_with_http_info(campaign_id, opts)
944
+
945
+ ```ruby
946
+ begin
947
+ # Get Campaign Tags
948
+ data, status_code, headers = api_instance.get_campaign_tags_with_http_info(campaign_id, opts)
949
+ p status_code # => 2xx
950
+ p headers # => { ... }
951
+ p data # => Hash&lt;String, Object&gt;
952
+ rescue KlaviyoAPI::ApiError => e
953
+ puts "Error when calling CampaignsApi->get_campaign_tags_with_http_info: #{e}"
954
+ end
955
+ ```
956
+
957
+ ### Parameters
958
+
959
+ | Name | Type | Description | Notes |
960
+ | ---- | ---- | ----------- | ----- |
961
+ | **campaign_id** | **String** | | |
962
+ | **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] |
963
+
964
+ ### Return type
965
+
966
+ **Hash&lt;String, Object&gt;**
967
+
968
+ ### Authorization
969
+
970
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
971
+
972
+ ### HTTP request headers
973
+
974
+ - **Content-Type**: Not defined
975
+ - **Accept**: application/json
976
+
977
+
978
+ ## get_campaigns
979
+
980
+ > Hash&lt;String, Object&gt; get_campaigns(opts)
981
+
982
+ Get Campaigns
983
+
984
+ Returns some or all campaigns based on [optional] filters<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Read`
985
+
986
+ ### Examples
987
+
988
+ ```ruby
989
+ require 'time'
990
+ require 'klaviyo-api-sdk'
991
+ # setup authorization
992
+ KlaviyoAPI.configure do |config|
993
+ # Configure API key authorization: Klaviyo-API-Key
994
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
995
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
996
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
997
+ end
998
+
999
+ api_instance = KlaviyoAPI::CampaignsApi.new
1000
+ opts = {
1001
+ fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1002
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
1003
+ 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`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
1004
+ include: ['tags'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships
1005
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
1006
+ sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting
1007
+ }
1008
+
1009
+ begin
1010
+ # Get Campaigns
1011
+ result = api_instance.get_campaigns(opts)
1012
+ p result
1013
+ rescue KlaviyoAPI::ApiError => e
1014
+ puts "Error when calling CampaignsApi->get_campaigns: #{e}"
1015
+ end
1016
+ ```
1017
+
1018
+ #### Using the get_campaigns_with_http_info variant
1019
+
1020
+ This returns an Array which contains the response data, status code and headers.
1021
+
1022
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_campaigns_with_http_info(opts)
1023
+
1024
+ ```ruby
1025
+ begin
1026
+ # Get Campaigns
1027
+ data, status_code, headers = api_instance.get_campaigns_with_http_info(opts)
1028
+ p status_code # => 2xx
1029
+ p headers # => { ... }
1030
+ p data # => Hash&lt;String, Object&gt;
1031
+ rescue KlaviyoAPI::ApiError => e
1032
+ puts "Error when calling CampaignsApi->get_campaigns_with_http_info: #{e}"
1033
+ end
1034
+ ```
1035
+
1036
+ ### Parameters
1037
+
1038
+ | Name | Type | Description | Notes |
1039
+ | ---- | ---- | ----------- | ----- |
1040
+ | **fields_campaign** | [**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] |
1041
+ | **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] |
1042
+ | **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;contains&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;scheduled_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | [optional] |
1043
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships | [optional] |
1044
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
1045
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting | [optional] |
1046
+
1047
+ ### Return type
1048
+
1049
+ **Hash&lt;String, Object&gt;**
1050
+
1051
+ ### Authorization
1052
+
1053
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1054
+
1055
+ ### HTTP request headers
1056
+
1057
+ - **Content-Type**: Not defined
1058
+ - **Accept**: application/json
1059
+
1060
+
1061
+ ## update_campaign
1062
+
1063
+ > Hash&lt;String, Object&gt; update_campaign(id, campaign_partial_update_query)
1064
+
1065
+ Update Campaign
1066
+
1067
+ Update a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
1068
+
1069
+ ### Examples
1070
+
1071
+ ```ruby
1072
+ require 'time'
1073
+ require 'klaviyo-api-sdk'
1074
+ # setup authorization
1075
+ KlaviyoAPI.configure do |config|
1076
+ # Configure API key authorization: Klaviyo-API-Key
1077
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1078
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1079
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1080
+ end
1081
+
1082
+ api_instance = KlaviyoAPI::CampaignsApi.new
1083
+ id = 'id_example' # String | The campaign ID to be retrieved
1084
+ campaign_partial_update_query = KlaviyoAPI::CampaignPartialUpdateQuery.new({data: KlaviyoAPI::CampaignPartialUpdateQueryAsSubResource.new({type: 'campaign', id: 'id_example', attributes: KlaviyoAPI::CampaignPartialUpdateQueryAsSubResourceAttributes.new})}) # CampaignPartialUpdateQuery | Update a campaign and return it
1085
+
1086
+ begin
1087
+ # Update Campaign
1088
+ result = api_instance.update_campaign(id, campaign_partial_update_query)
1089
+ p result
1090
+ rescue KlaviyoAPI::ApiError => e
1091
+ puts "Error when calling CampaignsApi->update_campaign: #{e}"
1092
+ end
1093
+ ```
1094
+
1095
+ #### Using the update_campaign_with_http_info variant
1096
+
1097
+ This returns an Array which contains the response data, status code and headers.
1098
+
1099
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_campaign_with_http_info(id, campaign_partial_update_query)
1100
+
1101
+ ```ruby
1102
+ begin
1103
+ # Update Campaign
1104
+ data, status_code, headers = api_instance.update_campaign_with_http_info(id, campaign_partial_update_query)
1105
+ p status_code # => 2xx
1106
+ p headers # => { ... }
1107
+ p data # => Hash&lt;String, Object&gt;
1108
+ rescue KlaviyoAPI::ApiError => e
1109
+ puts "Error when calling CampaignsApi->update_campaign_with_http_info: #{e}"
1110
+ end
1111
+ ```
1112
+
1113
+ ### Parameters
1114
+
1115
+ | Name | Type | Description | Notes |
1116
+ | ---- | ---- | ----------- | ----- |
1117
+ | **id** | **String** | The campaign ID to be retrieved | |
1118
+ | **campaign_partial_update_query** | [**CampaignPartialUpdateQuery**](CampaignPartialUpdateQuery.md) | Update a campaign and return it | |
1119
+
1120
+ ### Return type
1121
+
1122
+ **Hash&lt;String, Object&gt;**
1123
+
1124
+ ### Authorization
1125
+
1126
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1127
+
1128
+ ### HTTP request headers
1129
+
1130
+ - **Content-Type**: application/json
1131
+ - **Accept**: application/json
1132
+
1133
+
1134
+ ## update_campaign_message
1135
+
1136
+ > Hash&lt;String, Object&gt; update_campaign_message(id, campaign_message_partial_update_query)
1137
+
1138
+ Update Campaign Message
1139
+
1140
+ Update a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
1141
+
1142
+ ### Examples
1143
+
1144
+ ```ruby
1145
+ require 'time'
1146
+ require 'klaviyo-api-sdk'
1147
+ # setup authorization
1148
+ KlaviyoAPI.configure do |config|
1149
+ # Configure API key authorization: Klaviyo-API-Key
1150
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1151
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1152
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1153
+ end
1154
+
1155
+ api_instance = KlaviyoAPI::CampaignsApi.new
1156
+ id = 'id_example' # String | The message ID to be retrieved
1157
+ campaign_message_partial_update_query = KlaviyoAPI::CampaignMessagePartialUpdateQuery.new({data: KlaviyoAPI::CampaignMessagePartialUpdateQueryAsSubResource.new({type: 'campaign-message', id: 'id_example', attributes: KlaviyoAPI::CampaignMessagePartialUpdateQueryAsSubResourceAttributes.new})}) # CampaignMessagePartialUpdateQuery | Update a message and return it
1158
+
1159
+ begin
1160
+ # Update Campaign Message
1161
+ result = api_instance.update_campaign_message(id, campaign_message_partial_update_query)
1162
+ p result
1163
+ rescue KlaviyoAPI::ApiError => e
1164
+ puts "Error when calling CampaignsApi->update_campaign_message: #{e}"
1165
+ end
1166
+ ```
1167
+
1168
+ #### Using the update_campaign_message_with_http_info variant
1169
+
1170
+ This returns an Array which contains the response data, status code and headers.
1171
+
1172
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_campaign_message_with_http_info(id, campaign_message_partial_update_query)
1173
+
1174
+ ```ruby
1175
+ begin
1176
+ # Update Campaign Message
1177
+ data, status_code, headers = api_instance.update_campaign_message_with_http_info(id, campaign_message_partial_update_query)
1178
+ p status_code # => 2xx
1179
+ p headers # => { ... }
1180
+ p data # => Hash&lt;String, Object&gt;
1181
+ rescue KlaviyoAPI::ApiError => e
1182
+ puts "Error when calling CampaignsApi->update_campaign_message_with_http_info: #{e}"
1183
+ end
1184
+ ```
1185
+
1186
+ ### Parameters
1187
+
1188
+ | Name | Type | Description | Notes |
1189
+ | ---- | ---- | ----------- | ----- |
1190
+ | **id** | **String** | The message ID to be retrieved | |
1191
+ | **campaign_message_partial_update_query** | [**CampaignMessagePartialUpdateQuery**](CampaignMessagePartialUpdateQuery.md) | Update a message and return it | |
1192
+
1193
+ ### Return type
1194
+
1195
+ **Hash&lt;String, Object&gt;**
1196
+
1197
+ ### Authorization
1198
+
1199
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1200
+
1201
+ ### HTTP request headers
1202
+
1203
+ - **Content-Type**: application/json
1204
+ - **Accept**: application/json
1205
+
1206
+
1207
+ ## update_campaign_send_job
1208
+
1209
+ > update_campaign_send_job(id, campaign_send_job_partial_update_query)
1210
+
1211
+ Update Campaign Send Job
1212
+
1213
+ Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Campaigns Write`
1214
+
1215
+ ### Examples
1216
+
1217
+ ```ruby
1218
+ require 'time'
1219
+ require 'klaviyo-api-sdk'
1220
+ # setup authorization
1221
+ KlaviyoAPI.configure do |config|
1222
+ # Configure API key authorization: Klaviyo-API-Key
1223
+ config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
1224
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1225
+ # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
1226
+ end
1227
+
1228
+ api_instance = KlaviyoAPI::CampaignsApi.new
1229
+ id = 'id_example' # String | The ID of the currently sending campaign to cancel or revert
1230
+ campaign_send_job_partial_update_query = KlaviyoAPI::CampaignSendJobPartialUpdateQuery.new({data: KlaviyoAPI::CampaignSendJobPartialUpdateQueryAsSubResource.new({type: 'campaign-send-job', id: 'id_example', attributes: KlaviyoAPI::CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.new({action: 'cancel'})})}) # CampaignSendJobPartialUpdateQuery | Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT
1231
+
1232
+ begin
1233
+ # Update Campaign Send Job
1234
+ api_instance.update_campaign_send_job(id, campaign_send_job_partial_update_query)
1235
+ rescue KlaviyoAPI::ApiError => e
1236
+ puts "Error when calling CampaignsApi->update_campaign_send_job: #{e}"
1237
+ end
1238
+ ```
1239
+
1240
+ #### Using the update_campaign_send_job_with_http_info variant
1241
+
1242
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1243
+
1244
+ > <Array(nil, Integer, Hash)> update_campaign_send_job_with_http_info(id, campaign_send_job_partial_update_query)
1245
+
1246
+ ```ruby
1247
+ begin
1248
+ # Update Campaign Send Job
1249
+ data, status_code, headers = api_instance.update_campaign_send_job_with_http_info(id, campaign_send_job_partial_update_query)
1250
+ p status_code # => 2xx
1251
+ p headers # => { ... }
1252
+ p data # => nil
1253
+ rescue KlaviyoAPI::ApiError => e
1254
+ puts "Error when calling CampaignsApi->update_campaign_send_job_with_http_info: #{e}"
1255
+ end
1256
+ ```
1257
+
1258
+ ### Parameters
1259
+
1260
+ | Name | Type | Description | Notes |
1261
+ | ---- | ---- | ----------- | ----- |
1262
+ | **id** | **String** | The ID of the currently sending campaign to cancel or revert | |
1263
+ | **campaign_send_job_partial_update_query** | [**CampaignSendJobPartialUpdateQuery**](CampaignSendJobPartialUpdateQuery.md) | Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT | |
1264
+
1265
+ ### Return type
1266
+
1267
+ nil (empty response body)
1268
+
1269
+ ### Authorization
1270
+
1271
+ [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
1272
+
1273
+ ### HTTP request headers
1274
+
1275
+ - **Content-Type**: application/json
1276
+ - **Accept**: application/json
1277
+