klaviyo-api-sdk 5.1.0 → 7.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (862) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +267 -209
  3. data/docs/AccountsApi.md +4 -4
  4. data/docs/BaseEventCreateQueryResourceObject.md +20 -0
  5. data/docs/BaseEventCreateQueryResourceObjectAttributes.md +28 -0
  6. data/docs/CampaignMessageAssignTemplateQueryResourceObject.md +1 -1
  7. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationships.md +1 -1
  8. data/docs/CampaignMessageAssignTemplateQueryResourceObjectRelationshipsTemplate.md +1 -1
  9. data/docs/CampaignValuesReportEnum.md +15 -0
  10. data/docs/CampaignValuesRequestDTO.md +18 -0
  11. data/docs/CampaignValuesRequestDTOResourceObject.md +20 -0
  12. data/docs/CampaignValuesRequestDTOResourceObjectAttributes.md +24 -0
  13. data/docs/CampaignValuesRequestDTOResourceObjectAttributesTimeframe.md +49 -0
  14. data/docs/CampaignsApi.md +51 -51
  15. data/docs/CatalogCategoryCreateQueryResourceObjectRelationshipsItems.md +1 -1
  16. data/docs/CatalogItemCreateQueryResourceObjectRelationshipsCategories.md +1 -1
  17. data/docs/CatalogVariantCreateQueryResourceObject.md +1 -1
  18. data/docs/CatalogVariantCreateQueryResourceObjectRelationships.md +1 -1
  19. data/docs/CatalogVariantCreateQueryResourceObjectRelationshipsItem.md +1 -1
  20. data/docs/CatalogsApi.md +178 -178
  21. data/docs/CouponCodeCreateQueryResourceObject.md +1 -1
  22. data/docs/CouponCodeCreateQueryResourceObjectRelationships.md +1 -1
  23. data/docs/CouponCodeCreateQueryResourceObjectRelationshipsCoupon.md +1 -1
  24. data/docs/CouponsApi.md +47 -47
  25. data/docs/CustomTimeframe.md +20 -0
  26. data/docs/EventBulkCreateEnum.md +15 -0
  27. data/docs/EventBulkCreateJobEnum.md +15 -0
  28. data/docs/EventCreateQueryV2ResourceObjectAttributes.md +4 -2
  29. data/docs/EventCreateQueryV2ResourceObjectAttributesProfile.md +1 -1
  30. data/docs/EventProfileCreateQueryResourceObject.md +22 -0
  31. data/docs/EventProfileCreateQueryResourceObjectAttributes.md +42 -0
  32. data/docs/EventsApi.md +98 -27
  33. data/docs/EventsBulkCreateJob.md +18 -0
  34. data/docs/EventsBulkCreateJobResourceObject.md +20 -0
  35. data/docs/EventsBulkCreateJobResourceObjectAttributes.md +18 -0
  36. data/docs/EventsBulkCreateJobResourceObjectAttributesEventsBulkCreate.md +18 -0
  37. data/docs/EventsBulkCreateQueryResourceObject.md +20 -0
  38. data/docs/EventsBulkCreateQueryResourceObjectAttributes.md +20 -0
  39. data/docs/EventsBulkCreateQueryResourceObjectAttributesEvents.md +18 -0
  40. data/docs/EventsBulkCreateQueryResourceObjectAttributesProfile.md +18 -0
  41. data/docs/FlowSeriesReportEnum.md +15 -0
  42. data/docs/FlowSeriesRequestDTO.md +18 -0
  43. data/docs/FlowSeriesRequestDTOResourceObject.md +20 -0
  44. data/docs/FlowSeriesRequestDTOResourceObjectAttributes.md +26 -0
  45. data/docs/FlowValuesReportEnum.md +15 -0
  46. data/docs/FlowValuesRequestDTO.md +18 -0
  47. data/docs/FlowValuesRequestDTOResourceObject.md +20 -0
  48. data/docs/FlowValuesRequestDTOResourceObjectAttributes.md +24 -0
  49. data/docs/FlowsApi.md +70 -70
  50. data/docs/ImagesApi.md +10 -10
  51. data/docs/ListsApi.md +34 -34
  52. data/docs/MarketingSubscriptionParameters.md +3 -1
  53. data/docs/MetricsApi.md +8 -8
  54. data/docs/OnsiteProfileCreateQueryResourceObject.md +1 -1
  55. data/docs/OnsiteProfileCreateQueryResourceObjectAttributes.md +4 -4
  56. data/docs/ProfileCreateQueryResourceObjectAttributes.md +3 -3
  57. data/docs/ProfileIdentifierDTOResourceObjectAttributes.md +1 -1
  58. data/docs/ProfileImportJobCreateQueryResourceObjectRelationshipsLists.md +1 -1
  59. data/docs/ProfileMergeQueryResourceObject.md +1 -1
  60. data/docs/ProfileMergeQueryResourceObjectRelationships.md +1 -1
  61. data/docs/ProfileMergeQueryResourceObjectRelationshipsProfiles.md +1 -1
  62. data/docs/ProfilePartialUpdateQueryResourceObjectAttributes.md +3 -3
  63. data/docs/ProfileSubscriptionCreateQueryResourceObjectAttributes.md +4 -2
  64. data/docs/ProfileSubscriptionDeleteQueryResourceObjectAttributes.md +1 -1
  65. data/docs/ProfileSuppressionCreateQueryResourceObjectAttributes.md +1 -1
  66. data/docs/ProfileSuppressionDeleteQueryResourceObjectAttributes.md +1 -1
  67. data/docs/ProfileUpsertQuery.md +18 -0
  68. data/docs/ProfileUpsertQueryResourceObject.md +4 -2
  69. data/docs/ProfileUpsertQueryResourceObjectAttributes.md +5 -7
  70. data/docs/ProfilesApi.md +134 -62
  71. data/docs/PushProfileUpsertQueryResourceObject.md +22 -0
  72. data/docs/PushProfileUpsertQueryResourceObjectAttributes.md +42 -0
  73. data/docs/PushTokenCreateQueryResourceObjectAttributesProfile.md +1 -1
  74. data/docs/ReportingApi.md +235 -0
  75. data/docs/SegmentPartialUpdateQueryResourceObjectAttributes.md +4 -2
  76. data/docs/SegmentsApi.md +35 -35
  77. data/docs/ServerBISSubscriptionCreateQueryResourceObject.md +1 -1
  78. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationships.md +1 -1
  79. data/docs/ServerBISSubscriptionCreateQueryResourceObjectRelationshipsVariant.md +1 -1
  80. data/docs/StaticScheduleOptions.md +1 -1
  81. data/docs/SubscriptionCreateJobCreateQueryResourceObjectRelationshipsList.md +1 -1
  82. data/docs/SubscriptionDeleteJobCreateQueryResourceObjectRelationshipsList.md +1 -1
  83. data/docs/SuppressionCreateJobCreateQueryResourceObject.md +3 -1
  84. data/docs/SuppressionCreateJobCreateQueryResourceObjectAttributes.md +1 -1
  85. data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationships.md +20 -0
  86. data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsList.md +18 -0
  87. data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
  88. data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsSegment.md +18 -0
  89. data/docs/SuppressionCreateJobCreateQueryResourceObjectRelationshipsSegmentData.md +20 -0
  90. data/docs/SuppressionDeleteJobCreateQueryResourceObject.md +3 -1
  91. data/docs/SuppressionDeleteJobCreateQueryResourceObjectAttributes.md +1 -1
  92. data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationships.md +20 -0
  93. data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsList.md +18 -0
  94. data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsListData.md +20 -0
  95. data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsSegment.md +18 -0
  96. data/docs/SuppressionDeleteJobCreateQueryResourceObjectRelationshipsSegmentData.md +20 -0
  97. data/docs/TagCreateQueryResourceObjectRelationshipsTagGroup.md +1 -1
  98. data/docs/TagsApi.md +32 -32
  99. data/docs/TemplatesApi.md +11 -11
  100. data/docs/Timeframe.md +18 -0
  101. data/klaviyo-api-sdk.gemspec +2 -2
  102. data/lib/klaviyo-api-sdk/api/accounts_api.rb +9 -9
  103. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +78 -78
  104. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +239 -239
  105. data/lib/klaviyo-api-sdk/api/coupons_api.rb +64 -64
  106. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +2 -2
  107. data/lib/klaviyo-api-sdk/api/events_api.rb +106 -36
  108. data/lib/klaviyo-api-sdk/api/flows_api.rb +88 -88
  109. data/lib/klaviyo-api-sdk/api/images_api.rb +16 -16
  110. data/lib/klaviyo-api-sdk/api/lists_api.rb +50 -50
  111. data/lib/klaviyo-api-sdk/api/metrics_api.rb +12 -12
  112. data/lib/klaviyo-api-sdk/api/profiles_api.rb +163 -93
  113. data/lib/klaviyo-api-sdk/api/reporting_api.rb +241 -0
  114. data/lib/klaviyo-api-sdk/api/segments_api.rb +46 -46
  115. data/lib/klaviyo-api-sdk/api/tags_api.rb +59 -59
  116. data/lib/klaviyo-api-sdk/api/templates_api.rb +20 -20
  117. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  118. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  119. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  120. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +3 -1
  121. data/lib/klaviyo-api-sdk/models/back_in_stock_subscription_enum.rb +1 -1
  122. data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object.rb +238 -0
  123. data/lib/klaviyo-api-sdk/models/base_event_create_query_resource_object_attributes.rb +283 -0
  124. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +1 -1
  125. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +1 -1
  126. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +2 -1
  127. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +1 -1
  128. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +1 -1
  129. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +3 -1
  130. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_campaign_messages.rb +1 -1
  131. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_send_options.rb +1 -1
  132. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes_tracking_options.rb +1 -1
  133. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +1 -1
  134. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +1 -1
  135. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +1 -6
  136. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships.rb +1 -6
  137. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template.rb +1 -6
  138. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object_relationships_template_data.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes.rb +3 -1
  141. data/lib/klaviyo-api-sdk/models/campaign_message_create_query_resource_object_attributes_content.rb +1 -1
  142. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +1 -1
  143. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +1 -1
  144. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +1 -1
  145. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes.rb +3 -1
  146. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
  148. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +4 -1
  149. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +1 -1
  150. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +1 -1
  151. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +1 -1
  152. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query_resource_object.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +1 -1
  155. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +1 -1
  156. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +1 -1
  157. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +1 -1
  158. data/lib/klaviyo-api-sdk/models/campaign_values_report_enum.rb +36 -0
  159. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto.rb +224 -0
  160. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object.rb +238 -0
  161. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +289 -0
  162. data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +106 -0
  163. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +1 -1
  164. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +1 -1
  165. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +1 -1
  167. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +1 -1
  168. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object_attributes_categories.rb +1 -1
  170. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +1 -1
  171. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object.rb +1 -1
  172. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_attributes.rb +3 -1
  173. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships.rb +1 -1
  174. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items.rb +1 -6
  175. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_resource_object_relationships_items_data_inner.rb +1 -1
  176. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +1 -1
  177. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +1 -1
  178. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes.rb +1 -1
  179. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object_attributes_categories.rb +1 -1
  180. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +1 -1
  181. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +1 -1
  182. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +1 -1
  183. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +1 -1
  184. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +1 -1
  185. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes.rb +1 -1
  186. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object_attributes_categories.rb +1 -1
  187. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +1 -1
  188. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object.rb +1 -1
  189. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_resource_object_attributes.rb +2 -1
  190. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +1 -1
  191. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +1 -1
  192. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +1 -1
  193. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +1 -1
  194. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +1 -1
  195. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object_attributes_items.rb +1 -1
  198. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +1 -1
  199. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +1 -1
  200. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_attributes.rb +9 -1
  201. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships.rb +1 -1
  202. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories.rb +1 -6
  203. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object_relationships_categories_data_inner.rb +1 -1
  204. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +1 -1
  205. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +1 -1
  206. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes.rb +1 -1
  207. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object_attributes_items.rb +1 -1
  208. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +1 -1
  209. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +1 -1
  210. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +1 -1
  211. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +1 -1
  212. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes.rb +1 -1
  213. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object_attributes_items.rb +1 -1
  214. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +1 -1
  215. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +1 -1
  216. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object_attributes.rb +10 -1
  217. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +1 -1
  218. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +1 -1
  219. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +1 -1
  220. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +1 -1
  221. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +1 -1
  222. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes.rb +1 -1
  223. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object_attributes_variants.rb +1 -1
  224. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +1 -1
  225. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object.rb +1 -6
  226. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_attributes.rb +9 -1
  227. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships.rb +1 -6
  228. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.rb +1 -6
  229. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item_data.rb +1 -1
  230. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +1 -1
  231. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +1 -1
  232. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes.rb +1 -1
  233. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants.rb +1 -1
  234. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +1 -1
  235. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +1 -1
  236. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +1 -1
  237. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +1 -1
  238. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes.rb +1 -1
  239. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object_attributes_variants.rb +1 -1
  240. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +1 -1
  241. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object.rb +1 -1
  242. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_resource_object_attributes.rb +13 -1
  243. data/lib/klaviyo-api-sdk/models/coupon_code_bulk_create_job_enum.rb +1 -1
  244. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query.rb +1 -1
  245. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object.rb +1 -1
  246. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes.rb +1 -1
  247. data/lib/klaviyo-api-sdk/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes.rb +1 -1
  248. data/lib/klaviyo-api-sdk/models/coupon_code_create_query.rb +1 -1
  249. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object.rb +1 -6
  250. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_attributes.rb +2 -1
  251. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships.rb +1 -6
  252. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon.rb +1 -6
  253. data/lib/klaviyo-api-sdk/models/coupon_code_create_query_resource_object_relationships_coupon_data.rb +1 -1
  254. data/lib/klaviyo-api-sdk/models/coupon_code_enum.rb +1 -1
  255. data/lib/klaviyo-api-sdk/models/coupon_code_update_query.rb +1 -1
  256. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object.rb +1 -1
  257. data/lib/klaviyo-api-sdk/models/coupon_code_update_query_resource_object_attributes.rb +3 -1
  258. data/lib/klaviyo-api-sdk/models/coupon_create_query.rb +1 -1
  259. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object.rb +1 -1
  260. data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +2 -1
  261. data/lib/klaviyo-api-sdk/models/coupon_enum.rb +1 -1
  262. data/lib/klaviyo-api-sdk/models/coupon_update_query.rb +1 -1
  263. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object.rb +1 -1
  264. data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +2 -1
  265. data/lib/klaviyo-api-sdk/models/custom_timeframe.rb +238 -0
  266. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +1 -1
  267. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +1 -1
  268. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes.rb +1 -1
  269. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile.rb +1 -1
  270. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +1 -1
  271. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object.rb +2 -1
  272. data/lib/klaviyo-api-sdk/models/data_privacy_profile_query_resource_object_attributes.rb +3 -1
  273. data/lib/klaviyo-api-sdk/models/device_metadata.rb +13 -1
  274. data/lib/klaviyo-api-sdk/models/email_content_sub_object.rb +8 -1
  275. data/lib/klaviyo-api-sdk/models/email_send_options_sub_object.rb +2 -1
  276. data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +1 -1
  277. data/lib/klaviyo-api-sdk/models/email_tracking_options_sub_object.rb +5 -1
  278. data/lib/klaviyo-api-sdk/models/event_bulk_create_enum.rb +36 -0
  279. data/lib/klaviyo-api-sdk/models/event_bulk_create_job_enum.rb +36 -0
  280. data/lib/klaviyo-api-sdk/models/event_create_query_v2.rb +1 -1
  281. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object.rb +1 -1
  282. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +17 -3
  283. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_metric.rb +1 -1
  284. data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes_profile.rb +2 -2
  285. data/lib/klaviyo-api-sdk/models/event_enum.rb +1 -1
  286. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +249 -0
  287. data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +348 -0
  288. data/lib/klaviyo-api-sdk/models/events_bulk_create_job.rb +224 -0
  289. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object.rb +238 -0
  290. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes.rb +224 -0
  291. data/lib/klaviyo-api-sdk/models/events_bulk_create_job_resource_object_attributes_events_bulk_create.rb +226 -0
  292. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object.rb +238 -0
  293. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +238 -0
  294. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_events.rb +226 -0
  295. data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes_profile.rb +224 -0
  296. data/lib/klaviyo-api-sdk/models/flow_enum.rb +1 -1
  297. data/lib/klaviyo-api-sdk/models/flow_series_report_enum.rb +36 -0
  298. data/lib/klaviyo-api-sdk/models/flow_series_request_dto.rb +224 -0
  299. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object.rb +238 -0
  300. data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +316 -0
  301. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +1 -1
  302. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +1 -1
  303. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object_attributes.rb +1 -1
  304. data/lib/klaviyo-api-sdk/models/flow_values_report_enum.rb +36 -0
  305. data/lib/klaviyo-api-sdk/models/flow_values_request_dto.rb +224 -0
  306. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object.rb +238 -0
  307. data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +289 -0
  308. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response.rb +1 -1
  309. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner.rb +1 -1
  310. data/lib/klaviyo-api-sdk/models/get_accounts4_xx_response_errors_inner_source.rb +1 -1
  311. data/lib/klaviyo-api-sdk/models/image_create_query.rb +1 -1
  312. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object.rb +1 -1
  313. data/lib/klaviyo-api-sdk/models/image_create_query_resource_object_attributes.rb +3 -1
  314. data/lib/klaviyo-api-sdk/models/image_enum.rb +1 -1
  315. data/lib/klaviyo-api-sdk/models/image_partial_update_query.rb +1 -1
  316. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object.rb +1 -1
  317. data/lib/klaviyo-api-sdk/models/image_partial_update_query_resource_object_attributes.rb +3 -1
  318. data/lib/klaviyo-api-sdk/models/list_create_query.rb +1 -1
  319. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object.rb +1 -1
  320. data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +1 -1
  321. data/lib/klaviyo-api-sdk/models/list_enum.rb +1 -1
  322. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  323. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  324. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  325. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +1 -1
  326. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
  327. data/lib/klaviyo-api-sdk/models/marketing_subscription_parameters.rb +16 -5
  328. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +1 -1
  329. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +1 -1
  330. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object.rb +1 -1
  331. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +6 -1
  332. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object.rb +1 -1
  333. data/lib/klaviyo-api-sdk/models/metric_create_query_resource_object_attributes.rb +2 -1
  334. data/lib/klaviyo-api-sdk/models/metric_enum.rb +1 -1
  335. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +2 -1
  336. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +12 -1
  337. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +1 -1
  338. data/lib/klaviyo-api-sdk/models/profile_bulk_import_job_enum.rb +1 -1
  339. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +1 -1
  340. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +1 -1
  341. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object_attributes.rb +10 -1
  342. data/lib/klaviyo-api-sdk/models/profile_enum.rb +1 -1
  343. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object.rb +2 -1
  344. data/lib/klaviyo-api-sdk/models/profile_identifier_dto_resource_object_attributes.rb +5 -1
  345. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query.rb +1 -1
  346. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object.rb +1 -1
  347. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes.rb +1 -1
  348. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_attributes_profiles.rb +1 -1
  349. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships.rb +1 -1
  350. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists.rb +1 -6
  351. data/lib/klaviyo-api-sdk/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner.rb +1 -1
  352. data/lib/klaviyo-api-sdk/models/profile_location.rb +11 -1
  353. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  354. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  355. data/lib/klaviyo-api-sdk/models/profile_merge_enum.rb +1 -1
  356. data/lib/klaviyo-api-sdk/models/profile_merge_query.rb +1 -1
  357. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object.rb +1 -6
  358. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships.rb +1 -6
  359. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles.rb +1 -6
  360. data/lib/klaviyo-api-sdk/models/profile_merge_query_resource_object_relationships_profiles_data_inner.rb +1 -1
  361. data/lib/klaviyo-api-sdk/models/profile_meta.rb +1 -1
  362. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties.rb +4 -1
  363. data/lib/klaviyo-api-sdk/models/profile_meta_patch_properties_unset.rb +1 -1
  364. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +1 -1
  365. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
  366. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object_attributes.rb +11 -1
  367. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +1 -1
  368. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_delete_job_enum.rb +1 -1
  369. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object.rb +2 -1
  370. data/lib/klaviyo-api-sdk/models/profile_subscription_create_query_resource_object_attributes.rb +19 -6
  371. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object.rb +1 -1
  372. data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +4 -2
  373. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +1 -1
  374. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_delete_job_enum.rb +1 -1
  375. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object.rb +1 -1
  376. data/lib/klaviyo-api-sdk/models/profile_suppression_create_query_resource_object_attributes.rb +6 -1
  377. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object.rb +1 -1
  378. data/lib/klaviyo-api-sdk/models/profile_suppression_delete_query_resource_object_attributes.rb +6 -1
  379. data/lib/klaviyo-api-sdk/models/profile_upsert_query.rb +224 -0
  380. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object.rb +15 -5
  381. data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +16 -14
  382. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +249 -0
  383. data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +349 -0
  384. data/lib/klaviyo-api-sdk/models/push_token_create_query.rb +1 -1
  385. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object.rb +1 -1
  386. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes.rb +3 -1
  387. data/lib/klaviyo-api-sdk/models/push_token_create_query_resource_object_attributes_profile.rb +2 -2
  388. data/lib/klaviyo-api-sdk/models/push_token_enum.rb +1 -1
  389. data/lib/klaviyo-api-sdk/models/render_options_sub_object.rb +5 -1
  390. data/lib/klaviyo-api-sdk/models/segment_enum.rb +1 -1
  391. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +1 -1
  392. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +1 -1
  393. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object_attributes.rb +16 -10
  394. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +1 -1
  395. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query.rb +1 -1
  396. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object.rb +1 -6
  397. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes.rb +2 -1
  398. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_attributes_profile.rb +1 -1
  399. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships.rb +1 -6
  400. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant.rb +1 -6
  401. data/lib/klaviyo-api-sdk/models/server_bis_subscription_create_query_resource_object_relationships_variant_data.rb +1 -1
  402. data/lib/klaviyo-api-sdk/models/sms_content_sub_object_create.rb +2 -1
  403. data/lib/klaviyo-api-sdk/models/sms_send_options_sub_object.rb +2 -1
  404. data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +1 -1
  405. data/lib/klaviyo-api-sdk/models/sms_tracking_options_sub_object.rb +3 -1
  406. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +3 -1
  407. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  408. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +1 -1
  409. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +1 -1
  410. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +1 -1
  411. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes.rb +2 -1
  412. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  413. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships.rb +1 -1
  414. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list.rb +1 -6
  415. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object_relationships_list_data.rb +1 -1
  416. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query.rb +1 -1
  417. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object.rb +1 -1
  418. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes.rb +1 -1
  419. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  420. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships.rb +1 -1
  421. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list.rb +1 -6
  422. data/lib/klaviyo-api-sdk/models/subscription_delete_job_create_query_resource_object_relationships_list_data.rb +1 -1
  423. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +1 -1
  424. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +14 -5
  425. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes.rb +2 -6
  426. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_attributes_profiles.rb +1 -1
  427. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships.rb +228 -0
  428. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list.rb +219 -0
  429. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_list_data.rb +239 -0
  430. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment.rb +219 -0
  431. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object_relationships_segment_data.rb +239 -0
  432. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query.rb +1 -1
  433. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object.rb +14 -5
  434. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes.rb +2 -6
  435. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_attributes_profiles.rb +1 -1
  436. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships.rb +228 -0
  437. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list.rb +219 -0
  438. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_list_data.rb +239 -0
  439. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment.rb +219 -0
  440. data/lib/klaviyo-api-sdk/models/suppression_delete_job_create_query_resource_object_relationships_segment_data.rb +239 -0
  441. data/lib/klaviyo-api-sdk/models/tag_campaign_op.rb +1 -1
  442. data/lib/klaviyo-api-sdk/models/tag_campaign_op_data_inner.rb +1 -1
  443. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +1 -1
  444. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object.rb +1 -1
  445. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_attributes.rb +1 -1
  446. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships.rb +1 -1
  447. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group.rb +1 -6
  448. data/lib/klaviyo-api-sdk/models/tag_create_query_resource_object_relationships_tag_group_data.rb +1 -1
  449. data/lib/klaviyo-api-sdk/models/tag_enum.rb +1 -1
  450. data/lib/klaviyo-api-sdk/models/tag_flow_op.rb +1 -1
  451. data/lib/klaviyo-api-sdk/models/tag_flow_op_data_inner.rb +1 -1
  452. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +1 -1
  453. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +1 -1
  454. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object_attributes.rb +2 -1
  455. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +1 -1
  456. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +1 -1
  457. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +1 -1
  458. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object_attributes.rb +2 -1
  459. data/lib/klaviyo-api-sdk/models/tag_list_op.rb +1 -1
  460. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +1 -1
  461. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  462. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  463. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +1 -1
  464. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +1 -1
  465. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +1 -1
  466. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +1 -1
  467. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object_attributes.rb +2 -1
  468. data/lib/klaviyo-api-sdk/models/template_create_query.rb +1 -1
  469. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +1 -1
  470. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +3 -1
  471. data/lib/klaviyo-api-sdk/models/template_enum.rb +1 -1
  472. data/lib/klaviyo-api-sdk/models/template_render_query.rb +1 -1
  473. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +1 -1
  474. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object_attributes.rb +1 -1
  475. data/lib/klaviyo-api-sdk/models/template_update_query.rb +1 -1
  476. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +1 -1
  477. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object_attributes.rb +4 -1
  478. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +1 -1
  479. data/lib/klaviyo-api-sdk/models/timeframe.rb +259 -0
  480. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  481. data/lib/klaviyo-api-sdk/version.rb +1 -1
  482. data/lib/klaviyo-api-sdk.rb +44 -1
  483. data/spec/api/accounts_api_spec.rb +3 -3
  484. data/spec/api/campaigns_api_spec.rb +26 -26
  485. data/spec/api/catalogs_api_spec.rb +93 -93
  486. data/spec/api/coupons_api_spec.rb +24 -24
  487. data/spec/api/data_privacy_api_spec.rb +1 -1
  488. data/spec/api/events_api_spec.rb +26 -14
  489. data/spec/api/flows_api_spec.rb +36 -36
  490. data/spec/api/images_api_spec.rb +6 -6
  491. data/spec/api/lists_api_spec.rb +19 -19
  492. data/spec/api/metrics_api_spec.rb +5 -5
  493. data/spec/api/profiles_api_spec.rb +45 -33
  494. data/spec/api/reporting_api_spec.rb +74 -0
  495. data/spec/api/segments_api_spec.rb +19 -19
  496. data/spec/api/tags_api_spec.rb +17 -17
  497. data/spec/api/templates_api_spec.rb +7 -7
  498. data/spec/api_client_spec.rb +1 -1
  499. data/spec/configuration_spec.rb +1 -1
  500. data/spec/models/audiences_sub_object_spec.rb +1 -1
  501. data/spec/models/back_in_stock_subscription_enum_spec.rb +1 -1
  502. data/spec/models/base_event_create_query_resource_object_attributes_spec.rb +64 -0
  503. data/spec/models/base_event_create_query_resource_object_spec.rb +40 -0
  504. data/spec/models/campaign_clone_query_resource_object_attributes_spec.rb +1 -1
  505. data/spec/models/campaign_clone_query_resource_object_spec.rb +1 -1
  506. data/spec/models/campaign_clone_query_spec.rb +1 -1
  507. data/spec/models/campaign_create_query_resource_object_attributes_campaign_messages_spec.rb +1 -1
  508. data/spec/models/campaign_create_query_resource_object_attributes_send_options_spec.rb +1 -1
  509. data/spec/models/campaign_create_query_resource_object_attributes_spec.rb +1 -1
  510. data/spec/models/campaign_create_query_resource_object_attributes_tracking_options_spec.rb +1 -1
  511. data/spec/models/campaign_create_query_resource_object_spec.rb +1 -1
  512. data/spec/models/campaign_create_query_spec.rb +1 -1
  513. data/spec/models/campaign_enum_spec.rb +1 -1
  514. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_spec.rb +1 -1
  515. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_data_spec.rb +1 -1
  516. data/spec/models/campaign_message_assign_template_query_resource_object_relationships_template_spec.rb +1 -1
  517. data/spec/models/campaign_message_assign_template_query_resource_object_spec.rb +1 -1
  518. data/spec/models/campaign_message_assign_template_query_spec.rb +1 -1
  519. data/spec/models/campaign_message_create_query_resource_object_attributes_content_spec.rb +1 -1
  520. data/spec/models/campaign_message_create_query_resource_object_attributes_spec.rb +1 -1
  521. data/spec/models/campaign_message_create_query_resource_object_spec.rb +1 -1
  522. data/spec/models/campaign_message_enum_spec.rb +1 -1
  523. data/spec/models/campaign_message_partial_update_query_resource_object_attributes_spec.rb +1 -1
  524. data/spec/models/campaign_message_partial_update_query_resource_object_spec.rb +1 -1
  525. data/spec/models/campaign_message_partial_update_query_spec.rb +1 -1
  526. data/spec/models/campaign_partial_update_query_resource_object_attributes_spec.rb +1 -1
  527. data/spec/models/campaign_partial_update_query_resource_object_spec.rb +1 -1
  528. data/spec/models/campaign_partial_update_query_spec.rb +1 -1
  529. data/spec/models/campaign_recipient_estimation_job_create_query_resource_object_spec.rb +1 -1
  530. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +1 -1
  531. data/spec/models/campaign_recipient_estimation_job_enum_spec.rb +1 -1
  532. data/spec/models/campaign_send_job_create_query_resource_object_spec.rb +1 -1
  533. data/spec/models/campaign_send_job_create_query_spec.rb +1 -1
  534. data/spec/models/campaign_send_job_enum_spec.rb +1 -1
  535. data/spec/models/campaign_send_job_partial_update_query_resource_object_attributes_spec.rb +1 -1
  536. data/spec/models/campaign_send_job_partial_update_query_resource_object_spec.rb +1 -1
  537. data/spec/models/campaign_send_job_partial_update_query_spec.rb +1 -1
  538. data/spec/models/campaign_values_report_enum_spec.rb +28 -0
  539. data/spec/models/campaign_values_request_dto_resource_object_attributes_spec.rb +56 -0
  540. data/spec/models/campaign_values_request_dto_resource_object_attributes_timeframe_spec.rb +31 -0
  541. data/spec/models/campaign_values_request_dto_resource_object_spec.rb +40 -0
  542. data/spec/models/campaign_values_request_dto_spec.rb +34 -0
  543. data/spec/models/catalog_category_bulk_create_job_enum_spec.rb +1 -1
  544. data/spec/models/catalog_category_bulk_delete_job_enum_spec.rb +1 -1
  545. data/spec/models/catalog_category_bulk_update_job_enum_spec.rb +1 -1
  546. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  547. data/spec/models/catalog_category_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  548. data/spec/models/catalog_category_create_job_create_query_resource_object_spec.rb +1 -1
  549. data/spec/models/catalog_category_create_job_create_query_spec.rb +1 -1
  550. data/spec/models/catalog_category_create_query_resource_object_attributes_spec.rb +1 -1
  551. data/spec/models/catalog_category_create_query_resource_object_relationships_items_data_inner_spec.rb +1 -1
  552. data/spec/models/catalog_category_create_query_resource_object_relationships_items_spec.rb +1 -1
  553. data/spec/models/catalog_category_create_query_resource_object_relationships_spec.rb +1 -1
  554. data/spec/models/catalog_category_create_query_resource_object_spec.rb +1 -1
  555. data/spec/models/catalog_category_create_query_spec.rb +1 -1
  556. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  557. data/spec/models/catalog_category_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  558. data/spec/models/catalog_category_delete_job_create_query_resource_object_spec.rb +1 -1
  559. data/spec/models/catalog_category_delete_job_create_query_spec.rb +1 -1
  560. data/spec/models/catalog_category_delete_query_resource_object_spec.rb +1 -1
  561. data/spec/models/catalog_category_enum_spec.rb +1 -1
  562. data/spec/models/catalog_category_item_op_spec.rb +1 -1
  563. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_categories_spec.rb +1 -1
  564. data/spec/models/catalog_category_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  565. data/spec/models/catalog_category_update_job_create_query_resource_object_spec.rb +1 -1
  566. data/spec/models/catalog_category_update_job_create_query_spec.rb +1 -1
  567. data/spec/models/catalog_category_update_query_resource_object_attributes_spec.rb +1 -1
  568. data/spec/models/catalog_category_update_query_resource_object_spec.rb +1 -1
  569. data/spec/models/catalog_category_update_query_spec.rb +1 -1
  570. data/spec/models/catalog_item_bulk_create_job_enum_spec.rb +1 -1
  571. data/spec/models/catalog_item_bulk_delete_job_enum_spec.rb +1 -1
  572. data/spec/models/catalog_item_bulk_update_job_enum_spec.rb +1 -1
  573. data/spec/models/catalog_item_category_op_spec.rb +1 -1
  574. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  575. data/spec/models/catalog_item_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  576. data/spec/models/catalog_item_create_job_create_query_resource_object_spec.rb +1 -1
  577. data/spec/models/catalog_item_create_job_create_query_spec.rb +1 -1
  578. data/spec/models/catalog_item_create_query_resource_object_attributes_spec.rb +1 -1
  579. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_data_inner_spec.rb +1 -1
  580. data/spec/models/catalog_item_create_query_resource_object_relationships_categories_spec.rb +1 -1
  581. data/spec/models/catalog_item_create_query_resource_object_relationships_spec.rb +1 -1
  582. data/spec/models/catalog_item_create_query_resource_object_spec.rb +1 -1
  583. data/spec/models/catalog_item_create_query_spec.rb +1 -1
  584. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  585. data/spec/models/catalog_item_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  586. data/spec/models/catalog_item_delete_job_create_query_resource_object_spec.rb +1 -1
  587. data/spec/models/catalog_item_delete_job_create_query_spec.rb +1 -1
  588. data/spec/models/catalog_item_delete_query_resource_object_spec.rb +1 -1
  589. data/spec/models/catalog_item_enum_spec.rb +1 -1
  590. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_items_spec.rb +1 -1
  591. data/spec/models/catalog_item_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  592. data/spec/models/catalog_item_update_job_create_query_resource_object_spec.rb +1 -1
  593. data/spec/models/catalog_item_update_job_create_query_spec.rb +1 -1
  594. data/spec/models/catalog_item_update_query_resource_object_attributes_spec.rb +1 -1
  595. data/spec/models/catalog_item_update_query_resource_object_spec.rb +1 -1
  596. data/spec/models/catalog_item_update_query_spec.rb +1 -1
  597. data/spec/models/catalog_variant_bulk_create_job_enum_spec.rb +1 -1
  598. data/spec/models/catalog_variant_bulk_delete_job_enum_spec.rb +1 -1
  599. data/spec/models/catalog_variant_bulk_update_job_enum_spec.rb +1 -1
  600. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  601. data/spec/models/catalog_variant_create_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  602. data/spec/models/catalog_variant_create_job_create_query_resource_object_spec.rb +1 -1
  603. data/spec/models/catalog_variant_create_job_create_query_spec.rb +1 -1
  604. data/spec/models/catalog_variant_create_query_resource_object_attributes_spec.rb +1 -1
  605. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_data_spec.rb +1 -1
  606. data/spec/models/catalog_variant_create_query_resource_object_relationships_item_spec.rb +1 -1
  607. data/spec/models/catalog_variant_create_query_resource_object_relationships_spec.rb +1 -1
  608. data/spec/models/catalog_variant_create_query_resource_object_spec.rb +1 -1
  609. data/spec/models/catalog_variant_create_query_spec.rb +1 -1
  610. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  611. data/spec/models/catalog_variant_delete_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  612. data/spec/models/catalog_variant_delete_job_create_query_resource_object_spec.rb +1 -1
  613. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +1 -1
  614. data/spec/models/catalog_variant_delete_query_resource_object_spec.rb +1 -1
  615. data/spec/models/catalog_variant_enum_spec.rb +1 -1
  616. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_spec.rb +1 -1
  617. data/spec/models/catalog_variant_update_job_create_query_resource_object_attributes_variants_spec.rb +1 -1
  618. data/spec/models/catalog_variant_update_job_create_query_resource_object_spec.rb +1 -1
  619. data/spec/models/catalog_variant_update_job_create_query_spec.rb +1 -1
  620. data/spec/models/catalog_variant_update_query_resource_object_attributes_spec.rb +1 -1
  621. data/spec/models/catalog_variant_update_query_resource_object_spec.rb +1 -1
  622. data/spec/models/catalog_variant_update_query_spec.rb +1 -1
  623. data/spec/models/coupon_code_bulk_create_job_enum_spec.rb +1 -1
  624. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_coupon_codes_spec.rb +1 -1
  625. data/spec/models/coupon_code_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  626. data/spec/models/coupon_code_create_job_create_query_resource_object_spec.rb +1 -1
  627. data/spec/models/coupon_code_create_job_create_query_spec.rb +1 -1
  628. data/spec/models/coupon_code_create_query_resource_object_attributes_spec.rb +1 -1
  629. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_data_spec.rb +1 -1
  630. data/spec/models/coupon_code_create_query_resource_object_relationships_coupon_spec.rb +1 -1
  631. data/spec/models/coupon_code_create_query_resource_object_relationships_spec.rb +1 -1
  632. data/spec/models/coupon_code_create_query_resource_object_spec.rb +1 -1
  633. data/spec/models/coupon_code_create_query_spec.rb +1 -1
  634. data/spec/models/coupon_code_enum_spec.rb +1 -1
  635. data/spec/models/coupon_code_update_query_resource_object_attributes_spec.rb +1 -1
  636. data/spec/models/coupon_code_update_query_resource_object_spec.rb +1 -1
  637. data/spec/models/coupon_code_update_query_spec.rb +1 -1
  638. data/spec/models/coupon_create_query_resource_object_attributes_spec.rb +1 -1
  639. data/spec/models/coupon_create_query_resource_object_spec.rb +1 -1
  640. data/spec/models/coupon_create_query_spec.rb +1 -1
  641. data/spec/models/coupon_enum_spec.rb +1 -1
  642. data/spec/models/coupon_update_query_resource_object_attributes_spec.rb +1 -1
  643. data/spec/models/coupon_update_query_resource_object_spec.rb +1 -1
  644. data/spec/models/coupon_update_query_spec.rb +1 -1
  645. data/spec/models/custom_timeframe_spec.rb +40 -0
  646. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_profile_spec.rb +1 -1
  647. data/spec/models/data_privacy_create_deletion_job_query_resource_object_attributes_spec.rb +1 -1
  648. data/spec/models/data_privacy_create_deletion_job_query_resource_object_spec.rb +1 -1
  649. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +1 -1
  650. data/spec/models/data_privacy_deletion_job_enum_spec.rb +1 -1
  651. data/spec/models/data_privacy_profile_query_resource_object_attributes_spec.rb +1 -1
  652. data/spec/models/data_privacy_profile_query_resource_object_spec.rb +1 -1
  653. data/spec/models/device_metadata_spec.rb +1 -1
  654. data/spec/models/email_content_sub_object_spec.rb +1 -1
  655. data/spec/models/email_send_options_sub_object_spec.rb +1 -1
  656. data/spec/models/email_subscription_parameters_spec.rb +1 -1
  657. data/spec/models/email_tracking_options_sub_object_spec.rb +1 -1
  658. data/spec/models/event_bulk_create_enum_spec.rb +28 -0
  659. data/spec/models/event_bulk_create_job_enum_spec.rb +28 -0
  660. data/spec/models/event_create_query_v2_resource_object_attributes_metric_spec.rb +1 -1
  661. data/spec/models/event_create_query_v2_resource_object_attributes_profile_spec.rb +1 -1
  662. data/spec/models/event_create_query_v2_resource_object_attributes_spec.rb +7 -1
  663. data/spec/models/event_create_query_v2_resource_object_spec.rb +1 -1
  664. data/spec/models/event_create_query_v2_spec.rb +1 -1
  665. data/spec/models/event_enum_spec.rb +1 -1
  666. data/spec/models/event_profile_create_query_resource_object_attributes_spec.rb +106 -0
  667. data/spec/models/event_profile_create_query_resource_object_spec.rb +46 -0
  668. data/spec/models/events_bulk_create_job_resource_object_attributes_events_bulk_create_spec.rb +34 -0
  669. data/spec/models/events_bulk_create_job_resource_object_attributes_spec.rb +34 -0
  670. data/spec/models/events_bulk_create_job_resource_object_spec.rb +40 -0
  671. data/spec/models/events_bulk_create_job_spec.rb +34 -0
  672. data/spec/models/events_bulk_create_query_resource_object_attributes_events_spec.rb +34 -0
  673. data/spec/models/events_bulk_create_query_resource_object_attributes_profile_spec.rb +34 -0
  674. data/spec/models/events_bulk_create_query_resource_object_attributes_spec.rb +40 -0
  675. data/spec/models/events_bulk_create_query_resource_object_spec.rb +40 -0
  676. data/spec/models/flow_enum_spec.rb +1 -1
  677. data/spec/models/flow_series_report_enum_spec.rb +28 -0
  678. data/spec/models/flow_series_request_dto_resource_object_attributes_spec.rb +66 -0
  679. data/spec/models/flow_series_request_dto_resource_object_spec.rb +40 -0
  680. data/spec/models/flow_series_request_dto_spec.rb +34 -0
  681. data/spec/models/flow_update_query_resource_object_attributes_spec.rb +1 -1
  682. data/spec/models/flow_update_query_resource_object_spec.rb +1 -1
  683. data/spec/models/flow_update_query_spec.rb +1 -1
  684. data/spec/models/flow_values_report_enum_spec.rb +28 -0
  685. data/spec/models/flow_values_request_dto_resource_object_attributes_spec.rb +56 -0
  686. data/spec/models/flow_values_request_dto_resource_object_spec.rb +40 -0
  687. data/spec/models/flow_values_request_dto_spec.rb +34 -0
  688. data/spec/models/get_accounts4_xx_response_errors_inner_source_spec.rb +1 -1
  689. data/spec/models/get_accounts4_xx_response_errors_inner_spec.rb +1 -1
  690. data/spec/models/get_accounts4_xx_response_spec.rb +1 -1
  691. data/spec/models/image_create_query_resource_object_attributes_spec.rb +1 -1
  692. data/spec/models/image_create_query_resource_object_spec.rb +1 -1
  693. data/spec/models/image_create_query_spec.rb +1 -1
  694. data/spec/models/image_enum_spec.rb +1 -1
  695. data/spec/models/image_partial_update_query_resource_object_attributes_spec.rb +1 -1
  696. data/spec/models/image_partial_update_query_resource_object_spec.rb +1 -1
  697. data/spec/models/image_partial_update_query_spec.rb +1 -1
  698. data/spec/models/list_create_query_resource_object_attributes_spec.rb +1 -1
  699. data/spec/models/list_create_query_resource_object_spec.rb +1 -1
  700. data/spec/models/list_create_query_spec.rb +1 -1
  701. data/spec/models/list_enum_spec.rb +1 -1
  702. data/spec/models/list_members_add_query_data_inner_spec.rb +1 -1
  703. data/spec/models/list_members_add_query_spec.rb +1 -1
  704. data/spec/models/list_members_delete_query_spec.rb +1 -1
  705. data/spec/models/list_partial_update_query_resource_object_spec.rb +1 -1
  706. data/spec/models/list_partial_update_query_spec.rb +1 -1
  707. data/spec/models/marketing_subscription_parameters_spec.rb +7 -1
  708. data/spec/models/metric_aggregate_enum_spec.rb +1 -1
  709. data/spec/models/metric_aggregate_query_resource_object_attributes_spec.rb +1 -1
  710. data/spec/models/metric_aggregate_query_resource_object_spec.rb +1 -1
  711. data/spec/models/metric_aggregate_query_spec.rb +1 -1
  712. data/spec/models/metric_create_query_resource_object_attributes_spec.rb +1 -1
  713. data/spec/models/metric_create_query_resource_object_spec.rb +1 -1
  714. data/spec/models/metric_enum_spec.rb +1 -1
  715. data/spec/models/onsite_profile_create_query_resource_object_attributes_spec.rb +1 -1
  716. data/spec/models/onsite_profile_create_query_resource_object_spec.rb +1 -1
  717. data/spec/models/onsite_profile_meta_spec.rb +1 -1
  718. data/spec/models/profile_bulk_import_job_enum_spec.rb +1 -1
  719. data/spec/models/profile_create_query_resource_object_attributes_spec.rb +1 -1
  720. data/spec/models/profile_create_query_resource_object_spec.rb +1 -1
  721. data/spec/models/profile_create_query_spec.rb +1 -1
  722. data/spec/models/profile_enum_spec.rb +1 -1
  723. data/spec/models/profile_identifier_dto_resource_object_attributes_spec.rb +1 -1
  724. data/spec/models/profile_identifier_dto_resource_object_spec.rb +1 -1
  725. data/spec/models/profile_import_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  726. data/spec/models/profile_import_job_create_query_resource_object_attributes_spec.rb +1 -1
  727. data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_data_inner_spec.rb +1 -1
  728. data/spec/models/profile_import_job_create_query_resource_object_relationships_lists_spec.rb +1 -1
  729. data/spec/models/profile_import_job_create_query_resource_object_relationships_spec.rb +1 -1
  730. data/spec/models/profile_import_job_create_query_resource_object_spec.rb +1 -1
  731. data/spec/models/profile_import_job_create_query_spec.rb +1 -1
  732. data/spec/models/profile_location_latitude_spec.rb +1 -1
  733. data/spec/models/profile_location_longitude_spec.rb +1 -1
  734. data/spec/models/profile_location_spec.rb +1 -1
  735. data/spec/models/profile_merge_enum_spec.rb +1 -1
  736. data/spec/models/profile_merge_query_resource_object_relationships_profiles_data_inner_spec.rb +1 -1
  737. data/spec/models/profile_merge_query_resource_object_relationships_profiles_spec.rb +1 -1
  738. data/spec/models/profile_merge_query_resource_object_relationships_spec.rb +1 -1
  739. data/spec/models/profile_merge_query_resource_object_spec.rb +1 -1
  740. data/spec/models/profile_merge_query_spec.rb +1 -1
  741. data/spec/models/profile_meta_patch_properties_spec.rb +1 -1
  742. data/spec/models/profile_meta_patch_properties_unset_spec.rb +1 -1
  743. data/spec/models/profile_meta_spec.rb +1 -1
  744. data/spec/models/profile_partial_update_query_resource_object_attributes_spec.rb +1 -1
  745. data/spec/models/profile_partial_update_query_resource_object_spec.rb +1 -1
  746. data/spec/models/profile_partial_update_query_spec.rb +1 -1
  747. data/spec/models/profile_subscription_bulk_create_job_enum_spec.rb +1 -1
  748. data/spec/models/profile_subscription_bulk_delete_job_enum_spec.rb +1 -1
  749. data/spec/models/profile_subscription_create_query_resource_object_attributes_spec.rb +7 -1
  750. data/spec/models/profile_subscription_create_query_resource_object_spec.rb +1 -1
  751. data/spec/models/profile_subscription_delete_query_resource_object_attributes_spec.rb +1 -1
  752. data/spec/models/profile_subscription_delete_query_resource_object_spec.rb +1 -1
  753. data/spec/models/profile_suppression_bulk_create_job_enum_spec.rb +1 -1
  754. data/spec/models/profile_suppression_bulk_delete_job_enum_spec.rb +1 -1
  755. data/spec/models/profile_suppression_create_query_resource_object_attributes_spec.rb +1 -1
  756. data/spec/models/profile_suppression_create_query_resource_object_spec.rb +1 -1
  757. data/spec/models/profile_suppression_delete_query_resource_object_attributes_spec.rb +1 -1
  758. data/spec/models/profile_suppression_delete_query_resource_object_spec.rb +1 -1
  759. data/spec/models/profile_upsert_query_resource_object_attributes_spec.rb +1 -7
  760. data/spec/models/profile_upsert_query_resource_object_spec.rb +7 -1
  761. data/spec/models/profile_upsert_query_spec.rb +34 -0
  762. data/spec/models/push_profile_upsert_query_resource_object_attributes_spec.rb +106 -0
  763. data/spec/models/push_profile_upsert_query_resource_object_spec.rb +46 -0
  764. data/spec/models/push_token_create_query_resource_object_attributes_profile_spec.rb +1 -1
  765. data/spec/models/push_token_create_query_resource_object_attributes_spec.rb +1 -1
  766. data/spec/models/push_token_create_query_resource_object_spec.rb +1 -1
  767. data/spec/models/push_token_create_query_spec.rb +1 -1
  768. data/spec/models/push_token_enum_spec.rb +1 -1
  769. data/spec/models/render_options_sub_object_spec.rb +1 -1
  770. data/spec/models/segment_enum_spec.rb +1 -1
  771. data/spec/models/segment_partial_update_query_resource_object_attributes_spec.rb +7 -1
  772. data/spec/models/segment_partial_update_query_resource_object_spec.rb +1 -1
  773. data/spec/models/segment_partial_update_query_spec.rb +1 -1
  774. data/spec/models/send_strategy_sub_object_spec.rb +1 -1
  775. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_profile_spec.rb +1 -1
  776. data/spec/models/server_bis_subscription_create_query_resource_object_attributes_spec.rb +1 -1
  777. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_spec.rb +1 -1
  778. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_data_spec.rb +1 -1
  779. data/spec/models/server_bis_subscription_create_query_resource_object_relationships_variant_spec.rb +1 -1
  780. data/spec/models/server_bis_subscription_create_query_resource_object_spec.rb +1 -1
  781. data/spec/models/server_bis_subscription_create_query_spec.rb +1 -1
  782. data/spec/models/sms_content_sub_object_create_spec.rb +1 -1
  783. data/spec/models/sms_send_options_sub_object_spec.rb +1 -1
  784. data/spec/models/sms_subscription_parameters_spec.rb +1 -1
  785. data/spec/models/sms_tracking_options_sub_object_spec.rb +1 -1
  786. data/spec/models/static_schedule_options_spec.rb +1 -1
  787. data/spec/models/sto_schedule_options_spec.rb +1 -1
  788. data/spec/models/subscription_channels_spec.rb +1 -1
  789. data/spec/models/subscription_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  790. data/spec/models/subscription_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  791. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
  792. data/spec/models/subscription_create_job_create_query_resource_object_relationships_list_spec.rb +1 -1
  793. data/spec/models/subscription_create_job_create_query_resource_object_relationships_spec.rb +1 -1
  794. data/spec/models/subscription_create_job_create_query_resource_object_spec.rb +1 -1
  795. data/spec/models/subscription_create_job_create_query_spec.rb +1 -1
  796. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  797. data/spec/models/subscription_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  798. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_data_spec.rb +1 -1
  799. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_list_spec.rb +1 -1
  800. data/spec/models/subscription_delete_job_create_query_resource_object_relationships_spec.rb +1 -1
  801. data/spec/models/subscription_delete_job_create_query_resource_object_spec.rb +1 -1
  802. data/spec/models/subscription_delete_job_create_query_spec.rb +1 -1
  803. data/spec/models/suppression_create_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  804. data/spec/models/suppression_create_job_create_query_resource_object_attributes_spec.rb +1 -1
  805. data/spec/models/suppression_create_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
  806. data/spec/models/suppression_create_job_create_query_resource_object_relationships_list_spec.rb +34 -0
  807. data/spec/models/suppression_create_job_create_query_resource_object_relationships_segment_data_spec.rb +40 -0
  808. data/spec/models/suppression_create_job_create_query_resource_object_relationships_segment_spec.rb +34 -0
  809. data/spec/models/suppression_create_job_create_query_resource_object_relationships_spec.rb +40 -0
  810. data/spec/models/suppression_create_job_create_query_resource_object_spec.rb +7 -1
  811. data/spec/models/suppression_create_job_create_query_spec.rb +1 -1
  812. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_profiles_spec.rb +1 -1
  813. data/spec/models/suppression_delete_job_create_query_resource_object_attributes_spec.rb +1 -1
  814. data/spec/models/suppression_delete_job_create_query_resource_object_relationships_list_data_spec.rb +40 -0
  815. data/spec/models/suppression_delete_job_create_query_resource_object_relationships_list_spec.rb +34 -0
  816. data/spec/models/suppression_delete_job_create_query_resource_object_relationships_segment_data_spec.rb +40 -0
  817. data/spec/models/suppression_delete_job_create_query_resource_object_relationships_segment_spec.rb +34 -0
  818. data/spec/models/suppression_delete_job_create_query_resource_object_relationships_spec.rb +40 -0
  819. data/spec/models/suppression_delete_job_create_query_resource_object_spec.rb +7 -1
  820. data/spec/models/suppression_delete_job_create_query_spec.rb +1 -1
  821. data/spec/models/tag_campaign_op_data_inner_spec.rb +1 -1
  822. data/spec/models/tag_campaign_op_spec.rb +1 -1
  823. data/spec/models/tag_create_query_resource_object_attributes_spec.rb +1 -1
  824. data/spec/models/tag_create_query_resource_object_relationships_spec.rb +1 -1
  825. data/spec/models/tag_create_query_resource_object_relationships_tag_group_data_spec.rb +1 -1
  826. data/spec/models/tag_create_query_resource_object_relationships_tag_group_spec.rb +1 -1
  827. data/spec/models/tag_create_query_resource_object_spec.rb +1 -1
  828. data/spec/models/tag_create_query_spec.rb +1 -1
  829. data/spec/models/tag_enum_spec.rb +1 -1
  830. data/spec/models/tag_flow_op_data_inner_spec.rb +1 -1
  831. data/spec/models/tag_flow_op_spec.rb +1 -1
  832. data/spec/models/tag_group_create_query_resource_object_attributes_spec.rb +1 -1
  833. data/spec/models/tag_group_create_query_resource_object_spec.rb +1 -1
  834. data/spec/models/tag_group_create_query_spec.rb +1 -1
  835. data/spec/models/tag_group_enum_spec.rb +1 -1
  836. data/spec/models/tag_group_update_query_resource_object_attributes_spec.rb +1 -1
  837. data/spec/models/tag_group_update_query_resource_object_spec.rb +1 -1
  838. data/spec/models/tag_group_update_query_spec.rb +1 -1
  839. data/spec/models/tag_list_op_data_inner_spec.rb +1 -1
  840. data/spec/models/tag_list_op_spec.rb +1 -1
  841. data/spec/models/tag_segment_op_data_inner_spec.rb +1 -1
  842. data/spec/models/tag_segment_op_spec.rb +1 -1
  843. data/spec/models/tag_update_query_resource_object_spec.rb +1 -1
  844. data/spec/models/tag_update_query_spec.rb +1 -1
  845. data/spec/models/template_clone_query_resource_object_attributes_spec.rb +1 -1
  846. data/spec/models/template_clone_query_resource_object_spec.rb +1 -1
  847. data/spec/models/template_clone_query_spec.rb +1 -1
  848. data/spec/models/template_create_query_resource_object_attributes_spec.rb +1 -1
  849. data/spec/models/template_create_query_resource_object_spec.rb +1 -1
  850. data/spec/models/template_create_query_spec.rb +1 -1
  851. data/spec/models/template_enum_spec.rb +1 -1
  852. data/spec/models/template_render_query_resource_object_attributes_spec.rb +1 -1
  853. data/spec/models/template_render_query_resource_object_spec.rb +1 -1
  854. data/spec/models/template_render_query_spec.rb +1 -1
  855. data/spec/models/template_update_query_resource_object_attributes_spec.rb +1 -1
  856. data/spec/models/template_update_query_resource_object_spec.rb +1 -1
  857. data/spec/models/template_update_query_spec.rb +1 -1
  858. data/spec/models/throttled_schedule_options_spec.rb +1 -1
  859. data/spec/models/timeframe_spec.rb +38 -0
  860. data/spec/models/utm_params_sub_object_spec.rb +1 -1
  861. data/spec/spec_helper.rb +1 -1
  862. metadata +131 -2
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
5
5
 
