klaviyo-api-sdk 3.0.0 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (286) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -7
  3. data/README.md +243 -173
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +528 -57
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +290 -220
  8. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
  9. data/lib/klaviyo-api-sdk/api/events_api.rb +92 -92
  10. data/lib/klaviyo-api-sdk/api/flows_api.rb +105 -94
  11. data/lib/klaviyo-api-sdk/api/lists_api.rb +75 -40
  12. data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
  13. data/lib/klaviyo-api-sdk/api/profiles_api.rb +57 -57
  14. data/lib/klaviyo-api-sdk/api/segments_api.rb +71 -36
  15. data/lib/klaviyo-api-sdk/api/tags_api.rb +91 -63
  16. data/lib/klaviyo-api-sdk/api/templates_api.rb +25 -25
  17. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  18. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  19. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  20. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  21. data/lib/klaviyo-api-sdk/models/{profile_unsuppression_bulk_create_job_enum.rb → back_in_stock_subscription_enum.rb} +5 -5
  22. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  23. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
  24. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
  25. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  26. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
  27. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +16 -22
  28. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +227 -0
  29. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +106 -0
  30. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +106 -0
  31. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  32. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  33. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +11 -2
  34. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_attributes.rb +5 -20
  35. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +219 -0
  36. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +224 -0
  37. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +272 -0
  38. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object.rb → campaign_message_create_query_resource_object.rb} +6 -6
  39. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +253 -0
  40. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +106 -0
  41. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  42. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  43. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
  44. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +12 -3
  45. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  46. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  47. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +3 -3
  48. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  49. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
  50. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object_attributes.rb +1 -1
  51. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  52. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  53. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
  54. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object_attributes.rb +1 -1
  55. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  56. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  57. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
  58. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  59. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  60. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  61. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  62. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  63. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
  64. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +3 -6
  65. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +227 -0
  66. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  67. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
  68. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +3 -1
  69. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  70. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
  71. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +3 -6
  72. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +227 -0
  73. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  76. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  77. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
  78. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +3 -6
  79. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +227 -0
  80. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  81. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
  82. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  83. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships.rb +1 -1
  84. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items.rb +1 -1
  85. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_relationships_items_data_inner.rb +1 -1
  86. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  88. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  89. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  90. data/lib/klaviyo-api-sdk/models/catalog_item_category_op_data_inner.rb +1 -1
  91. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
  93. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +3 -6
  94. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +227 -0
  95. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  96. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
  97. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +3 -1
  98. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  99. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +3 -6
  103. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +227 -0
  104. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +3 -6
  109. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +227 -0
  110. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  111. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
  112. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
  113. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +3 -6
  119. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +227 -0
  120. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  121. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +2 -2
  122. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +3 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +219 -0
  124. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +224 -0
  125. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
  127. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +3 -6
  128. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +227 -0
  129. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +3 -6
  134. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +227 -0
  135. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
  137. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +13 -29
  141. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +224 -0
  142. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +248 -0
  144. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +230 -0
  145. data/lib/klaviyo-api-sdk/models/{content_sub_object.rb → email_content_sub_object.rb} +19 -39
  146. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +220 -0
  147. data/lib/klaviyo-api-sdk/models/{tracking_options_sub_object.rb → email_tracking_options_sub_object.rb} +18 -18
  148. data/lib/klaviyo-api-sdk/models/{event_create_query.rb → event_create_query_v2.rb} +5 -5
  149. data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object.rb → event_create_query_v2_resource_object.rb} +5 -5
  150. data/lib/klaviyo-api-sdk/models/{event_create_query_resource_object_attributes.rb → event_create_query_v2_resource_object_attributes.rb} +6 -7
  151. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +224 -0
  152. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +224 -0
  153. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
  157. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/get_create_variants_jobs5_xx_response.rb +1 -1
  159. data/lib/klaviyo-api-sdk/models/get_create_variants_jobs5_xx_response_errors_inner.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/get_create_variants_jobs5_xx_response_errors_inner_source.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  172. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
  173. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +3 -6
  174. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object.rb → metric_create_query_resource_object.rb} +6 -6
  175. data/lib/klaviyo-api-sdk/models/{metric_create_query.rb → metric_create_query_resource_object_attributes.rb} +4 -4
  176. data/lib/klaviyo-api-sdk/models/{profile_unsubscription_bulk_create_job_enum.rb → metric_enum.rb} +5 -5
  177. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +257 -0
  178. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +328 -0
  179. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +219 -0
  180. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +248 -0
  185. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +249 -0
  186. data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/profile_meta.rb +219 -0
  190. data/lib/klaviyo-api-sdk/models/{tag_create_query_resource_object_attributes.rb → profile_meta_patch_properties.rb} +28 -24
  191. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +106 -0
  192. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +11 -2
  194. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
  195. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +36 -0
  197. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +248 -0
  198. data/lib/klaviyo-api-sdk/models/{subscription.rb → profile_subscription_create_query_resource_object_attributes.rb} +17 -27
  199. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +238 -0
  200. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +230 -0
  201. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +36 -0
  203. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +238 -0
  204. data/lib/klaviyo-api-sdk/models/{suppression.rb → profile_suppression_create_query_resource_object_attributes.rb} +5 -10
  205. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +238 -0
  206. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +220 -0
  207. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +261 -0
  208. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -1
  212. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
  213. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query.rb → server_bis_subscription_create_query.rb} +5 -5
  214. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +247 -0
  215. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_resource_object_attributes.rb → server_bis_subscription_create_query_resource_object_attributes.rb} +46 -32
  216. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +224 -0
  217. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +219 -0
  218. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +224 -0
  219. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +272 -0
  220. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +220 -0
  221. data/lib/klaviyo-api-sdk/models/{send_options_sub_object.rb → sms_send_options_sub_object.rb} +4 -4
  222. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_resource_object_attributes.rb → sms_tracking_options_sub_object.rb} +23 -18
  223. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  227. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +11 -2
  228. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +14 -32
  229. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
  230. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query.rb → subscription_delete_job_create_query.rb} +5 -5
  231. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +247 -0
  232. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +224 -0
  233. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
  234. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +219 -0
  235. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +224 -0
  236. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +272 -0
  237. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +11 -14
  240. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +227 -0
  241. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +224 -0
  242. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +238 -0
  243. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +224 -0
  244. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +227 -0
  245. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +12 -3
  249. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +219 -0
  250. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +224 -0
  251. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +272 -0
  252. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  253. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
  261. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object_attributes.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -14
  272. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +2 -14
  275. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +2 -14
  279. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +5 -17
  282. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  284. data/lib/klaviyo-api-sdk/version.rb +1 -1
  285. data/lib/klaviyo-api-sdk.rb +81 -19
  286. metadata +82 -20
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
5
 
