klaviyo-api-sdk 5.1.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (748) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +257 -209
  3. data/docs/AccountsApi.md +4 -4
  4. data/docs/CampaignValuesReportEnum.md +15 -0
  5. data/docs/CampaignValuesRequestDTO.md +18 -0
  6. data/docs/CampaignValuesRequestDTOResourceObject.md +20 -0
  7. data/docs/CampaignValuesRequestDTOResourceObjectAttributes.md +24 -0
  8. data/docs/CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md +49 -0
  9. data/docs/CampaignsApi.md +50 -50
  10. data/docs/CatalogsApi.md +166 -166
  11. data/docs/CouponsApi.md +44 -44
  12. data/docs/CustomTimeframe.md +20 -0
  13. data/docs/EventsApi.md +26 -26
  14. data/docs/FlowSeriesReportEnum.md +15 -0
  15. data/docs/FlowSeriesRequestDTO.md +18 -0
  16. data/docs/FlowSeriesRequestDTOResourceObject.md +20 -0
  17. data/docs/FlowSeriesRequestDTOResourceObjectAttributes.md +26 -0
  18. data/docs/FlowValuesReportEnum.md +15 -0
  19. data/docs/FlowValuesRequestDTO.md +18 -0
  20. data/docs/FlowValuesRequestDTOResourceObject.md +20 -0
  21. data/docs/FlowValuesRequestDTOResourceObjectAttributes.md +24 -0
  22. data/docs/FlowsApi.md +70 -70
  23. data/docs/ImagesApi.md +10 -10
  24. data/docs/ListsApi.md +34 -34
  25. data/docs/MarketingSubscriptionParameters.md +3 -1
  26. data/docs/MetricsApi.md +8 -8
  27. data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +1 -1
  28. data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +1 -1
  29. data/docs/ProfileUpsertQuery.md +18 -0
  30. data/docs/ProfileUpsertQueryResourceObject.md +3 -1
  31. data/docs/ProfileUpsertQueryResourceObjectAttributes.md +1 -3
  32. data/docs/ProfilesApi.md +126 -54
  33. data/docs/ReportingApi.md +235 -0
  34. data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +1 -1
  35. data/docs/SegmentsApi.md +35 -35
  36. data/docs/TagsApi.md +32 -32
  37. data/docs/TemplatesApi.md +11 -11
  38. data/docs/Timeframe.md +18 -0
  39. data/klaviyo-api-sdk.gemspec +2 -2
  40. data/lib/klaviyo-api-sdk/api/accounts_api.rb +7 -7
  41. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +78 -78
  42. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +221 -221
  43. data/lib/klaviyo-api-sdk/api/coupons_api.rb +62 -62
  44. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  45. data/lib/klaviyo-api-sdk/api/events_api.rb +36 -36
  46. data/lib/klaviyo-api-sdk/api/flows_api.rb +88 -88
  47. data/lib/klaviyo-api-sdk/api/images_api.rb +16 -16
  48. data/lib/klaviyo-api-sdk/api/lists_api.rb +50 -50
  49. data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
  50. data/lib/klaviyo-api-sdk/api/profiles_api.rb +153 -83
  51. data/lib/klaviyo-api-sdk/api/reporting_api.rb +241 -0
  52. data/lib/klaviyo-api-sdk/api/segments_api.rb +44 -44
  53. data/lib/klaviyo-api-sdk/api/tags_api.rb +59 -59
  54. data/lib/klaviyo-api-sdk/api/templates_api.rb +20 -20
  55. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  56. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  57. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  58. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  59. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  60. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  61. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
  62. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +1 -1
  63. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  64. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
  65. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +1 -1
  66. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  67. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
  68. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
  69. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  70. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  71. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -1
  72. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -1
  73. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -1
  74. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
  75. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
  76. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +1 -1
  77. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
  78. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  79. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  80. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
  81. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +1 -1
  82. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  83. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  84. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +1 -1
  85. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  86. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
  87. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  88. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  89. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
  90. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  91. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  92. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
  93. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  94. data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +36 -0
  95. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +224 -0
  96. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +238 -0
  97. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +288 -0
  98. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
  99. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  100. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  101. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  102. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  103. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
  104. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  105. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  106. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  107. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
  108. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +1 -1
  109. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
  110. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -1
  111. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
  112. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  113. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
  114. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  115. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  116. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  117. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  118. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  119. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  120. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
  121. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  123. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  124. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  127. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  130. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  135. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
  136. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +1 -1
  137. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  141. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
  142. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  145. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  146. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  149. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  151. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
  152. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  157. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  159. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  160. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  161. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -1
  162. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +1 -1
  163. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  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_resource_object.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  177. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
  178. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
  185. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
  190. data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
  192. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +1 -1
  194. data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
  195. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +1 -1
  201. data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +238 -0
  202. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  203. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  206. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  207. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +1 -1
  208. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/device_metadata.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +1 -1
  212. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
  213. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +1 -1
  214. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  215. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
  216. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
  217. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  218. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +36 -0
  222. data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +224 -0
  223. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +238 -0
  224. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +315 -0
  225. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  226. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
  227. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  228. data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +36 -0
  229. data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +224 -0
  230. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +238 -0
  231. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +288 -0
  232. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
  235. data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
  236. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +1 -1
  242. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  243. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
  244. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  245. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  249. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  250. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
  251. data/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb +15 -5
  252. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  253. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +1 -1
  258. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +1 -1
  261. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
  265. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +1 -1
  266. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
  272. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
  273. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
  274. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -1
  275. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
  276. data/lib/klaviyo-api-sdk/models/profile_location.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  278. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  279. data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
  280. data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -1
  283. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -1
  284. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
  285. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +1 -1
  287. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  288. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  289. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
  290. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +1 -1
  291. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  292. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  293. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +1 -1
  294. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +2 -2
  295. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
  296. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +2 -2
  297. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  298. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  299. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
  300. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +1 -1
  301. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +224 -0
  304. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +14 -5
  305. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +5 -14
  306. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
  307. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
  308. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +1 -1
  309. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +1 -1
  310. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
  311. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +1 -1
  312. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  313. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  314. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
  315. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +1 -6
  316. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
  317. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  318. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -1
  319. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +1 -1
  320. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  321. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -1
  322. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -1
  323. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
  324. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +1 -1
  325. data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +1 -1
  326. data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
  327. data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +1 -1
  328. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +1 -1
  329. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  330. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
  331. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  332. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
  333. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +1 -1
  334. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  335. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
  336. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -1
  337. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  338. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  339. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
  340. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  341. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  342. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
  343. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -1
  344. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  345. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +1 -1
  348. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  349. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  350. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +1 -1
  351. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  353. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  354. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  355. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  356. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
  358. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  359. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -1
  360. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  363. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  364. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  365. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
  366. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +1 -1
  367. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  369. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
  370. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +1 -1
  371. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  372. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  373. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  374. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  375. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  376. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
  377. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  378. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
  379. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +1 -1
  380. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  381. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
  382. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
  383. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  384. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  385. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
  386. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
  387. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  388. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
  389. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +1 -1
  390. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  391. data/lib/klaviyo-api-sdk/models/timeframe.rb +259 -0
  392. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  393. data/lib/klaviyo-api-sdk/version.rb +1 -1
  394. data/lib/klaviyo-api-sdk.rb +18 -1
  395. data/spec/api/accounts_api_spec.rb +3 -3
  396. data/spec/api/campaigns_api_spec.rb +26 -26
  397. data/spec/api/catalogs_api_spec.rb +84 -84
  398. data/spec/api/coupons_api_spec.rb +23 -23
  399. data/spec/api/data_privacy_api_spec.rb +1 -1
  400. data/spec/api/events_api_spec.rb +14 -14
  401. data/spec/api/flows_api_spec.rb +36 -36
  402. data/spec/api/images_api_spec.rb +6 -6
  403. data/spec/api/lists_api_spec.rb +19 -19
  404. data/spec/api/metrics_api_spec.rb +5 -5
  405. data/spec/api/profiles_api_spec.rb +41 -29
  406. data/spec/api/reporting_api_spec.rb +74 -0
  407. data/spec/api/segments_api_spec.rb +19 -19
  408. data/spec/api/tags_api_spec.rb +17 -17
  409. data/spec/api/templates_api_spec.rb +7 -7
  410. data/spec/api_client_spec.rb +1 -1
  411. data/spec/configuration_spec.rb +1 -1
  412. data/spec/models/audiences_sub_object_spec.rb +1 -1
  413. data/spec/models/back_in_stock_subscription_enum_spec.rb +1 -1
  414. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +1 -1
  415. data/spec/models/campaign_clone_query_resource_object_spec.rb +1 -1
  416. data/spec/models/campaign_clone_query_spec.rb +1 -1
  417. data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +1 -1
  418. data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +1 -1
  419. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +1 -1
  420. data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +1 -1
  421. data/spec/models/campaign_create_query_resource_object_spec.rb +1 -1
  422. data/spec/models/campaign_create_query_spec.rb +1 -1
  423. data/spec/models/campaign_enum_spec.rb +1 -1
  424. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +1 -1
  425. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +1 -1
  426. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +1 -1
  427. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +1 -1
  428. data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
  429. data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +1 -1
  430. data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +1 -1
  431. data/spec/models/campaign_message_create_query_resource_object_spec.rb +1 -1
  432. data/spec/models/campaign_message_enum_spec.rb +1 -1
  433. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +1 -1
  434. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +1 -1
  435. data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
  436. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +1 -1
  437. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +1 -1
  438. data/spec/models/campaign_partial_update_query_spec.rb +1 -1
  439. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +1 -1
  440. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +1 -1
  441. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +1 -1
  442. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +1 -1
  443. data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
  444. data/spec/models/campaign_send_job_enum_spec.rb +1 -1
  445. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +1 -1
  446. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +1 -1
  447. data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
  448. data/spec/models/campaign_values_report_enum_spec.rb +28 -0
  449. data/spec/models/campaign_values_request_dto_resource_object_attributes_spec.rb +56 -0
  450. data/spec/models/campaign_values_request_dto_resource_object_attributes_timeframe_spec.rb +31 -0
  451. data/spec/models/campaign_values_request_dto_resource_object_spec.rb +40 -0
  452. data/spec/models/campaign_values_request_dto_spec.rb +34 -0
  453. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +1 -1
  454. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +1 -1
  455. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +1 -1
  456. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  457. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  458. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +1 -1
  459. data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
  460. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +1 -1
  461. data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +1 -1
  462. data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +1 -1
  463. data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +1 -1
  464. data/spec/models/catalog_category_create_query_resource_object_spec.rb +1 -1
  465. data/spec/models/catalog_category_create_query_spec.rb +1 -1
  466. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  467. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  468. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +1 -1
  469. data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
  470. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +1 -1
  471. data/spec/models/catalog_category_enum_spec.rb +1 -1
  472. data/spec/models/catalog_category_item_op_spec.rb +1 -1
  473. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  474. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  475. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +1 -1
  476. data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
  477. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +1 -1
  478. data/spec/models/catalog_category_update_query_resource_object_spec.rb +1 -1
  479. data/spec/models/catalog_category_update_query_spec.rb +1 -1
  480. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +1 -1
  481. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +1 -1
  482. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +1 -1
  483. data/spec/models/catalog_item_category_op_spec.rb +1 -1
  484. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  485. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  486. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +1 -1
  487. data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
  488. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +1 -1
  489. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +1 -1
  490. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +1 -1
  491. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +1 -1
  492. data/spec/models/catalog_item_create_query_resource_object_spec.rb +1 -1
  493. data/spec/models/catalog_item_create_query_spec.rb +1 -1
  494. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  495. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  496. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +1 -1
  497. data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
  498. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +1 -1
  499. data/spec/models/catalog_item_enum_spec.rb +1 -1
  500. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  501. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  502. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +1 -1
  503. data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
  504. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +1 -1
  505. data/spec/models/catalog_item_update_query_resource_object_spec.rb +1 -1
  506. data/spec/models/catalog_item_update_query_spec.rb +1 -1
  507. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +1 -1
  508. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +1 -1
  509. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +1 -1
  510. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  511. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  512. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +1 -1
  513. data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
  514. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +1 -1
  515. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +1 -1
  516. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +1 -1
  517. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +1 -1
  518. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +1 -1
  519. data/spec/models/catalog_variant_create_query_spec.rb +1 -1
  520. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  521. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  522. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +1 -1
  523. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
  524. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +1 -1
  525. data/spec/models/catalog_variant_enum_spec.rb +1 -1
  526. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  527. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  528. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +1 -1
  529. data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
  530. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +1 -1
  531. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +1 -1
  532. data/spec/models/catalog_variant_update_query_spec.rb +1 -1
  533. data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +1 -1
  534. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +1 -1
  535. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  536. data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +1 -1
  537. data/spec/models/coupon_code_create_job_create_query_spec.rb +1 -1
  538. data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +1 -1
  539. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +1 -1
  540. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +1 -1
  541. data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +1 -1
  542. data/spec/models/coupon_code_create_query_resource_object_spec.rb +1 -1
  543. data/spec/models/coupon_code_create_query_spec.rb +1 -1
  544. data/spec/models/coupon_code_enum_spec.rb +1 -1
  545. data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +1 -1
  546. data/spec/models/coupon_code_update_query_resource_object_spec.rb +1 -1
  547. data/spec/models/coupon_code_update_query_spec.rb +1 -1
  548. data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +1 -1
  549. data/spec/models/coupon_create_query_resource_object_spec.rb +1 -1
  550. data/spec/models/coupon_create_query_spec.rb +1 -1
  551. data/spec/models/coupon_enum_spec.rb +1 -1
  552. data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +1 -1
  553. data/spec/models/coupon_update_query_resource_object_spec.rb +1 -1
  554. data/spec/models/coupon_update_query_spec.rb +1 -1
  555. data/spec/models/custom_timeframe_spec.rb +40 -0
  556. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +1 -1
  557. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +1 -1
  558. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +1 -1
  559. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
  560. data/spec/models/data_privacy_deletion_job_enum_spec.rb +1 -1
  561. data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +1 -1
  562. data/spec/models/data_privacy_profile_query_resource_object_spec.rb +1 -1
  563. data/spec/models/device_metadata_spec.rb +1 -1
  564. data/spec/models/email_content_sub_object_spec.rb +1 -1
  565. data/spec/models/email_send_options_sub_object_spec.rb +1 -1
  566. data/spec/models/email_subscription_parameters_spec.rb +1 -1
  567. data/spec/models/email_tracking_options_sub_object_spec.rb +1 -1
  568. data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +1 -1
  569. data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +1 -1
  570. data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +1 -1
  571. data/spec/models/event_create_query_v2_resource_object_spec.rb +1 -1
  572. data/spec/models/event_create_query_v2_spec.rb +1 -1
  573. data/spec/models/event_enum_spec.rb +1 -1
  574. data/spec/models/flow_enum_spec.rb +1 -1
  575. data/spec/models/flow_series_report_enum_spec.rb +28 -0
  576. data/spec/models/flow_series_request_dto_resource_object_attributes_spec.rb +66 -0
  577. data/spec/models/flow_series_request_dto_resource_object_spec.rb +40 -0
  578. data/spec/models/flow_series_request_dto_spec.rb +34 -0
  579. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +1 -1
  580. data/spec/models/flow_update_query_resource_object_spec.rb +1 -1
  581. data/spec/models/flow_update_query_spec.rb +1 -1
  582. data/spec/models/flow_values_report_enum_spec.rb +28 -0
  583. data/spec/models/flow_values_request_dto_resource_object_attributes_spec.rb +56 -0
  584. data/spec/models/flow_values_request_dto_resource_object_spec.rb +40 -0
  585. data/spec/models/flow_values_request_dto_spec.rb +34 -0
  586. data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +1 -1
  587. data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +1 -1
  588. data/spec/models/get_accounts4_xx_response_spec.rb +1 -1
  589. data/spec/models/image_create_query_resource_object_attributes_spec.rb +1 -1
  590. data/spec/models/image_create_query_resource_object_spec.rb +1 -1
  591. data/spec/models/image_create_query_spec.rb +1 -1
  592. data/spec/models/image_enum_spec.rb +1 -1
  593. data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +1 -1
  594. data/spec/models/image_partial_update_query_resource_object_spec.rb +1 -1
  595. data/spec/models/image_partial_update_query_spec.rb +1 -1
  596. data/spec/models/list_create_query_resource_object_attributes_spec.rb +1 -1
  597. data/spec/models/list_create_query_resource_object_spec.rb +1 -1
  598. data/spec/models/list_create_query_spec.rb +1 -1
  599. data/spec/models/list_enum_spec.rb +1 -1
  600. data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
  601. data/spec/models/list_members_add_query_spec.rb +1 -1
  602. data/spec/models/list_members_delete_query_spec.rb +1 -1
  603. data/spec/models/list_partial_update_query_resource_object_spec.rb +1 -1
  604. data/spec/models/list_partial_update_query_spec.rb +1 -1
  605. data/spec/models/marketing_subscription_parameters_spec.rb +7 -1
  606. data/spec/models/metric_aggregate_enum_spec.rb +1 -1
  607. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +1 -1
  608. data/spec/models/metric_aggregate_query_resource_object_spec.rb +1 -1
  609. data/spec/models/metric_aggregate_query_spec.rb +1 -1
  610. data/spec/models/metric_create_query_resource_object_attributes_spec.rb +1 -1
  611. data/spec/models/metric_create_query_resource_object_spec.rb +1 -1
  612. data/spec/models/metric_enum_spec.rb +1 -1
  613. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +1 -1
  614. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +1 -1
  615. data/spec/models/onsite_profile_meta_spec.rb +1 -1
  616. data/spec/models/profile_bulk_import_job_enum_spec.rb +1 -1
  617. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +1 -1
  618. data/spec/models/profile_create_query_resource_object_spec.rb +1 -1
  619. data/spec/models/profile_create_query_spec.rb +1 -1
  620. data/spec/models/profile_enum_spec.rb +1 -1
  621. data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +1 -1
  622. data/spec/models/profile_identifier_dto_resource_object_spec.rb +1 -1
  623. data/spec/models/profile_import_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  624. data/spec/models/profile_import_job_create_query_resource_object_attributes_spec.rb +1 -1
  625. data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner_spec.rb +1 -1
  626. data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_spec.rb +1 -1
  627. data/spec/models/profile_import_job_create_query_resource_object_relationships_spec.rb +1 -1
  628. data/spec/models/profile_import_job_create_query_resource_object_spec.rb +1 -1
  629. data/spec/models/profile_import_job_create_query_spec.rb +1 -1
  630. data/spec/models/profile_location_latitude_spec.rb +1 -1
  631. data/spec/models/profile_location_longitude_spec.rb +1 -1
  632. data/spec/models/profile_location_spec.rb +1 -1
  633. data/spec/models/profile_merge_enum_spec.rb +1 -1
  634. data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +1 -1
  635. data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +1 -1
  636. data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +1 -1
  637. data/spec/models/profile_merge_query_resource_object_spec.rb +1 -1
  638. data/spec/models/profile_merge_query_spec.rb +1 -1
  639. data/spec/models/profile_meta_patch_properties_spec.rb +1 -1
  640. data/spec/models/profile_meta_patch_properties_unset_spec.rb +1 -1
  641. data/spec/models/profile_meta_spec.rb +1 -1
  642. data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +1 -1
  643. data/spec/models/profile_partial_update_query_resource_object_spec.rb +1 -1
  644. data/spec/models/profile_partial_update_query_spec.rb +1 -1
  645. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +1 -1
  646. data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +1 -1
  647. data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +1 -1
  648. data/spec/models/profile_subscription_create_query_resource_object_spec.rb +1 -1
  649. data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +1 -1
  650. data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +1 -1
  651. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +1 -1
  652. data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +1 -1
  653. data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +1 -1
  654. data/spec/models/profile_suppression_create_query_resource_object_spec.rb +1 -1
  655. data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +1 -1
  656. data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +1 -1
  657. data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +1 -7
  658. data/spec/models/profile_upsert_query_resource_object_spec.rb +7 -1
  659. data/spec/models/profile_upsert_query_spec.rb +34 -0
  660. data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +1 -1
  661. data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +1 -1
  662. data/spec/models/push_token_create_query_resource_object_spec.rb +1 -1
  663. data/spec/models/push_token_create_query_spec.rb +1 -1
  664. data/spec/models/push_token_enum_spec.rb +1 -1
  665. data/spec/models/render_options_sub_object_spec.rb +1 -1
  666. data/spec/models/segment_enum_spec.rb +1 -1
  667. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +1 -1
  668. data/spec/models/segment_partial_update_query_resource_object_spec.rb +1 -1
  669. data/spec/models/segment_partial_update_query_spec.rb +1 -1
  670. data/spec/models/send_strategy_sub_object_spec.rb +1 -1
  671. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +1 -1
  672. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +1 -1
  673. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +1 -1
  674. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +1 -1
  675. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +1 -1
  676. data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +1 -1
  677. data/spec/models/server_bis_subscription_create_query_spec.rb +1 -1
  678. data/spec/models/sms_content_sub_object_create_spec.rb +1 -1
  679. data/spec/models/sms_send_options_sub_object_spec.rb +1 -1
  680. data/spec/models/sms_subscription_parameters_spec.rb +1 -1
  681. data/spec/models/sms_tracking_options_sub_object_spec.rb +1 -1
  682. data/spec/models/static_schedule_options_spec.rb +1 -1
  683. data/spec/models/sto_schedule_options_spec.rb +1 -1
  684. data/spec/models/subscription_channels_spec.rb +1 -1
  685. data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  686. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  687. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
  688. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +1 -1
  689. data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +1 -1
  690. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +1 -1
  691. data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
  692. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  693. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  694. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
  695. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +1 -1
  696. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +1 -1
  697. data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +1 -1
  698. data/spec/models/subscription_delete_job_create_query_spec.rb +1 -1
  699. data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  700. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  701. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +1 -1
  702. data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
  703. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  704. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  705. data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +1 -1
  706. data/spec/models/suppression_delete_job_create_query_spec.rb +1 -1
  707. data/spec/models/tag_campaign_op_data_inner_spec.rb +1 -1
  708. data/spec/models/tag_campaign_op_spec.rb +1 -1
  709. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +1 -1
  710. data/spec/models/tag_create_query_resource_object_relationships_spec.rb +1 -1
  711. data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +1 -1
  712. data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +1 -1
  713. data/spec/models/tag_create_query_resource_object_spec.rb +1 -1
  714. data/spec/models/tag_create_query_spec.rb +1 -1
  715. data/spec/models/tag_enum_spec.rb +1 -1
  716. data/spec/models/tag_flow_op_data_inner_spec.rb +1 -1
  717. data/spec/models/tag_flow_op_spec.rb +1 -1
  718. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +1 -1
  719. data/spec/models/tag_group_create_query_resource_object_spec.rb +1 -1
  720. data/spec/models/tag_group_create_query_spec.rb +1 -1
  721. data/spec/models/tag_group_enum_spec.rb +1 -1
  722. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +1 -1
  723. data/spec/models/tag_group_update_query_resource_object_spec.rb +1 -1
  724. data/spec/models/tag_group_update_query_spec.rb +1 -1
  725. data/spec/models/tag_list_op_data_inner_spec.rb +1 -1
  726. data/spec/models/tag_list_op_spec.rb +1 -1
  727. data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
  728. data/spec/models/tag_segment_op_spec.rb +1 -1
  729. data/spec/models/tag_update_query_resource_object_spec.rb +1 -1
  730. data/spec/models/tag_update_query_spec.rb +1 -1
  731. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +1 -1
  732. data/spec/models/template_clone_query_resource_object_spec.rb +1 -1
  733. data/spec/models/template_clone_query_spec.rb +1 -1
  734. data/spec/models/template_create_query_resource_object_attributes_spec.rb +1 -1
  735. data/spec/models/template_create_query_resource_object_spec.rb +1 -1
  736. data/spec/models/template_create_query_spec.rb +1 -1
  737. data/spec/models/template_enum_spec.rb +1 -1
  738. data/spec/models/template_render_query_resource_object_attributes_spec.rb +1 -1
  739. data/spec/models/template_render_query_resource_object_spec.rb +1 -1
  740. data/spec/models/template_render_query_spec.rb +1 -1
  741. data/spec/models/template_update_query_resource_object_attributes_spec.rb +1 -1
  742. data/spec/models/template_update_query_resource_object_spec.rb +1 -1
  743. data/spec/models/template_update_query_spec.rb +1 -1
  744. data/spec/models/throttled_schedule_options_spec.rb +1 -1
  745. data/spec/models/timeframe_spec.rb +38 -0
  746. data/spec/models/utm_params_sub_object_spec.rb +1 -1
  747. data/spec/spec_helper.rb +1 -1
  748. metadata +53 -2