6
- The version of the OpenAPI document: 2023-12-15
6
+ The version of the OpenAPI document: 2024-05-15
7
7
  Contact: developers@klaviyo.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.2.1
@@ -19,8 +19,78 @@ module KlaviyoAPI
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Create or Update Profile
23
+ # Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
24
+ # @param profile_upsert_query [ProfileUpsertQuery]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [Hash<String, Object>]
27
+ def create_or_update_profile(profile_upsert_query, opts = {})
28
+ data, _status_code, _headers = create_or_update_profile_with_http_info(profile_upsert_query, opts)
29
+ data
30
+ end
31
+
32
+ # Create or Update Profile
33
+ # Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was created, 200 if an existing profile was updated.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60;
34
+ # @param profile_upsert_query [ProfileUpsertQuery]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
37
+ def create_or_update_profile_with_http_info(profile_upsert_query, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: ProfilesApi.create_or_update_profile ...'
40
+ end
41
+ # verify the required parameter 'profile_upsert_query' is set
42
+ if @api_client.config.client_side_validation && profile_upsert_query.nil?
43
+ fail ArgumentError, "Missing the required parameter 'profile_upsert_query' when calling ProfilesApi.create_or_update_profile"
44
+ end
45
+ # resource path
46
+ local_var_path = '/api/profile-import/'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # klaviyo api revision
54
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
+ # HTTP header 'Content-Type'
58
+ content_type = @api_client.select_header_content_type(['application/json'])
59
+ if !content_type.nil?
60
+ header_params['Content-Type'] = content_type
61
+ end
62
+
63
+ # form parameters
64
+ form_params = opts[:form_params] || {}
65
+
66
+ # http body (model)
67
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_upsert_query)
68
+
69
+ # return_type
70
+ return_type = opts[:debug_return_type] || 'Hash<String, Object>'
71
+
72
+ # auth_names
73
+ auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key']
74
+
75
+ new_options = opts.merge(
76
+ :operation => :"ProfilesApi.create_or_update_profile",
77
+ :header_params => header_params,
78
+ :query_params => query_params,
79
+ :form_params => form_params,
80
+ :body => post_body,
81
+ :auth_names => auth_names,
82
+ :return_type => return_type
83
+ )
84
+
85
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "API called: ProfilesApi#create_or_update_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+
22
92
  # Create Profile
