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
data/docs/AccountsApi.md CHANGED
@@ -32,7 +32,7 @@ end
32
32
  api_instance = KlaviyoAPI::AccountsApi.new
33
33
  id = 'AbC123' # String | The ID of the account
34
34
  opts = {
35
- fields_account: ['contact_information'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
35
+ fields_account: ['contact_information'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
36
36
  }
37
37
 
38
38
  begin
@@ -67,7 +67,7 @@ end
67
67
  | Name | Type | Description | Notes |
68
68
  | ---- | ---- | ----------- | ----- |
69
69
  | **id** | **String** | The ID of the account | |
70
- | **fields_account** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
70
+ | **fields_account** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
71
71
 
72
72
  ### Return type
73
73
 
@@ -106,7 +106,7 @@ end
106
106
 
107
107
  api_instance = KlaviyoAPI::AccountsApi.new
108
108
  opts = {
109
- fields_account: ['contact_information'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
109
+ fields_account: ['contact_information'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
110
110
  }
111
111
 
112
112
  begin
@@ -140,7 +140,7 @@ end
140
140
 
141
141
  | Name | Type | Description | Notes |
142
142
  | ---- | ---- | ----------- | ----- |
143
- | **fields_account** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
143
+ | **fields_account** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
144
144
 
145
145
  ### Return type
146
146
 
@@ -0,0 +1,15 @@
1
+ # KlaviyoAPI::CampaignValuesReportEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'klaviyo-api-sdk'
12
+
13
+ instance = KlaviyoAPI::CampaignValuesReportEnum.new()
14
+ ```
15
+
@@ -0,0 +1,18 @@
1
+ # KlaviyoAPI::CampaignValuesRequestDTO
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**CampaignValuesRequestDTOResourceObject**](CampaignValuesRequestDTOResourceObject.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'klaviyo-api-sdk'
13
+
14
+ instance = KlaviyoAPI::CampaignValuesRequestDTO.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # KlaviyoAPI::CampaignValuesRequestDTOResourceObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | [**CampaignValuesReportEnum**](CampaignValuesReportEnum.md) | | |
8
+ | **attributes** | [**CampaignValuesRequestDTOResourceObjectAttributes**](CampaignValuesRequestDTOResourceObjectAttributes.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'klaviyo-api-sdk'
14
+
15
+ instance = KlaviyoAPI::CampaignValuesRequestDTOResourceObject.new(
16
+ type: null,
17
+ attributes: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **statistics** | **Array&lt;String&gt;** | List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0] | |
8
+ | **timeframe** | [**CampaignValuesRequestDTOResourceObjectAttributesTimeframe**](CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md) | | |
9
+ | **conversion_metric_id** | **String** | ID of the metric to be used for conversion statistics | |
10
+ | **filter** | **String** | API filter string used to filter the query. Allowed filters are send_channel, campaign_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'klaviyo-api-sdk'
16
+
17
+ instance = KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributes.new(
18
+ statistics: [&quot;opens&quot;,&quot;open_rate&quot;],
19
+ timeframe: null,
20
+ conversion_metric_id: RESQ6t,
21
+ filter: and(equals(campaign_id,&quot;abc123&quot;),contains-any(send_channel,[&quot;email&quot;,&quot;sms&quot;]))
22
+ )
23
+ ```
24
+
@@ -0,0 +1,49 @@
1
+ # KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributesTimeframe
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'klaviyo-api-sdk'
13
+
14
+ KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributesTimeframe.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'CustomTimeframe',
18
+ # :'Timeframe'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'klaviyo-api-sdk'
30
+
31
+ KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributesTimeframe.build(data)
32
+ # => #<CustomTimeframe:0x00007fdd4aab02a0>
33
+
34
+ KlaviyoAPI::CampaignValuesRequestDTOResourceObjectAttributesTimeframe.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `CustomTimeframe`
47
+ - `Timeframe`
48
+ - `nil` (if no type matches)
49
+
data/docs/CampaignsApi.md CHANGED
@@ -478,10 +478,10 @@ end
478
478
  api_instance = KlaviyoAPI::CampaignsApi.new
479
479
  id = 'id_example' # String | The campaign ID to be retrieved
480
480
  opts = {
481
- fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
482
- fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
483
- fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
484
- include: ['campaign-messages'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
481
+ fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
482
+ fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
483
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
484
+ include: ['campaign-messages'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
485
485
  }
486
486
 
487
487
  begin
@@ -516,10 +516,10 @@ end
516
516
  | Name | Type | Description | Notes |
517
517
  | ---- | ---- | ----------- | ----- |
518
518
  | **id** | **String** | The campaign ID to be retrieved | |
519
- | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
520
- | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
521
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
522
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
519
+ | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
520
+ | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
521
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
522
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
523
523
 
524
524
  ### Return type
525
525
 
@@ -559,10 +559,10 @@ end
559
559
  api_instance = KlaviyoAPI::CampaignsApi.new
560
560
  id = 'id_example' # String |
561
561
  opts = {
562
- fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
563
- fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
564
- fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
565
- include: ['campaign'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
562
+ fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
563
+ fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
564
+ fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
565
+ include: ['campaign'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
566
566
  }
567
567
 
568
568
  begin
@@ -597,10 +597,10 @@ end
597
597
  | Name | Type | Description | Notes |
598
598
  | ---- | ---- | ----------- | ----- |
599
599
  | **id** | **String** | | |
600
- | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
601
- | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
602
- | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
603
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
600
+ | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
601
+ | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
602
+ | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
603
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
604
604
 
605
605
  ### Return type
606
606
 
@@ -640,10 +640,10 @@ end
640
640
  api_instance = KlaviyoAPI::CampaignsApi.new
641
641
  id = 'id_example' # String | The message ID to be retrieved
642
642
  opts = {
643
- fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
644
- fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
645
- fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
646
- include: ['campaign'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
643
+ fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
644
+ fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
645
+ fields_template: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
646
+ include: ['campaign'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
647
647
  }
648
648
 
649
649
  begin
@@ -678,10 +678,10 @@ end
678
678
  | Name | Type | Description | Notes |
679
679
  | ---- | ---- | ----------- | ----- |
680
680
  | **id** | **String** | The message ID to be retrieved | |
681
- | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
682
- | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
683
- | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
684
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
681
+ | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
682
+ | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
683
+ | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
684
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
685
685
 
686
686
  ### Return type
687
687
 
@@ -721,7 +721,7 @@ end
721
721
  api_instance = KlaviyoAPI::CampaignsApi.new
722
722
  id = 'id_example' # String |
723
723
  opts = {
724
- fields_campaign_message: ['label'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
724
+ fields_campaign: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
725
725
  }
726
726
 
727
727
  begin
@@ -756,7 +756,7 @@ end
756
756
  | Name | Type | Description | Notes |
757
757
  | ---- | ---- | ----------- | ----- |
758
758
  | **id** | **String** | | |
759
- | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
759
+ | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
760
760
 
761
761
  ### Return type
762
762
 
@@ -938,7 +938,7 @@ end
938
938
  api_instance = KlaviyoAPI::CampaignsApi.new
939
939
  id = 'id_example' # String |
940
940
  opts = {
941
- fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
941
+ fields_template: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
942
942
  }
943
943
 
944
944
  begin
@@ -973,7 +973,7 @@ end
973
973
  | Name | Type | Description | Notes |
974
974
  | ---- | ---- | ----------- | ----- |
975
975
  | **id** | **String** | | |
976
- | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
976
+ | **fields_template** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
977
977
 
978
978
  ### Return type
979
979
 
@@ -1013,7 +1013,7 @@ end
1013
1013
  api_instance = KlaviyoAPI::CampaignsApi.new
1014
1014
  id = 'id_example' # String | The ID of the campaign for which to get the estimated number of recipients
1015
1015
  opts = {
1016
- fields_campaign_recipient_estimation: ['estimated_recipient_count'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1016
+ fields_campaign_recipient_estimation: ['estimated_recipient_count'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
1017
1017
  }
1018
1018
 
1019
1019
  begin
@@ -1048,7 +1048,7 @@ end
1048
1048
  | Name | Type | Description | Notes |
1049
1049
  | ---- | ---- | ----------- | ----- |
1050
1050
  | **id** | **String** | The ID of the campaign for which to get the estimated number of recipients | |
1051
- | **fields_campaign_recipient_estimation** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
1051
+ | **fields_campaign_recipient_estimation** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
1052
1052
 
1053
1053
  ### Return type
1054
1054
 
@@ -1088,7 +1088,7 @@ end
1088
1088
  api_instance = KlaviyoAPI::CampaignsApi.new
1089
1089
  id = 'id_example' # String | The ID of the campaign to get recipient estimation status
1090
1090
  opts = {
1091
- fields_campaign_recipient_estimation_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1091
+ fields_campaign_recipient_estimation_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
1092
1092
  }
1093
1093
 
1094
1094
  begin
@@ -1123,7 +1123,7 @@ end
1123
1123
  | Name | Type | Description | Notes |
1124
1124
  | ---- | ---- | ----------- | ----- |
1125
1125
  | **id** | **String** | The ID of the campaign to get recipient estimation status | |
1126
- | **fields_campaign_recipient_estimation_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
1126
+ | **fields_campaign_recipient_estimation_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
1127
1127
 
1128
1128
  ### Return type
1129
1129
 
@@ -1305,7 +1305,7 @@ end
1305
1305
  api_instance = KlaviyoAPI::CampaignsApi.new
1306
1306
  id = 'id_example' # String | The ID of the campaign to send
1307
1307
  opts = {
1308
- fields_campaign_send_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1308
+ fields_campaign_send_job: ['status'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
1309
1309
  }
1310
1310
 
1311
1311
  begin
@@ -1340,7 +1340,7 @@ end
1340
1340
  | Name | Type | Description | Notes |
1341
1341
  | ---- | ---- | ----------- | ----- |
1342
1342
  | **id** | **String** | The ID of the campaign to send | |
1343
- | **fields_campaign_send_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
1343
+ | **fields_campaign_send_job** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
1344
1344
 
1345
1345
  ### Return type
1346
1346
 
@@ -1380,7 +1380,7 @@ end
1380
1380
  api_instance = KlaviyoAPI::CampaignsApi.new
1381
1381
  id = 'id_example' # String |
1382
1382
  opts = {
1383
- fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1383
+ fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
1384
1384
  }
1385
1385
 
1386
1386
  begin
@@ -1415,7 +1415,7 @@ end
1415
1415
  | Name | Type | Description | Notes |
1416
1416
  | ---- | ---- | ----------- | ----- |
1417
1417
  | **id** | **String** | | |
1418
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
1418
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
1419
1419
 
1420
1420
  ### Return type
1421
1421
 
@@ -1453,14 +1453,14 @@ KlaviyoAPI.configure do |config|
1453
1453
  end
1454
1454
 
1455
1455
  api_instance = KlaviyoAPI::CampaignsApi.new
1456
- filter = 'equals(messages.channel,'sms')' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
1456
+ filter = 'equals(messages.channel,'sms')' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`messages.channel`: `equals`<br>`name`: `contains`<br>`status`: `any`, `equals`<br>`archived`: `equals`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
1457
1457
  opts = {
1458
- fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1459
- fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1460
- fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1461
- include: ['campaign-messages'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
1462
- page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
1463
- sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
1458
+ fields_campaign_message: ['label'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
1459
+ fields_campaign: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
1460
+ fields_tag: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
1461
+ include: ['campaign-messages'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships
1462
+ page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination
1463
+ sort: 'created_at' # String | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting
1464
1464
  }
1465
1465
 
1466
1466
  begin
@@ -1494,13 +1494,13 @@ end
1494
1494
 
1495
1495
  | Name | Type | Description | Notes |
1496
1496
  | ---- | ---- | ----------- | ----- |
1497
- | **filter** | **String** | 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;messages.channel&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;scheduled_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | |
1498
- | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
1499
- | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
1500
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] |
1501
- | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] |
1502
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] |
1503
- | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] |
1497
+ | **filter** | **String** | 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;messages.channel&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;archived&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;scheduled_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; | |
1498
+ | **fields_campaign_message** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
1499
+ | **fields_campaign** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
1500
+ | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | [optional] |
1501
+ | **include** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | [optional] |
1502
+ | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination | [optional] |
1503
+ | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sorting | [optional] |
1504
1504
 
1505
1505
  ### Return type
1506
1506