@@ -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-12-15
6
+ The version of the OpenAPI document: 2024-02-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -23,7 +23,7 @@ module KlaviyoAPI
23
23
  # Get the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
24
24
  # @param id [String] The ID of the image
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
26
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
27
27
  # @return [Hash<String, Object>]
28
28
  def get_image(id, opts = {})
29
29
  data, _status_code, _headers = get_image_with_http_info(id, opts)
@@ -34,7 +34,7 @@ module KlaviyoAPI
34
34
  # Get the image with the given image ID.&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;images:read&#x60;
35
35
  # @param id [String] The ID of the image
36
36
  # @param [Hash] opts the optional parameters
37
- # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
37
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
38
38
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
39
39
  def get_image_with_http_info(id, opts = {})
40
40
  if @api_client.config.debugging
@@ -58,7 +58,7 @@ module KlaviyoAPI
58
58
  # header parameters
59
59
  header_params = opts[:header_params] || {}
60
60
  # klaviyo api revision
61
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
61
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
62
62
  # HTTP header 'Accept' (if needed)
63
63
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
64
 
@@ -94,11 +94,11 @@ module KlaviyoAPI
94
94
  # Get Images
95
95
  # Get all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
96
96
  # @param [Hash] opts the optional parameters
97
- # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
98
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#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;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
99
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
97
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
98
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#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;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
99
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
100
100
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
101
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
101
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
102
102
  # @return [Hash<String, Object>]