23
- # Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
93
+ # Create a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
24
94
  # @param profile_create_query [ProfileCreateQuery]
25
95
  # @param [Hash] opts the optional parameters
26
96
  # @return [Hash<String, Object>]
@@ -30,7 +100,7 @@ module KlaviyoAPI
30
100
  end
31
101
 
32
102
  # Create Profile
33
- # Create a new profile. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you&#39;ll need to include at least one other identifier attribute (&#x60;email&#x60; or &#x60;external_id&#x60;) in addition to the &#x60;phone_number&#x60; attribute for the API call to work.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60;
103
+ # Create a new profile.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60;
34
104
  # @param profile_create_query [ProfileCreateQuery]
35
105
  # @param [Hash] opts the optional parameters
36
106
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -51,7 +121,7 @@ module KlaviyoAPI
51
121
  # header parameters
52
122
  header_params = opts[:header_params] || {}
53
123
  # klaviyo api revision
54
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
124
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
55
125
  # HTTP header 'Accept' (if needed)
56
126
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
127
  # HTTP header 'Content-Type'
@@ -121,7 +191,7 @@ module KlaviyoAPI
121
191
  # header parameters
122
192
  header_params = opts[:header_params] || {}
123
193
  # klaviyo api revision
124
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
194
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
125
195
  # HTTP header 'Accept' (if needed)