6
- The version of the OpenAPI document: 2023-06-15
6
+ The version of the OpenAPI document: 2023-07-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -20,7 +20,7 @@ module KlaviyoAPI
20
20
  @api_client = api_client
21
21
  end
22
22
  # Request Profile Deletion
23
- # Request a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `profile_id`. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted). For more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `data-privacy:write`
23
+ # Request a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `id`. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted). For more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `data-privacy:write`
24
24
  # @param data_privacy_create_deletion_job_query [DataPrivacyCreateDeletionJobQuery]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [nil]
@@ -30,7 +30,7 @@ module KlaviyoAPI
30
30
  end
31
31
 
32
32
  # Request Profile Deletion
33
- # Request a deletion for the profiles corresponding to one of the following identifiers: &#x60;email&#x60;, &#x60;phone_number&#x60;, or &#x60;profile_id&#x60;. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted). For more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;data-privacy:write&#x60;
33
+ # Request a deletion for the profiles corresponding to one of the following identifiers: &#x60;email&#x60;, &#x60;phone_number&#x60;, or &#x60;id&#x60;. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted). For more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;data-privacy:write&#x60;
34
34
  # @param data_privacy_create_deletion_job_query [DataPrivacyCreateDeletionJobQuery]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -51,7 +51,7 @@ module KlaviyoAPI
51
51
  # header parameters
52
52
  header_params = opts[:header_params] || {}
53
53
  # klaviyo api revision
54
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
54
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
55
55
  # HTTP header 'Accept' (if needed)
56
56
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
57
  # HTTP header 'Content-Type'
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
5
 