103
103
  def get_images(opts = {})
104
104
  data, _status_code, _headers = get_images_with_http_info(opts)
@@ -108,11 +108,11 @@ module KlaviyoAPI
108
108
  # Get Images
109
109
  # Get all images in an account.&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;images:read&#x60;
110
110
  # @param [Hash] opts the optional parameters
111
- # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
112
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#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;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
113
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
111
+ # @option opts [Array<String>] :fields_image For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
112
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#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;&lt;br&gt;&#x60;format&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;contains&#x60;, &#x60;ends-with&#x60;, &#x60;equals&#x60;, &#x60;starts-with&#x60;&lt;br&gt;&#x60;size&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;hidden&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
113
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
114
114
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
115
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
115
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
116
116
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
117
117
  def get_images_with_http_info(opts = {})
118
118
  if @api_client.config.debugging
@@ -148,7 +148,7 @@ module KlaviyoAPI
148
148
  # header parameters
149
149
  header_params = opts[:header_params] || {}
150
150
  # klaviyo api revision
151
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
151
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
152
152
  # HTTP header 'Accept' (if needed)
153
153
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
154
154
 
@@ -219,7 +219,7 @@ module KlaviyoAPI
219
219
  # header parameters
220
220
  header_params = opts[:header_params] || {}
221
221
  # klaviyo api revision