126
196
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
127
197
  # HTTP header 'Content-Type'
@@ -163,9 +233,9 @@ module KlaviyoAPI
163
233
  # Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
164
234
  # @param job_id [String] ID of the job to retrieve.
165
235
  # @param [Hash] opts the optional parameters
166
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
167
- # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
168
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
236
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
237
+ # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
238
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
169
239
  # @return [Hash<String, Object>]
170
240
  def get_bulk_profile_import_job(job_id, opts = {})
171
241
  data, _status_code, _headers = get_bulk_profile_import_job_with_http_info(job_id, opts)
@@ -176,9 +246,9 @@ module KlaviyoAPI
176
246
  # Get a bulk profile import job with the given job ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;lists:read&#x60; &#x60;profiles:read&#x60;
177
247
  # @param job_id [String] ID of the job to retrieve.
178
248
  # @param [Hash] opts the optional parameters
179
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
180
- # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
181
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
249
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
250
+ # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
251
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
182
252
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
183
253
  def get_bulk_profile_import_job_with_http_info(job_id, opts = {})
184
254
  if @api_client.config.debugging
@@ -188,7 +258,7 @@ module KlaviyoAPI
188
258
  if @api_client.config.client_side_validation && job_id.nil?
189
259
  fail ArgumentError, "Missing the required parameter 'job_id' when calling ProfilesApi.get_bulk_profile_import_job"