6
- The version of the OpenAPI document: 2023-06-15
6
+ The version of the OpenAPI document: 2023-07-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -20,27 +20,27 @@ module KlaviyoAPI
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create Event
23
- # Create an event. Events are created asynchronously. Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:write`
24
- # @param event_create_query [EventCreateQuery] Event to create.
23
+ # Create a new event to track a profile's activity. Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:write`
24
+ # @param event_create_query_v2 [EventCreateQueryV2]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [nil]
27
- def create_event(event_create_query, opts = {})
28
- create_event_with_http_info(event_create_query, opts)
27
+ def create_event(event_create_query_v2, opts = {})
28
+ create_event_with_http_info(event_create_query_v2, opts)
29
29
  nil
30
30
  end
31
31
 
32
32
  # Create Event
33
- # Create an event. Events are created asynchronously. Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;events:write&#x60;
34
- # @param event_create_query [EventCreateQuery] Event to create.
33
+ # Create a new event to track a profile&#39;s activity. Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;events:write&#x60;
34
+ # @param event_create_query_v2 [EventCreateQueryV2]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
- def create_event_with_http_info(event_create_query, opts = {})
37
+ def create_event_with_http_info(event_create_query_v2, opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: EventsApi.create_event ...'
40
40
  end
41
- # verify the required parameter 'event_create_query' is set
42
- if @api_client.config.client_side_validation && event_create_query.nil?
43
- fail ArgumentError, "Missing the required parameter 'event_create_query' when calling EventsApi.create_event"
41
+ # verify the required parameter 'event_create_query_v2' is set
42
+ if @api_client.config.client_side_validation && event_create_query_v2.nil?
43
+ fail ArgumentError, "Missing the required parameter 'event_create_query_v2' when calling EventsApi.create_event"
44
44
  end
45
45
  # resource path
46
46
  local_var_path = '/api/events/'
@@ -51,7 +51,7 @@ module KlaviyoAPI
51
51
  # header parameters
52
52
  header_params = opts[:header_params] || {}
53
53
  # klaviyo api revision
54
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
54
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
55
55
  # HTTP header 'Accept' (if needed)
56
56
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
57
  # HTTP header 'Content-Type'
@@ -64,7 +64,7 @@ module KlaviyoAPI
64
64
  form_params = opts[:form_params] || {}
65
65
 
66
66
  # http body (model)
67
- post_body = opts[:debug_body] || @api_client.object_to_http_body(event_create_query)
67
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(event_create_query_v2)
68
68
 
69
69
  # return_type
70
70
  return_type = opts[:debug_return_type]
@@ -93,10 +93,10 @@ module KlaviyoAPI
93
93
  # Get an event with the given event ID. Include parameters can be provided to get the following related resource data: `metrics`, `profiles`<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `events:read`
94
94
  # @param id [String] ID of the event
95
95
  # @param [Hash] opts the optional parameters
96
- # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
97
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
98
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
99
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
96
+ # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
97
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
98
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
99
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
100
100
  # @return [Hash<String, Object>]
101
101
  def get_event(id, opts = {})
102
102
  data, _status_code, _headers = get_event_with_http_info(id, opts)
@@ -107,10 +107,10 @@ module KlaviyoAPI
107
107
  # Get an event with the given event ID. Include parameters can be provided to get the following related resource data: &#x60;metrics&#x60;, &#x60;profiles&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;events:read&#x60;
108
108
  # @param id [String] ID of the event
109
109
  # @param [Hash] opts the optional parameters
110
- # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
111
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
112
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
113
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
110
+ # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
111
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
112
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
113
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
114
114
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
115
115
  def get_event_with_http_info(id, opts = {})
116
116
  if @api_client.config.debugging
@@ -120,7 +120,7 @@ module KlaviyoAPI
120
120
  if @api_client.config.client_side_validation && id.nil?
121
121
  fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event"
122
122
  end
123
- allowable_values = ["metric_id", "profile_id", "timestamp", "event_properties", "datetime", "uuid"]
123
+ allowable_values = ["timestamp", "event_properties", "datetime", "uuid"]
124
124
  if @api_client.config.client_side_validation && opts[:'fields_event'] && !opts[:'fields_event'].all? { |item| allowable_values.include?(item) }
125
125
  fail ArgumentError, "invalid value for \"fields_event\", must include one of #{allowable_values}"
126
126
  end
@@ -128,11 +128,11 @@ module KlaviyoAPI
128
128
  if @api_client.config.client_side_validation && opts[:'fields_metric'] && !opts[:'fields_metric'].all? { |item| allowable_values.include?(item) }
129
129
  fail ArgumentError, "invalid value for \"fields_metric\", must include one of #{allowable_values}"
130
130
  end
131
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail"]
131
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail"]
132
132
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
133
133
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
134
134
  end
135
- allowable_values = ["metrics", "profiles"]
135
+ allowable_values = ["metric", "profile"]
136
136
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
137
137
  fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
138
138
  end
@@ -149,7 +149,7 @@ module KlaviyoAPI
149
149
  # header parameters
150
150
  header_params = opts[:header_params] || {}
151
151
  # klaviyo api revision
152
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
152
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
153
153
  # HTTP header 'Accept' (if needed)
154
154
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
155
155
 
@@ -182,37 +182,37 @@ module KlaviyoAPI
182
182
  return data, status_code, headers
183
183
  end
184
184
 
185
- # Get Event Metrics
185
+ # Get Event Metric
186
186
  # Get the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `metrics:read`
187
187
  # @param id [String]
188
188
  # @param [Hash] opts the optional parameters
189
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
189
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
190
190
  # @return [Hash<String, Object>]
191
- def get_event_metrics(id, opts = {})
192
- data, _status_code, _headers = get_event_metrics_with_http_info(id, opts)
191
+ def get_event_metric(id, opts = {})
192
+ data, _status_code, _headers = get_event_metric_with_http_info(id, opts)
193
193
  data
194
194
  end
195
195
 
196
- # Get Event Metrics
196
+ # Get Event Metric
197
197
  # Get the metric for an event with the given event ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;events:read&#x60; &#x60;metrics:read&#x60;
198
198
  # @param id [String]
199
199
  # @param [Hash] opts the optional parameters
200
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
200
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
201
201
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
202
- def get_event_metrics_with_http_info(id, opts = {})
202
+ def get_event_metric_with_http_info(id, opts = {})
203
203
  if @api_client.config.debugging
204
- @api_client.config.logger.debug 'Calling API: EventsApi.get_event_metrics ...'
204
+ @api_client.config.logger.debug 'Calling API: EventsApi.get_event_metric ...'
205
205
  end
206
206
  # verify the required parameter 'id' is set
207
207
  if @api_client.config.client_side_validation && id.nil?
208
- fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event_metrics"
208
+ fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event_metric"
209
209
  end
210
210
  allowable_values = ["name", "created", "updated", "integration"]
211
211
  if @api_client.config.client_side_validation && opts[:'fields_metric'] && !opts[:'fields_metric'].all? { |item| allowable_values.include?(item) }
212
212
  fail ArgumentError, "invalid value for \"fields_metric\", must include one of #{allowable_values}"
213
213
  end
214
214
  # resource path
215
- local_var_path = '/api/events/{id}/metrics/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
215
+ local_var_path = '/api/events/{id}/metric/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
216
216
 
217
217
  # query parameters
218
218
  query_params = opts[:query_params] || {}
@@ -221,7 +221,7 @@ module KlaviyoAPI
221
221
  # header parameters
222
222
  header_params = opts[:header_params] || {}
223
223
  # klaviyo api revision
224
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
224
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
225
225
  # HTTP header 'Accept' (if needed)
226
226
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
227
227
 
@@ -238,7 +238,7 @@ module KlaviyoAPI
238
238
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
239
239
 
240
240
  new_options = opts.merge(
241
- :operation => :"EventsApi.get_event_metrics",
241
+ :operation => :"EventsApi.get_event_metric",
242
242
  :header_params => header_params,
243
243
  :query_params => query_params,
244
244
  :form_params => form_params,
@@ -249,48 +249,48 @@ module KlaviyoAPI
249
249
 
250
250
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
251
251
  if @api_client.config.debugging
252
- @api_client.config.logger.debug "API called: EventsApi#get_event_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
252
+ @api_client.config.logger.debug "API called: EventsApi#get_event_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
253
253
  end
254
254
  return data, status_code, headers
255
255
  end
256
256
 
257
- # Get Event Profiles
257
+ # Get Event Profile
258
258
  # Get the profile associated with an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `profiles:read`
259
259
  # @param id [String]
260
260
  # @param [Hash] opts the optional parameters
261
261
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
262
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
262
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
263
263
  # @return [Hash<String, Object>]
264
- def get_event_profiles(id, opts = {})
265
- data, _status_code, _headers = get_event_profiles_with_http_info(id, opts)
264
+ def get_event_profile(id, opts = {})
265
+ data, _status_code, _headers = get_event_profile_with_http_info(id, opts)
266
266
  data
267
267
  end
268
268
 
269
- # Get Event Profiles
269
+ # Get Event Profile
270
270
  # Get the profile associated with an event with the given event ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;events:read&#x60; &#x60;profiles:read&#x60;
271
271
  # @param id [String]
272
272
  # @param [Hash] opts the optional parameters
273
273
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;predictive_analytics&#39;
274
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
274
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
275
275
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
276
- def get_event_profiles_with_http_info(id, opts = {})
276
+ def get_event_profile_with_http_info(id, opts = {})
277
277
  if @api_client.config.debugging
278
- @api_client.config.logger.debug 'Calling API: EventsApi.get_event_profiles ...'
278
+ @api_client.config.logger.debug 'Calling API: EventsApi.get_event_profile ...'
279
279
  end
280
280
  # verify the required parameter 'id' is set
281
281
  if @api_client.config.client_side_validation && id.nil?
282
- fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event_profiles"
282
+ fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event_profile"
283
283
  end
284
284
  allowable_values = ["predictive_analytics"]
285
285
  if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
286
286
  fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
287
287
  end
288
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
288
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
289
289
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
290
290
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
291
291
  end
292
292
  # resource path
293
- local_var_path = '/api/events/{id}/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
293
+ local_var_path = '/api/events/{id}/profile/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
294
294
 
295
295
  # query parameters
296
296
  query_params = opts[:query_params] || {}
@@ -300,7 +300,7 @@ module KlaviyoAPI
300
300
  # header parameters
301
301
  header_params = opts[:header_params] || {}
302
302
  # klaviyo api revision
303
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
303
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
304
304
  # HTTP header 'Accept' (if needed)
305
305
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
306
306
 
@@ -317,7 +317,7 @@ module KlaviyoAPI
317
317
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
318
318
 
319
319
  new_options = opts.merge(
320
- :operation => :"EventsApi.get_event_profiles",
320
+ :operation => :"EventsApi.get_event_profile",
321
321
  :header_params => header_params,
322
322
  :query_params => query_params,
323
323
  :form_params => form_params,
@@ -328,36 +328,36 @@ module KlaviyoAPI
328
328
 
329
329
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
330
330
  if @api_client.config.debugging
331
- @api_client.config.logger.debug "API called: EventsApi#get_event_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
331
+ @api_client.config.logger.debug "API called: EventsApi#get_event_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
332
332
  end
333
333
  return data, status_code, headers
334
334
  end
335
335
 
336
- # Get Event Relationships Metrics
336
+ # Get Event Relationships Metric
337
337
  # Get a list of related Metrics for an Event<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `metrics:read`
338
338
  # @param id [String]
339
339
  # @param [Hash] opts the optional parameters
340
340
  # @return [Hash<String, Object>]
341
- def get_event_relationships_metrics(id, opts = {})
342
- data, _status_code, _headers = get_event_relationships_metrics_with_http_info(id, opts)
341
+ def get_event_relationships_metric(id, opts = {})
342
+ data, _status_code, _headers = get_event_relationships_metric_with_http_info(id, opts)
343
343
  data
344
344
  end
345
345
 
346
- # Get Event Relationships Metrics
346
+ # Get Event Relationships Metric
347
347
  # Get a list of related Metrics for an Event&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;events:read&#x60; &#x60;metrics:read&#x60;
348
348
  # @param id [String]
349
349
  # @param [Hash] opts the optional parameters
350
350
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
351
- def get_event_relationships_metrics_with_http_info(id, opts = {})
351
+ def get_event_relationships_metric_with_http_info(id, opts = {})
352
352
  if @api_client.config.debugging
353
- @api_client.config.logger.debug 'Calling API: EventsApi.get_event_relationships_metrics ...'
353
+ @api_client.config.logger.debug 'Calling API: EventsApi.get_event_relationships_metric ...'
354
354
  end
355
355
  # verify the required parameter 'id' is set
356
356
  if @api_client.config.client_side_validation && id.nil?
357
- fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event_relationships_metrics"
357
+ fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event_relationships_metric"
358
358
  end
359
359
  # resource path
360
- local_var_path = '/api/events/{id}/relationships/metrics/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
360
+ local_var_path = '/api/events/{id}/relationships/metric/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
361
361
 
362
362
  # query parameters
363
363
  query_params = opts[:query_params] || {}
@@ -365,7 +365,7 @@ module KlaviyoAPI
365
365
  # header parameters
366
366
  header_params = opts[:header_params] || {}
367
367
  # klaviyo api revision
368
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
368
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
369
369
  # HTTP header 'Accept' (if needed)
370
370
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
371
371
 
@@ -382,7 +382,7 @@ module KlaviyoAPI
382
382
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
383
383
 
384
384
  new_options = opts.merge(
385
- :operation => :"EventsApi.get_event_relationships_metrics",
385
+ :operation => :"EventsApi.get_event_relationships_metric",
386
386
  :header_params => header_params,
387
387
  :query_params => query_params,
388
388
  :form_params => form_params,
@@ -393,36 +393,36 @@ module KlaviyoAPI
393
393
 
394
394
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
395
395
  if @api_client.config.debugging
396
- @api_client.config.logger.debug "API called: EventsApi#get_event_relationships_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
396
+ @api_client.config.logger.debug "API called: EventsApi#get_event_relationships_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
397
397
  end
398
398
  return data, status_code, headers
399
399
  end
400
400
 
401
- # Get Event Relationships Profiles
401
+ # Get Event Relationships Profile
402
402
  # Get profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `profiles:read`
403
403
  # @param id [String]
404
404
  # @param [Hash] opts the optional parameters
405
405
  # @return [Hash<String, Object>]
406
- def get_event_relationships_profiles(id, opts = {})
407
- data, _status_code, _headers = get_event_relationships_profiles_with_http_info(id, opts)
406
+ def get_event_relationships_profile(id, opts = {})
407
+ data, _status_code, _headers = get_event_relationships_profile_with_http_info(id, opts)
408
408
  data
409
409
  end
410
410
 
411
- # Get Event Relationships Profiles
411
+ # Get Event Relationships Profile
412
412
  # Get profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;events:read&#x60; &#x60;profiles:read&#x60;
413
413
  # @param id [String]
414
414
  # @param [Hash] opts the optional parameters
415
415
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
416
- def get_event_relationships_profiles_with_http_info(id, opts = {})
416
+ def get_event_relationships_profile_with_http_info(id, opts = {})
417
417
  if @api_client.config.debugging
418
- @api_client.config.logger.debug 'Calling API: EventsApi.get_event_relationships_profiles ...'
418
+ @api_client.config.logger.debug 'Calling API: EventsApi.get_event_relationships_profile ...'
419
419
  end
420
420
  # verify the required parameter 'id' is set
421
421
  if @api_client.config.client_side_validation && id.nil?
422
- fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event_relationships_profiles"
422
+ fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_event_relationships_profile"
423
423
  end
424
424
  # resource path
425
- local_var_path = '/api/events/{id}/relationships/profiles/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
425
+ local_var_path = '/api/events/{id}/relationships/profile/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
426
426
 
427
427
  # query parameters
428
428
  query_params = opts[:query_params] || {}
@@ -430,7 +430,7 @@ module KlaviyoAPI
430
430
  # header parameters
431
431
  header_params = opts[:header_params] || {}
432
432
  # klaviyo api revision
433
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
433
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
434
434
  # HTTP header 'Accept' (if needed)
435
435
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
436
436
 
@@ -447,7 +447,7 @@ module KlaviyoAPI
447
447
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
448
448
 
449
449
  new_options = opts.merge(
450
- :operation => :"EventsApi.get_event_relationships_profiles",
450
+ :operation => :"EventsApi.get_event_relationships_profile",
451
451
  :header_params => header_params,
452
452
  :query_params => query_params,
453
453
  :form_params => form_params,
@@ -458,7 +458,7 @@ module KlaviyoAPI
458
458
 
459
459
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
460
460
  if @api_client.config.debugging
461
- @api_client.config.logger.debug "API called: EventsApi#get_event_relationships_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
461
+ @api_client.config.logger.debug "API called: EventsApi#get_event_relationships_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
462
462
  end
463
463
  return data, status_code, headers
464
464
  end
@@ -466,13 +466,13 @@ module KlaviyoAPI
466
466
  # Get Events
467
467
  # Get all events in an account Requests can be sorted by the following fields: `datetime`, `timestamp` Include parameters can be provided to get the following related resource data: `metrics`, `profiles` Returns a maximum of 200 events per page.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read`
468
468
  # @param [Hash] opts the optional parameters
469
- # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
470
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
471
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
472
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;metric_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;profile_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;datetime&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
473
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
474
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
475
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
469
+ # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
470
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
471
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
472
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;metric_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;profile_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;datetime&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
473
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
474
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
475
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
476
476
  # @return [Hash<String, Object>]
477
477
  def get_events(opts = {})
478
478
  data, _status_code, _headers = get_events_with_http_info(opts)
@@ -482,19 +482,19 @@ module KlaviyoAPI
482
482
  # Get Events
483
483
  # Get all events in an account Requests can be sorted by the following fields: &#x60;datetime&#x60;, &#x60;timestamp&#x60; Include parameters can be provided to get the following related resource data: &#x60;metrics&#x60;, &#x60;profiles&#x60; Returns a maximum of 200 events per page.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60; **Scopes:** &#x60;events:read&#x60;
484
484
  # @param [Hash] opts the optional parameters
485
- # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
486
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
487
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets
488
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;metric_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;profile_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;datetime&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
489
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships
490
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#pagination
491
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sorting
485
+ # @option opts [Array<String>] :fields_event For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
486
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
487
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets
488
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;metric_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;profile_id&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;datetime&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;timestamp&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
489
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships
490
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination
491
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting
492
492
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
493
493
  def get_events_with_http_info(opts = {})
494
494
  if @api_client.config.debugging
495
495
  @api_client.config.logger.debug 'Calling API: EventsApi.get_events ...'
496
496
  end
497
- allowable_values = ["metric_id", "profile_id", "timestamp", "event_properties", "datetime", "uuid"]
497
+ allowable_values = ["timestamp", "event_properties", "datetime", "uuid"]
498
498
  if @api_client.config.client_side_validation && opts[:'fields_event'] && !opts[:'fields_event'].all? { |item| allowable_values.include?(item) }
499
499
  fail ArgumentError, "invalid value for \"fields_event\", must include one of #{allowable_values}"
500
500
  end
@@ -502,11 +502,11 @@ module KlaviyoAPI
502
502
  if @api_client.config.client_side_validation && opts[:'fields_metric'] && !opts[:'fields_metric'].all? { |item| allowable_values.include?(item) }
503
503
  fail ArgumentError, "invalid value for \"fields_metric\", must include one of #{allowable_values}"
504
504
  end
505
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.suppressions.reason", "subscriptions.email.marketing.suppressions.timestamp", "subscriptions.email.marketing.list_suppressions", "subscriptions.email.marketing.list_suppressions.list_id", "subscriptions.email.marketing.list_suppressions.reason", "subscriptions.email.marketing.list_suppressions.timestamp", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail"]
505
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "properties", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.timestamp", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppressions", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail"]
506
506
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
507
507
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
508
508
  end
509
- allowable_values = ["metrics", "profiles"]
509
+ allowable_values = ["metric", "profile"]
510
510
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
511
511
  fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
512
512
  end
@@ -530,7 +530,7 @@ module KlaviyoAPI
530
530
  # header parameters
531
531
  header_params = opts[:header_params] || {}
532
532
  # klaviyo api revision
533
- header_params['revision'] = ENV['API_REVISION'] || "2023-06-15"
533
+ header_params['revision'] = ENV['API_REVISION'] || "2023-07-15"
534
534
  # HTTP header 'Accept' (if needed)
535
535
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
536
536