222
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
222
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
223
223
  # HTTP header 'Accept' (if needed)
224
224
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
225
225
  # HTTP header 'Content-Type'
@@ -293,7 +293,7 @@ module KlaviyoAPI
293
293
  # header parameters
294
294
  header_params = opts[:header_params] || {}
295
295
  # klaviyo api revision
296
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
296
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
297
297
  # HTTP header 'Accept' (if needed)
298
298
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
299
299
  # HTTP header 'Content-Type'
@@ -366,7 +366,7 @@ module KlaviyoAPI
366
366
  # header parameters
367
367
  header_params = opts[:header_params] || {}
368
368
  # klaviyo api revision
369
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
369
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
370
370
  # HTTP header 'Accept' (if needed)
371
371
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
372
372
  # 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-12-15
6
+ The version of the OpenAPI document: 2024-02-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -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-12-15"
54
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-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'
@@ -127,7 +127,7 @@ module KlaviyoAPI
127
127
  # header parameters
128
128
  header_params = opts[:header_params] || {}
129
129
  # klaviyo api revision
130
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
130
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
131
131
  # HTTP header 'Accept' (if needed)
132
132
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
133
133
  # HTTP header 'Content-Type'
@@ -197,7 +197,7 @@ module KlaviyoAPI
197
197
  # header parameters