190
260
  end
191
- allowable_values = ["name", "created", "updated"]
261
+ allowable_values = ["name", "created", "updated", "opt_in_process"]
192
262
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
193
263
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
194
264
  end
@@ -212,7 +282,7 @@ module KlaviyoAPI
212
282
  # header parameters
213
283
  header_params = opts[:header_params] || {}
214
284
  # klaviyo api revision
215
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
285
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
216
286
  # HTTP header 'Accept' (if needed)
217
287
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
218
288
 
@@ -245,12 +315,12 @@ module KlaviyoAPI
245
315
  return data, status_code, headers
246
316
  end
247
317
 
248
- # Get Bulk Profile Import Job Import Errors
318
+ # Get Bulk Profile Import Job Errors
249
319
  # Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
250
320
  # @param id [String]
251
321
  # @param [Hash] opts the optional parameters
252
- # @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
253
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
322
+ # @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
323
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
254
324
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
255
325
  # @return [Hash<String, Object>]
256
326
  def get_bulk_profile_import_job_import_errors(id, opts = {})
@@ -258,12 +328,12 @@ module KlaviyoAPI
258
328
  data
259
329
  end
260
330
 
261
- # Get Bulk Profile Import Job Import Errors
331
+ # Get Bulk Profile Import Job Errors
262
332
  # Get import errors for the bulk profile import job with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;profiles:read&#x60;