198
198
  header_params = opts[:header_params] || {}
199
199
  # klaviyo api revision
200
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
200
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
201
201
  # HTTP header 'Accept' (if needed)
202
202
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
203
203
 
@@ -268,7 +268,7 @@ module KlaviyoAPI
268
268
  # header parameters
269
269
  header_params = opts[:header_params] || {}
270
270
  # klaviyo api revision
271
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
271
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
272
272
  # HTTP header 'Accept' (if needed)
273
273
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
274
274
  # HTTP header 'Content-Type'
@@ -307,13 +307,13 @@ module KlaviyoAPI
307
307
  end
308
308
 
309
309
  # Get List
310
- # Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read`
310
+ # Get a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read`
311
311
  # @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
312
312
  # @param [Hash] opts the optional parameters
313
313
  # @option opts [Array<String>] :additional_fields_list Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39;
314
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
315
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
316
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
314
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
315
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
316
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
317
317
  # @return [Hash<String, Object>]
318
318
  def get_list(id, opts = {})
319
319
  data, _status_code, _headers = get_list_with_http_info(id, opts)
@@ -321,13 +321,13 @@ module KlaviyoAPI
321
321
  end
322
322
 
323
323
  # Get List
324
- # Get a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[list]&#x3D;profile_count&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;lists:read&#x60;
324
+ # Get a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[list]&#x3D;profile_count&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;lists:read&#x60;
325
325
  # @param id [String] Primary key that uniquely identifies this list. Generated by Klaviyo.
326
326
  # @param [Hash] opts the optional parameters
327
327
  # @option opts [Array<String>] :additional_fields_list Request additional fields not included by default in the response. Supported values: &#39;profile_count&#39;
328
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
329
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
330
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
328
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
329
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
330
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
331
331
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
332
332
  def get_list_with_http_info(id, opts = {})
333
333
  if @api_client.config.debugging
@@ -341,7 +341,7 @@ module KlaviyoAPI
341
341
  if @api_client.config.client_side_validation && opts[:'additional_fields_list'] && !opts[:'additional_fields_list'].all? { |item| allowable_values.include?(item) }
342
342
  fail ArgumentError, "invalid value for \"additional_fields_list\", must include one of #{allowable_values}"
343
343
  end
344
- allowable_values = ["name", "created", "updated", "profile_count"]
344
+ allowable_values = ["name", "created", "updated", "opt_in_process", "profile_count"]
345
345
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
346
346
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
347
347
  end
@@ -366,7 +366,7 @@ module KlaviyoAPI
366
366
  # header parameters
367
367
  header_params = opts[:header_params] || {}
368
368
  # klaviyo api revision
369
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
369
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
370
370
  # HTTP header 'Accept' (if needed)
371
371
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
372
372
 
@@ -400,15 +400,15 @@ module KlaviyoAPI
400
400
  end