263
333
  # @param id [String]
264
334
  # @param [Hash] opts the optional parameters
265
- # @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
266
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
335
+ # @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
336
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
267
337
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
268
338
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
269
339
  def get_bulk_profile_import_job_import_errors_with_http_info(id, opts = {})
@@ -298,7 +368,7 @@ module KlaviyoAPI
298
368
  # header parameters
299
369
  header_params = opts[:header_params] || {}
300
370
  # klaviyo api revision
301
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
371
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
302
372
  # HTTP header 'Accept' (if needed)
303
373
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
304
374
 
@@ -335,7 +405,7 @@ module KlaviyoAPI
335
405
  # Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
336
406
  # @param id [String]
337
407
  # @param [Hash] opts the optional parameters
338
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
408
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
339
409
  # @return [Hash<String, Object>]
340
410
  def get_bulk_profile_import_job_lists(id, opts = {})
341
411
  data, _status_code, _headers = get_bulk_profile_import_job_lists_with_http_info(id, opts)
@@ -346,7 +416,7 @@ module KlaviyoAPI
346
416
  # Get list for the bulk profile import job with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;lists:read&#x60;
347
417
  # @param id [String]
348
418
  # @param [Hash] opts the optional parameters
349
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
419
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
350
420
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
351
421
  def get_bulk_profile_import_job_lists_with_http_info(id, opts = {})
352
422
  if @api_client.config.debugging
@@ -356,7 +426,7 @@ module KlaviyoAPI
356
426
  if @api_client.config.client_side_validation && id.nil?
357
427
  fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_bulk_profile_import_job_lists"
358
428
  end
359
- allowable_values = ["name", "created", "updated"]
429
+ allowable_values = ["name", "created", "updated", "opt_in_process"]
360
430
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
361
431
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
362
432
  end
@@ -370,7 +440,7 @@ module KlaviyoAPI
370
440
  # header parameters
371
441
  header_params = opts[:header_params] || {}
372
442
  # klaviyo api revision
373
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
443
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
374
444
  # HTTP header 'Accept' (if needed)
375
445
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
376
446
 
@@ -408,8 +478,8 @@ module KlaviyoAPI
408
478
  # @param id [String]
409
479
  # @param [Hash] opts the optional parameters
410
480
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
411
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
412
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
481
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
482
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
413
483
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
414
484
  # @return [Hash<String, Object>]
415
485
  def get_bulk_profile_import_job_profiles(id, opts = {})
@@ -422,8 +492,8 @@ module KlaviyoAPI
422
492
  # @param id [String]
423
493
  # @param [Hash] opts the optional parameters
424
494
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
425
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
426
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
495
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
496
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
427
497
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
428
498
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
429
499
  def get_bulk_profile_import_job_profiles_with_http_info(id, opts = {})
@@ -463,7 +533,7 @@ module KlaviyoAPI
463
533
  # header parameters
464
534
  header_params = opts[:header_params] || {}
465
535
  # klaviyo api revision
466
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
536
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
467
537
  # HTTP header 'Accept' (if needed)
468
538
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
469
539
 
@@ -528,7 +598,7 @@ module KlaviyoAPI
528
598
  # header parameters
529
599
  header_params = opts[:header_params] || {}
530
600
  # klaviyo api revision
531
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
601
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
532
602
  # HTTP header 'Accept' (if needed)
533
603
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
534
604
 
@@ -565,7 +635,7 @@ module KlaviyoAPI
565
635
  # Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
566
636
  # @param id [String]
567
637
  # @param [Hash] opts the optional parameters
568
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
638
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
569
639
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
570
640
  # @return [Hash<String, Object>]
571
641
  def get_bulk_profile_import_job_relationships_profiles(id, opts = {})
@@ -577,7 +647,7 @@ module KlaviyoAPI
577
647
  # Get profile relationships for the bulk profile import job with the given ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;profiles:read&#x60;
578
648
  # @param id [String]
579
649
  # @param [Hash] opts the optional parameters
580
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
650
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
581
651
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
582
652
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
583
653
  def get_bulk_profile_import_job_relationships_profiles_with_http_info(id, opts = {})
@@ -607,7 +677,7 @@ module KlaviyoAPI
607
677
  # header parameters
608
678
  header_params = opts[:header_params] || {}
609
679
  # klaviyo api revision
610
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
680
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
611
681
  # HTTP header 'Accept' (if needed)
612
682
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
613
683
 
@@ -643,11 +713,11 @@ module KlaviyoAPI
643
713
  # Get Bulk Profile Import Jobs
644
714
  # Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
645
715
  # @param [Hash] opts the optional parameters
646
- # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
647
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
648
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
716
+ # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
717
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
718
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
649
719
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
650
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
720
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
651
721
  # @return [Hash<String, Object>]
652
722
  def get_bulk_profile_import_jobs(opts = {})
653
723
  data, _status_code, _headers = get_bulk_profile_import_jobs_with_http_info(opts)
@@ -657,11 +727,11 @@ module KlaviyoAPI
657
727
  # Get Bulk Profile Import Jobs
658
728
  # Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;lists:read&#x60; &#x60;profiles:read&#x60;
659
729
  # @param [Hash] opts the optional parameters
660
- # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
661
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
662
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
730
+ # @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
731
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;status&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;
732
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
663
733
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
664
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
734
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
665
735
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
666
736
  def get_bulk_profile_import_jobs_with_http_info(opts = {})
667
737
  if @api_client.config.debugging
@@ -697,7 +767,7 @@ module KlaviyoAPI
697
767
  # header parameters
698
768
  header_params = opts[:header_params] || {}
699
769
  # klaviyo api revision
700
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
770
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
701
771
  # HTTP header 'Accept' (if needed)
702
772
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
703
773
 
@@ -735,10 +805,10 @@ module KlaviyoAPI
735
805
  # @param id [String]
736
806
  # @param [Hash] opts the optional parameters
737
807
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
738
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
739
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
740
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
741
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
808
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
809
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
810
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
811
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
742
812
  # @return [Hash<String, Object>]
743
813
  def get_profile(id, opts = {})
744
814
  data, _status_code, _headers = get_profile_with_http_info(id, opts)
@@ -750,10 +820,10 @@ module KlaviyoAPI
750
820
  # @param id [String]
751
821
  # @param [Hash] opts the optional parameters
752
822
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
753
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
754
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
755
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
756
- # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships
823
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
824
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
825
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
826
+ # @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#relationships
757
827
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
758
828
  def get_profile_with_http_info(id, opts = {})
759
829
  if @api_client.config.debugging
@@ -767,7 +837,7 @@ module KlaviyoAPI
767
837
  if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
768
838
  fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
769
839
  end
770
- allowable_values = ["name", "created", "updated"]
840
+ allowable_values = ["name", "created", "updated", "opt_in_process"]
771
841
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
772
842
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
773
843
  end
@@ -775,7 +845,7 @@ module KlaviyoAPI
775
845
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
776
846
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
777
847
  end
778
- allowable_values = ["name", "created", "updated"]
848
+ allowable_values = ["name", "created", "updated", "is_active", "is_processing", "is_starred"]
779
849
  if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
780
850
  fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
781
851
  end
@@ -797,7 +867,7 @@ module KlaviyoAPI
797
867
  # header parameters
798
868
  header_params = opts[:header_params] || {}
799
869
  # klaviyo api revision
800
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
870
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
801
871
  # HTTP header 'Accept' (if needed)
802
872
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
803
873
 
@@ -834,7 +904,7 @@ module KlaviyoAPI
834
904
  # Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
835
905
  # @param id [String]
836
906
  # @param [Hash] opts the optional parameters
837
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
907
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
838
908
  # @return [Hash<String, Object>]
839
909
  def get_profile_lists(id, opts = {})
840
910
  data, _status_code, _headers = get_profile_lists_with_http_info(id, opts)
@@ -845,7 +915,7 @@ module KlaviyoAPI
845
915
  # Get list memberships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;lists:read&#x60; &#x60;profiles:read&#x60;
846
916
  # @param id [String]
847
917
  # @param [Hash] opts the optional parameters
848
- # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
918
+ # @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
849
919
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
850
920
  def get_profile_lists_with_http_info(id, opts = {})
851
921
  if @api_client.config.debugging
@@ -855,7 +925,7 @@ module KlaviyoAPI
855
925
  if @api_client.config.client_side_validation && id.nil?
856
926
  fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_lists"
857
927
  end
858
- allowable_values = ["name", "created", "updated"]
928
+ allowable_values = ["name", "created", "updated", "opt_in_process"]
859
929
  if @api_client.config.client_side_validation && opts[:'fields_list'] && !opts[:'fields_list'].all? { |item| allowable_values.include?(item) }
860
930
  fail ArgumentError, "invalid value for \"fields_list\", must include one of #{allowable_values}"
861
931
  end
@@ -869,7 +939,7 @@ module KlaviyoAPI
869
939
  # header parameters
870
940
  header_params = opts[:header_params] || {}
871
941
  # klaviyo api revision
872
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
942
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
873
943
  # HTTP header 'Accept' (if needed)
874
944
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
875
945
 
@@ -934,7 +1004,7 @@ module KlaviyoAPI
934
1004
  # header parameters
935
1005
  header_params = opts[:header_params] || {}
936
1006
  # klaviyo api revision
937
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1007
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
938
1008
  # HTTP header 'Accept' (if needed)
939
1009
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
940
1010
 
@@ -999,7 +1069,7 @@ module KlaviyoAPI
999
1069
  # header parameters
1000
1070
  header_params = opts[:header_params] || {}
1001
1071
  # klaviyo api revision
1002
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1072
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1003
1073
  # HTTP header 'Accept' (if needed)
1004
1074
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1005
1075
 
@@ -1036,7 +1106,7 @@ module KlaviyoAPI
1036
1106
  # Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
1037
1107
  # @param id [String]
1038
1108
  # @param [Hash] opts the optional parameters
1039
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1109
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
1040
1110
  # @return [Hash<String, Object>]
1041
1111
  def get_profile_segments(id, opts = {})
1042
1112
  data, _status_code, _headers = get_profile_segments_with_http_info(id, opts)
@@ -1047,7 +1117,7 @@ module KlaviyoAPI
1047
1117
  # Get segment memberships for a profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;profiles:read&#x60; &#x60;segments:read&#x60;
1048
1118
  # @param id [String]
1049
1119
  # @param [Hash] opts the optional parameters
1050
- # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1120
+ # @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
1051
1121
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1052
1122
  def get_profile_segments_with_http_info(id, opts = {})
1053
1123
  if @api_client.config.debugging
@@ -1057,7 +1127,7 @@ module KlaviyoAPI
1057
1127
  if @api_client.config.client_side_validation && id.nil?
1058
1128
  fail ArgumentError, "Missing the required parameter 'id' when calling ProfilesApi.get_profile_segments"
1059
1129
  end
1060
- allowable_values = ["name", "created", "updated"]
1130
+ allowable_values = ["name", "created", "updated", "is_active", "is_processing", "is_starred"]
1061
1131
  if @api_client.config.client_side_validation && opts[:'fields_segment'] && !opts[:'fields_segment'].all? { |item| allowable_values.include?(item) }
1062
1132
  fail ArgumentError, "invalid value for \"fields_segment\", must include one of #{allowable_values}"
1063
1133
  end
@@ -1071,7 +1141,7 @@ module KlaviyoAPI
1071
1141
  # header parameters
1072
1142
  header_params = opts[:header_params] || {}
1073
1143
  # klaviyo api revision
1074
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1144
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1075
1145
  # HTTP header 'Accept' (if needed)
1076
1146
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1077
1147
 
@@ -1105,14 +1175,14 @@ module KlaviyoAPI
1105
1175
  end
1106
1176
 
1107
1177
  # Get Profiles
1108
- # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
1178
+ # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-05-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
1109
1179
  # @param [Hash] opts the optional parameters
1110
1180
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
1111
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1112
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.list_id&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;
1113
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
1181
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
1182
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.list_id&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;
1183
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
1114
1184
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1115
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
1185
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
1116
1186
  # @return [Hash<String, Object>]
1117
1187
  def get_profiles(opts = {})
1118
1188
  data, _status_code, _headers = get_profiles_with_http_info(opts)
@@ -1120,14 +1190,14 @@ module KlaviyoAPI
1120
1190
  end
1121
1191
 
1122
1192
  # Get Profiles
1123
- # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: &#x60;id&#x60;, &#x60;created&#x60;, &#x60;updated&#x60;, &#x60;email&#x60;, &#x60;subscriptions.email.marketing.suppression.timestamp&#x60;, &#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[profile]&#x3D;predictive_analytics&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2023-12-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;profiles:read&#x60;
1193
+ # Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: &#x60;id&#x60;, &#x60;created&#x60;, &#x60;updated&#x60;, &#x60;email&#x60;, &#x60;subscriptions.email.marketing.suppression.timestamp&#x60;, &#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;&lt;br&gt;&lt;br&gt;Rate limits when using the &#x60;additional-fields[profile]&#x3D;predictive_analytics&#x60; parameter in your API request:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60;&lt;br&gt;&lt;br&gt;To learn more about how the &#x60;additional-fields&#x60; parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2024-05-15/docs/rate_limits_and_error_handling) guide. **Scopes:** &#x60;profiles:read&#x60;
1124
1194
  # @param [Hash] opts the optional parameters
1125
1195
  # @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: &#39;subscriptions&#39;, &#39;predictive_analytics&#39;
1126
- # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
1127
- # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.list_id&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;
1128
- # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination
1196
+ # @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sparse-fieldsets
1197
+ # @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;external_id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.suppression.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.list_id&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.reason&#x60; : &#x60;equals&#x60;&lt;br&gt;&#x60;subscriptions.email.marketing.list_suppressions.timestamp&#x60; : &#x60;greater-than&#x60;, &#x60;greater-or-equal&#x60;, &#x60;less-than&#x60;, &#x60;less-or-equal&#x60;
1198
+ # @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination
1129
1199
  # @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
1130
- # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting
1200
+ # @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#sorting
1131
1201
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
1132
1202
  def get_profiles_with_http_info(opts = {})
1133
1203
  if @api_client.config.debugging
@@ -1168,7 +1238,7 @@ module KlaviyoAPI
1168
1238
  # header parameters
1169
1239
  header_params = opts[:header_params] || {}
1170
1240
  # klaviyo api revision
1171
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1241
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1172
1242
  # HTTP header 'Accept' (if needed)
1173
1243
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1174
1244
 
@@ -1233,7 +1303,7 @@ module KlaviyoAPI
1233
1303
  # header parameters
1234
1304
  header_params = opts[:header_params] || {}
1235
1305
  # klaviyo api revision
1236
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1306
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1237
1307
  # HTTP header 'Accept' (if needed)