401
401
 
402
402
  # Get List Profiles
403
- # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
403
+ # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `lists:read` `profiles:read`
404
404
  # @param id [String]
405
405
  # @param [Hash] opts the optional parameters
406
406
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
407
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
408
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
409
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
407
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
408
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
409
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
410
410
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
411
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
411
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
412
412
  # @return [Hash<String, Object>]
413
413
  def get_list_profiles(id, opts = {})
414
414
  data, _status_code, _headers = get_list_profiles_with_http_info(id, opts)
@@ -416,15 +416,15 @@ module KlaviyoAPI
416
416
  end
417
417
 
418
418
  # Get List Profiles
419
- # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by &#x60;email&#x60;, &#x60;phone_number&#x60;, &#x60;push_token&#x60;, and &#x60;joined_group_at&#x60; fields. Profiles can be sorted by the following fields, in ascending and descending order: &#x60;joined_group_at&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[profile]&#x3D;predictive_analytics&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;lists:read&#x60; &#x60;profiles:read&#x60;
419
+ # Get all profiles within a list with the given list ID. Filter to request a subset of all profiles. Profiles can be filtered by &#x60;email&#x60;, &#x60;phone_number&#x60;, &#x60;push_token&#x60;, and &#x60;joined_group_at&#x60; fields. Profiles can be sorted by the following fields, in ascending and descending order: &#x60;joined_group_at&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[profile]&#x3D;predictive_analytics&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-02-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;lists:read&#x60; &#x60;profiles:read&#x60;
420
420
  # @param id [String]
421
421
  # @param [Hash] opts the optional parameters
422
422
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
423
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
424
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
425
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
423
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
424
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
425
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
426
426
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
427
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
427
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
428
428
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
429
429
  def get_list_profiles_with_http_info(id, opts = {})
430
430
  if @api_client.config.debugging
@@ -469,7 +469,7 @@ module KlaviyoAPI
469
469
  # header parameters
470
470
  header_params = opts[:header_params] || {}
471
471
  # klaviyo api revision
472
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
472
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
473
473
  # HTTP header 'Accept' (if needed)
474
474
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
475
475
 
@@ -506,10 +506,10 @@ module KlaviyoAPI
506
506
  # Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read` `profiles:read`
507
507
  # @param id [String]
508
508
  # @param [Hash] opts the optional parameters
509
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
510
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
509
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
510
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
511
511
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20)
512
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
512
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
513
513
  # @return [Hash<String, Object>]
514
514
  def get_list_relationships_profiles(id, opts = {})
515
515
  data, _status_code, _headers = get_list_relationships_profiles_with_http_info(id, opts)
@@ -520,10 +520,10 @@ module KlaviyoAPI
520
520
  # Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;lists:read&#x60; &#x60;profiles:read&#x60;
521
521
  # @param id [String]
522
522
  # @param [Hash] opts the optional parameters
523
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
524
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
523
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;joined_group_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;
524
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
525
525
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 1000. (default to 20)
526
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
526
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
527
527
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
528
528
  def get_list_relationships_profiles_with_http_info(id, opts = {})
529
529
  if @api_client.config.debugging
@@ -558,7 +558,7 @@ module KlaviyoAPI
558
558
  # header parameters
559
559
  header_params = opts[:header_params] || {}
560
560
  # klaviyo api revision
561
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
561
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
562
562
  # HTTP header 'Accept' (if needed)
563
563
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
564
564
 
@@ -623,7 +623,7 @@ module KlaviyoAPI
623
623
  # header parameters
624
624
  header_params = opts[:header_params] || {}
625
625
  # klaviyo api revision
626
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
626
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
627
627
  # HTTP header 'Accept' (if needed)
628
628
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
629
629
 
@@ -660,7 +660,7 @@ module KlaviyoAPI
660
660
  # Return all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
661
661
  # @param id [String]
662
662
  # @param [Hash] opts the optional parameters
663
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
663
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
664
664
  # @return [Hash<String, Object>]
665
665
  def get_list_tags(id, opts = {})
666
666
  data, _status_code, _headers = get_list_tags_with_http_info(id, opts)
@@ -671,7 +671,7 @@ module KlaviyoAPI
671
671
  # Return all tags associated with the given list ID.&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;lists:read&#x60; &#x60;tags:read&#x60;
672
672
  # @param id [String]
673
673
  # @param [Hash] opts the optional parameters