1238
1308
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1239
1309
  # HTTP header 'Content-Type'
@@ -1272,7 +1342,7 @@ module KlaviyoAPI
1272
1342
  end
1273
1343
 
1274
1344
  # Spawn Bulk Profile Import Job
1275
- # *Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
1345
+ # Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write` `profiles:write`
1276
1346
  # @param profile_import_job_create_query [ProfileImportJobCreateQuery]
1277
1347
  # @param [Hash] opts the optional parameters
1278
1348
  # @return [Hash<String, Object>]
@@ -1282,7 +1352,7 @@ module KlaviyoAPI
1282
1352
  end
1283
1353
 
1284
1354
  # Spawn Bulk Profile Import Job
1285
- # *Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;lists:write&#x60; &#x60;profiles:write&#x60;
1355
+ # Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. To learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;10/s&#x60;&lt;br&gt;Steady: &#x60;150/m&#x60; **Scopes:** &#x60;lists:write&#x60; &#x60;profiles:write&#x60;
1286
1356
  # @param profile_import_job_create_query [ProfileImportJobCreateQuery]
1287
1357
  # @param [Hash] opts the optional parameters
1288
1358
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -1303,7 +1373,7 @@ module KlaviyoAPI
1303
1373
  # header parameters
1304
1374
  header_params = opts[:header_params] || {}
1305
1375
  # klaviyo api revision
1306
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1376
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1307
1377
  # HTTP header 'Accept' (if needed)
1308
1378
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1309
1379
  # HTTP header 'Content-Type'
@@ -1342,7 +1412,7 @@ module KlaviyoAPI
1342
1412
  end
1343
1413
 
1344
1414
  # Subscribe Profiles
1345
- # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
1415
+ # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
1346
1416
  # @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
1347
1417
  # @param [Hash] opts the optional parameters
1348
1418
  # @return [nil]
@@ -1352,7 +1422,7 @@ module KlaviyoAPI
1352
1422
  end
1353
1423
 
1354
1424
  # Subscribe Profiles
1355
- # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any &#x60;UNSUBSCRIBE&#x60;, &#x60;SPAM_REPORT&#x60; or &#x60;USER_SUPPRESSED&#x60; suppressions from the provided profiles. Learn more about suppressed profiles in [this document](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;lists:write&#x60; &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
1425
+ # Subscribe one or more profiles to email marketing, SMS marketing, or both. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). If a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys). To add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships). This API will remove any &#x60;UNSUBSCRIBE&#x60;, &#x60;SPAM_REPORT&#x60; or &#x60;USER_SUPPRESSED&#x60; suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Maximum number of profiles can be submitted for subscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;lists:write&#x60; &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
1356
1426
  # @param subscription_create_job_create_query [SubscriptionCreateJobCreateQuery] Subscribes one or more profiles to marketing. Currently, supports email and SMS only. All profiles will be added to the provided list. Either email or phone number is required. Both may be specified to subscribe to both channels. If a profile cannot be found matching the given identifier(s), a new profile will be created and then subscribed.
1357
1427
  # @param [Hash] opts the optional parameters
1358
1428
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -1373,7 +1443,7 @@ module KlaviyoAPI
1373
1443
  # header parameters
1374
1444
  header_params = opts[:header_params] || {}
1375
1445
  # klaviyo api revision
1376
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1446
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1377
1447
  # HTTP header 'Accept' (if needed)
1378
1448
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1379
1449
  # HTTP header 'Content-Type'
@@ -1412,7 +1482,7 @@ module KlaviyoAPI
1412
1482
  end
1413
1483
 
1414
1484
  # Suppress Profiles
1415
- # Manually suppress one or more profiles. Such profiles will have `USER_SUPPRESSED` as their suppression reason. Manually suppressed profiles _will not_ receive email marketing. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Learn about [collecting consent and best practices](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Not supported for SMS marketing. Maximum number of profile can be submitted for suppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
1485
+ # Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write` `subscriptions:write`
1416
1486
  # @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
1417
1487
  # @param [Hash] opts the optional parameters
1418
1488
  # @return [nil]
@@ -1422,7 +1492,7 @@ module KlaviyoAPI
1422
1492
  end
1423
1493
 
1424
1494
  # Suppress Profiles
1425
- # Manually suppress one or more profiles. Such profiles will have &#x60;USER_SUPPRESSED&#x60; as their suppression reason. Manually suppressed profiles _will not_ receive email marketing. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1). Learn about [collecting consent and best practices](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Not supported for SMS marketing. Maximum number of profile can be submitted for suppression: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
1495
+ # Manually suppress profiles using their email address, or by specifying a segment or list ID to suppress all current members. Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
1426
1496
  # @param suppression_create_job_create_query [SuppressionCreateJobCreateQuery] Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.
1427
1497
  # @param [Hash] opts the optional parameters
1428
1498
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -1443,7 +1513,7 @@ module KlaviyoAPI
1443
1513
  # header parameters
1444
1514
  header_params = opts[:header_params] || {}
1445
1515
  # klaviyo api revision
1446
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1516
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1447
1517
  # HTTP header 'Accept' (if needed)
1448
1518
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1449
1519
  # HTTP header 'Content-Type'
@@ -1482,7 +1552,7 @@ module KlaviyoAPI
1482
1552
  end
1483
1553
 
1484
1554
  # Unsubscribe Profiles
1485
- # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
1555
+ # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `lists:write` `profiles:write` `subscriptions:write`
1486
1556
  # @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
1487
1557
  # @param [Hash] opts the optional parameters
1488
1558
  # @return [nil]
@@ -1492,7 +1562,7 @@ module KlaviyoAPI
1492
1562
  end
1493
1563
 
1494
1564
  # Unsubscribe Profiles
1495
- # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;lists:write&#x60; &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
1565
+ # Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). To remove someone from a list without changing their subscription status, use [Remove Profile from List](https://developers.klaviyo.com/en/reference/delete_list_relationships). Maximum number of profile can be submitted for unsubscription: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;lists:write&#x60; &#x60;profiles:write&#x60; &#x60;subscriptions:write&#x60;
1496
1566
  # @param subscription_delete_job_create_query [SubscriptionDeleteJobCreateQuery] Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.
1497
1567
  # @param [Hash] opts the optional parameters
1498
1568
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -1513,7 +1583,7 @@ module KlaviyoAPI
1513
1583
  # header parameters
1514
1584
  header_params = opts[:header_params] || {}
1515
1585
  # klaviyo api revision
1516
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1586
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1517
1587
  # HTTP header 'Accept' (if needed)
1518
1588
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1519
1589
  # HTTP header 'Content-Type'
@@ -1552,7 +1622,7 @@ module KlaviyoAPI
1552
1622
  end
1553
1623
 
1554
1624
  # Unsuppress Profiles
1555
- # Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api), i.e. unsubscribed. Not supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. `UNSUBSCRIBE` and `SPAM_REPORT` suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). `INVALID_EMAIL` and `HARD_BOUNCE` suppressions cannot be removed by the API. Maximum number of profile can be submitted for unsuppression: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
1625
+ # Manually unsuppress profiles using their email address, or by specifying a segment or list ID to unsuppress all current members. This only removes suppressions with reason `USER_SUPPRESSED`, leaving unsubscribed profiles and profiles suppressed with reason `INVALID_EMAIL` or `HARD_BOUNCE` unchanged. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:write`
1556
1626
  # @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
1557
1627
  # @param [Hash] opts the optional parameters
1558
1628
  # @return [nil]
@@ -1562,7 +1632,7 @@ module KlaviyoAPI
1562
1632
  end
1563
1633
 
1564
1634
  # Unsuppress Profiles
1565
- # Unsuppress one or more profiles, this will remove any Manual Suppressions (USER_SUPPRESSED) on these profiles. A profile may receive email marketing after a manual suppression is removed so long as they have not revoked [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api), i.e. unsubscribed. Not supported for SMS marketing. Only manual suppressions (USER_SUPPRESSED) will be removed. &#x60;UNSUBSCRIBE&#x60; and &#x60;SPAM_REPORT&#x60; suppressions are removed whenever a [profile resubscribes](https://developers.klaviyo.com/en/reference/subscribe_profiles). &#x60;INVALID_EMAIL&#x60; and &#x60;HARD_BOUNCE&#x60; suppressions cannot be removed by the API. Maximum number of profile can be submitted for unsuppression: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;subscriptions:write&#x60;
1635
+ # Manually unsuppress profiles using their email address, or by specifying a segment or list ID to unsuppress all current members. This only removes suppressions with reason &#x60;USER_SUPPRESSED&#x60;, leaving unsubscribed profiles and profiles suppressed with reason &#x60;INVALID_EMAIL&#x60; or &#x60;HARD_BOUNCE&#x60; unchanged. To learn more, see our [email suppressions guide](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1) and our [collecting consent guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api). Email addresses per request limit: 100&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;subscriptions:write&#x60;
1566
1636
  # @param suppression_delete_job_create_query [SuppressionDeleteJobCreateQuery] Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, no action will be taken.
1567
1637
  # @param [Hash] opts the optional parameters
1568
1638
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -1583,7 +1653,7 @@ module KlaviyoAPI
1583
1653
  # header parameters
1584
1654
  header_params = opts[:header_params] || {}
1585
1655
  # klaviyo api revision
1586
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1656
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1587
1657
  # HTTP header 'Accept' (if needed)
1588
1658
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1589
1659
  # HTTP header 'Content-Type'
@@ -1622,7 +1692,7 @@ module KlaviyoAPI
1622
1692
  end
1623
1693
 
1624
1694
  # Update Profile
1625
- # Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you'll need to include at least one other identifier attribute (`email` or `external_id`) in addition to the `phone_number` attribute for the API call to work.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
1695
+ # Update the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
1626
1696
  # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
1627
1697
  # @param profile_partial_update_query [ProfilePartialUpdateQuery]
1628
1698
  # @param [Hash] opts the optional parameters
@@ -1633,7 +1703,7 @@ module KlaviyoAPI
1633
1703
  end
1634
1704
 
1635
1705
  # Update Profile
1636
- # Update the profile with the given profile ID. If you use a phone number as the profile identifier and SMS is not set up in the Klaviyo account, you&#39;ll need to include at least one other identifier attribute (&#x60;email&#x60; or &#x60;external_id&#x60;) in addition to the &#x60;phone_number&#x60; attribute for the API call to work.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60;
1706
+ # Update the profile with the given profile ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; **Scopes:** &#x60;profiles:write&#x60;
1637
1707
  # @param id [String] Primary key that uniquely identifies this profile. Generated by Klaviyo.
1638
1708
  # @param profile_partial_update_query [ProfilePartialUpdateQuery]
1639
1709
  # @param [Hash] opts the optional parameters
@@ -1659,7 +1729,7 @@ module KlaviyoAPI
1659
1729
  # header parameters
1660
1730
  header_params = opts[:header_params] || {}
1661
1731
  # klaviyo api revision
1662
- header_params['revision'] = ENV['API_REVISION'] || "2023-12-15"
1732
+ header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2024-05-15"
1663
1733
  # HTTP header 'Accept' (if needed)
1664
1734
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1665
1735
  # HTTP header 'Content-Type'