674
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
674
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
675
675
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
676
676
  def get_list_tags_with_http_info(id, opts = {})
677
677
  if @api_client.config.debugging
@@ -695,7 +695,7 @@ module KlaviyoAPI
695
695
  # header parameters
696
696
  header_params = opts[:header_params] || {}
697
697
  # klaviyo api revision
698
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
698
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
699
699
  # HTTP header 'Accept' (if needed)
700
700
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
701
701
 
@@ -731,11 +731,11 @@ module KlaviyoAPI
731
731
  # Get Lists
732
732
  # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:read`
733
733
  # @param [Hash] opts the optional parameters
734
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
735
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
736
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
737
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
738
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
734
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
735
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
736
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
737
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
738
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
739
739
  # @return [Hash<String, Object>]
740
740
  def get_lists(opts = {})
741
741
  data, _status_code, _headers = get_lists_with_http_info(opts)
@@ -745,17 +745,17 @@ module KlaviyoAPI
745
745
  # Get Lists
746
746
  # Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by &#x60;id&#x60;, &#x60;name&#x60;, &#x60;created&#x60;, and &#x60;updated&#x60; fields. Returns a maximum of 10 results per page.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;lists:read&#x60;
747
747
  # @param [Hash] opts the optional parameters
748
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
749
- # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
750
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
751
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
752
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
748
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
749
+ # @option opts [Array<String>] :fields_tag For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
750
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;
751
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
752
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
753
753
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
754
754
  def get_lists_with_http_info(opts = {})
755
755
  if @api_client.config.debugging
756
756
  @api_client.config.logger.debug 'Calling API: ListsApi.get_lists ...'
757
757
  end
758
- allowable_values = ["name", "created", "updated"]
758
+ allowable_values = ["name", "created", "updated", "opt_in_process"]
759
759
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
760
760
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
761
761
  end
@@ -781,7 +781,7 @@ module KlaviyoAPI
781
781
  # header parameters
782
782
  header_params = opts[:header_params] || {}
783
783
  # klaviyo api revision
784
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
784
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
785
785
  # HTTP header 'Accept' (if needed)
786
786
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
787
787
 
@@ -852,7 +852,7 @@ module KlaviyoAPI
852
852
  # header parameters
853
853
  header_params = opts[:header_params] || {}
854
854
  # klaviyo api revision
855
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
855
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
856
856
  # HTTP header 'Accept' (if needed)
857
857
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
858
858
  # 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-12-15
6
+ The version of the OpenAPI document: 2024-02-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -23,7 +23,7 @@ module KlaviyoAPI
23
23
  # Get a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
24
24
  # @param id [String] Metric ID
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
26
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
27
27
  # @return [Hash<String, Object>]
28
28
  def get_metric(id, opts = {})
29
29
  data, _status_code, _headers = get_metric_with_http_info(id, opts)
@@ -34,7 +34,7 @@ module KlaviyoAPI
34
34
  # Get a metric with the given metric ID.&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;metrics:read&#x60;
35
35
  # @param id [String] Metric ID
36
36
  # @param [Hash] opts the optional parameters
37
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
37
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
38
38
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
39
39
  def get_metric_with_http_info(id, opts = {})
40
40
  if @api_client.config.debugging
@@ -58,7 +58,7 @@ module KlaviyoAPI
58
58
  # header parameters
59
59
  header_params = opts[:header_params] || {}
60
60
  # klaviyo api revision
61
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
61
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
62
62
  # HTTP header 'Accept' (if needed)
63
63
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
64
 
@@ -94,9 +94,9 @@ module KlaviyoAPI
94
94
  # Get Metrics
95
95
  # Get all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
96
96
  # @param [Hash] opts the optional parameters
97
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
98
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
99
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
97
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
98
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
99
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
100
100
  # @return [Hash<String, Object>]
101
101
  def get_metrics(opts = {})
102
102
  data, _status_code, _headers = get_metrics_with_http_info(opts)
@@ -106,9 +106,9 @@ module KlaviyoAPI
106
106
  # Get Metrics
107
107
  # Get all metrics in an account. Requests can be filtered by the following fields: integration &#x60;name&#x60;, integration &#x60;category&#x60; Returns a maximum of 200 results per page.&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;metrics:read&#x60;
108
108
  # @param [Hash] opts the optional parameters
109
- # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
110
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
111
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
109
+ # @option opts [Array<String>] :fields_metric For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
110
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;integration.name&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;integration.category&#x60;: &#x60;equals&#x60;
111
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
112
112
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
113
113
  def get_metrics_with_http_info(opts = {})
114
114
  if @api_client.config.debugging
@@ -130,7 +130,7 @@ module KlaviyoAPI
130
130
  # header parameters
131
131
  header_params = opts[:header_params] || {}
132
132
  # klaviyo api revision
133
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
133
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
134
134
  # HTTP header 'Accept' (if needed)
135
135
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
136
136
 
@@ -195,7 +195,7 @@ module KlaviyoAPI
195
195
  # header parameters
196
196
  header_params = opts[:header_params] || {}
197
197
  # klaviyo api revision
198
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
198
+ header_params['revision'] = ENV['API_REVISION'] || "2024-02-15"
199
199
  # HTTP header 'Accept' (if needed)
200
200
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
201
201
  # HTTP header 'Content-Type'